Skip to content

Commit

Permalink
🎉 Initial Commit (Public Beta)
Browse files Browse the repository at this point in the history
  • Loading branch information
Pukimaa committed Dec 1, 2022
0 parents commit 5b6cf55
Show file tree
Hide file tree
Showing 167 changed files with 5,103 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/black.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Lint

on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Run linter
run: |
python -m pip install black
black .
#- name: Check Diff
# id: check_diff
# run: |
# git diff . || echo "::set-output name=diff::true"
- name: Commit and Push
#if: steps.check_diff.outputs.diff == 'true'
continue-on-error: true
run: |
git config user.name github-actions
git config user.email [email protected]
git add .
git commit -m "🚨 Linting"
git push
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
**/__pycache__
.gitmodules
bot_secrets.py
assets/thumbnails/*
!assets/thumbnails/.exists
discord.log
venv
7 changes: 7 additions & 0 deletions .gitmoji-changelogrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"project": {
"name": "Tako",
"description": "A multipurpose Discord bot for everything",
"version": "0.1.0-beta"
}
}
8 changes: 8 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions .idea/fileTemplates/Translation.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions .idea/fileTemplates/cog.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 36 additions & 0 deletions .vscode/cog.code-snippets
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
// Place your kayano-rewrite workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
// Placeholders with the same ids are connected.
// Example:
// "Print to console": {
// "scope": "javascript,typescript",
// "prefix": "log",
// "body": [
// "console.log('$1');",
// "$2"
// ],
// "description": "Log output to console"
// }
"Cog": {
"scope": "python",
"prefix": "cog",
"body": [
"import discord",
"from discord import app_commands",
"from discord.ext import commands",
"",
"class Cog(commands.Cog):",
" def __init__(self, bot):",
" self.bot = bot",
"",
" @app_commands.command()",
" async def example(self, interaction: discord.Interaction):",
""
],
"description": "A simple yet elegant Cog for discord.py"
}
}
37 changes: 37 additions & 0 deletions .vscode/cog_group.code-snippets
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
// Place your kayano-rewrite workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
// Placeholders with the same ids are connected.
// Example:
// "Print to console": {
// "scope": "javascript,typescript",
// "prefix": "log",
// "body": [
// "console.log('$1');",
// "$2"
// ],
// "description": "Log output to console"
// }
"Cog": {
"scope": "python",
"prefix": "cog group",
"body": [
"import discord",
"from discord import app_commands",
"from discord.ext import commands",
"",
"class Cog(commands.GroupCog, group_name=\"cog\"):",
" def __init__(self, bot):",
" self.bot = bot",
"",
" @app_commands.command()",
" async def example(self, interaction: discord.Interaction):",
" return",
""
],
"description": "A simple yet elegant Cog Group for discord.py"
}
}
6 changes: 6 additions & 0 deletions .vsls.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "http://json.schemastore.org/vsls",
"excludeFiles": [
"bot_secrets.py"
]
}
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Changelog

<a name="0.1.0-alpha"></a>
## 0.1.0-alpha (2022-07-15)

### Added

- 🎉 Initial Commit [[0fa12d5](https://github.com/tako-discord/tako/commit/0fa12d52e0af64a3a83c80b57b1e4a0d570e776e)]

### Changed

- 🚨 Linting [[71f8789](https://github.com/tako-discord/tako/commit/71f8789152f1dbed9c9b35f3900463424086fb44)]
- 🎨 Better note regarding the public bot [[2e42cec](https://github.com/tako-discord/tako/commit/2e42cecb26680fe71ce5665cfb43282eb0193b60)]

### Miscellaneous

- 🌐 New Crowdin Setup [[ea0aee9](https://github.com/tako-discord/tako/commit/ea0aee9dcd77fa8c8e607f25dfc50dc122d0fe7a)]


8 changes: 8 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
MIT License
©️ Copyright 2021-current Jaron Ain

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
End license text.
72 changes: 72 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Tako
[![Crowdin](https://badges.crowdin.net/tako/localized.svg)](https://translate.tako.rocks)

A Discord bot done right. No bullshit like pay- or votewalls.

This is the rewrite for Kayano (now Tako). Before the rewrite it was written in JavaScript/Node.js with the Discord.js Library. But now it's written in Python with the discord.py Library. We have made some very great improvements and we hope you'll like it.

> **Warning** |
> This project is still in *beta* and might be unstable and buggy
> **Note** | We strongly recommend using [the public bot](https://top.gg/bot/878366398269771847) instead of selfhosting as it's well configured and does not have any disadvantages. Selfhosting is very complicated if you want everything to work perfectly.
## 🏃‍♂️ Get Started
> Do you need help or found a bug?
> [Open an issue](https://github.com/tako-discord/tako/issues/new)!
### 📀 What you need
- [Python](https://www.python.org/) (3.10 or higher)
- [PIP](https://pip.pypa.io/)
- [PostgreSQL](https://www.postgresql.org/) (Tested: v14-15)

Be sure to install everything before heading to the next step.
### 📥 Installation
Please note that instead of `python` your command may be `python3` or similar.
1. Clone this repository
- `git clone https://github.com/kayano-bot/tako`
2. Install dependencies
- `cd tako`
- `pip install -r requirements.txt`
3. Create the database
- [postgresql.org/docs/15/tutorial-createdb.html](https://www.postgresql.org/docs/15/tutorial-createdb.html)
4. Add Secrets
- Create a `bot_secrets.py` inside the `tako` folder
- Use this as a template:
```python
TOKEN = "" # https://discord.com/developers/applications
DB_NAME = "tako" # Or however you named your database
DB_HOST = "localhost" # gonna be different if using a non-local database
DB_PORT = 5432 # Optional port of the DB (Default: 5432)
DB_USER = "postgres"
DB_PASSWORD = ""
YOUTUBE_API_KEY = "" # https://developers.google.com/youtube/v3/getting-started
TMDB_API_KEY = "" # https://www.themoviedb.org/documentation/api
```
- More info: soon™️
5. Initialize Database
- `python helper.py` (Be sure that you are still in the `tako` folder you cloned earlier)
- Choose "Init Database"
6. Start the bot
- `python helper.py` and choose "Start the bot" *OR* `python main.py`
7. Sync commands
- Inside discord run `tk!sync` (or if available: `/sync`) in a channel the bot has access to. This is to make all slash commands visible.
8. Enjoy! 😀

## 🤝 Contributing
1. Fork this repository
2. Create a new branch
3. Make your changes in that branch
4. Commit with [gitmoji](https://gitmoji.dev/) as a commit guide
5. Make a Pull Request
6. Be proud of yourself 👍

## 💖 Credits
Huge thanks to the discord.py Community, helping out if I had any question.
Another big thanks goes out to the users using this bot and all the contributors to this project.

Also huge thanks to the other (core) developer(s):
- [*LyQuid*](https://github.com/LyQuid12)

and all the testers:
- [*@cmod31*](https://github.com/cmod31)
- [*@abUwUser*](https://github.com/abUwUser)
- *Olex3#3259*
Loading

0 comments on commit 5b6cf55

Please sign in to comment.