Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

READMEを更新してあげたよ! #3840 #3841

Merged
merged 1 commit into from
Apr 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,11 @@
鳩botを使うには以下が必要です。

- Dockerが動作するPC
- Slack API Token ([Slack API Tokenの取得手順](./doc/01_Get_Slack_API_Token.md))
- Yahoo API Token ([Yahoo API Tokenの取得手順](./doc/02_Get_Yahoo_API_Token.md))
- Slack API Token ([Slack API Tokenの取得手順](./doc/01_Get_Slack_API_Token.md)) (Slackで動かす場合のみ)
- Discord Bot Token ([Discord Bot Tokenの取得手順](./doc/03_Get_Discord_Bot_Token)) (Discordで動かす場合のみ)
- Misskeyアクセストークン ([Misskeyアクセストークンの取得手順](./doc/04_Get_Misskey_Access_Token)) (Misskeyで動かす場合のみ)
- Yahoo API Token ([Yahoo API Tokenの取得手順](./doc/05_Get_Yahoo_API_Token))
- OpenAI API Key ([OpenAI API Keyの取得手順](./doc/06_Get_OpenAI_API_Token.md))

### 自分のPC上で動かす

Expand Down Expand Up @@ -53,18 +56,7 @@
`.env.example` をコピーして使うとよいでしょう

MODEに `discord` を指定すると、DiscordのBotとして動作します。

DISCORD_API_TOKENにDiscordのBot Tokenを指定します。

DISCORD_API_TOKENには `Read Messages/View Channels` と、 `Send Messages` の権限が必要です。

MODEに `misskey` を指定すると、自分のサーバーからのメンションに限って反応するMisskeyのBotとして動作します。

MISSKEY_URLにBotのいるMisskeyサーバーのドメインを指定します。

MISSKEY_API_TOKENにMisskeyのBotのアクセストークンを指定します。

MISSKEY_API_TOKENには `ドライブを操作する`, `ノートを作成・削除する`, `アカウントの情報を見る`, `リアクションを操作する` の権限が必要です。
MODEに `misskey` を指定すると、自分のいるサーバーからのメンションに限って反応するMisskeyのBotとして動作します。

6. docker composeで鳩botとPostgreSQLを起動します。

Expand Down