discordpy-template

モチベーション

• Poetry と Docker を用いて環境を汚さずに Discord Bot を開発したい
• コマンドベース(Cog)の Discord Bot を手軽に開発したい

起動方法

1. リポジトリのコピーを作成．ページ上部のUse this template をクリック．
2. Discord Developer Portal にアクセスし，Bot を作成，トークンを取得(参照：Botアカウント作成)
3. Botをサーバーに招待する
4. ./config/discord_secret.json にトークンを書き込む
5. 下記の手順に従って起動

with docker

docker compose up

OR

docker compose up -D

without docker

poetry install
python ./src/main.py

開発者向け

開発する前にやるとよさそうなこと

pre-commit の設定

シークレットをコミットしようとしたら失敗するようにする

sudo apt install git-secrets
git secrets --add '[A-z0-9_]{24}\.[A-z0-9_]{6}\.[A-z0-9_]{27}\.'
git secrets install

記事はこちら git-secrets を活用して、Discord Bot のトークンの混入を防ぐ

git 管理下にあるファイルの更新を無視する

git update-index --assume-unchanged config/discord_secret.json

コマンドを追加する

./src/cog 配下にコマンドを生やしていく方針です．

main.py の以下の部分に追加したいファイル名を書き込みましょう．

class MyBot(Bot):
    ...
    async def setup_hook(self) -> None:
        # ここにCogを追加していく
        await self.load_extension("cog.on_ready")
        await self.load_extension("cog.test_command")

わからなければ@i4mwh4ti4mに聞いてください

公式ドキュメント

• discord.py へようこそ。