https://github.com/eai04191/discord-soup-bot

ウミガメのスープ支援bot
https://github.com/eai04191/discord-soup-bot

discord-bot lateral-thinking

Last synced: 21 days ago
JSON representation

ウミガメのスープ支援bot

• Host: GitHub
• URL: https://github.com/eai04191/discord-soup-bot
• Owner: eai04191
• License: mit
• Created: 2019-12-21T00:54:59.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T05:29:28.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T15:56:37.640Z (8 months ago)
• Topics: discord-bot, lateral-thinking
• Language: TypeScript
• Homepage:
• Size: 267 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




Soup Chef



[![CodeFactor](https://www.codefactor.io/repository/github/eai04191/discord-soup-bot/badge?style=flat-square)](https://www.codefactor.io/repository/github/eai04191/discord-soup-bot)

![preview gif](https://i.imgur.com/DY010xq.gif)

ウミガメのスープのプレイを支援する Discord bot です。

監視対象のチャンネルに「？」か「?」で終わるメッセージが投稿されると ⭕,❌,😐 のリアクションを付与します。これにより出題者は質問に対する考えを簡単に示すことができます。

付与するリアクションの種類は設定可能です。

## ランダムモード

[ウミガメのスープはランダム生成してもそれなりに遊べることがわかりました - 開け閉め](https://hikido.hatenablog.com/entry/2020/05/31/021327)

このブログ記事を元にした問題に対する回答を bot がランダムに行うモードです。

詳しくは`help`コマンドを確認してください（デフォルトでは`!soup help`）

## Self-hosted Usage

### 依存関係のインストール

```

yarn

```

### .env の準備

1. `.env.example`をコピーして`.env`を作成する

2. https://discordapp.com/developers/applications/me

   でアプリケーションを作成する

3. アプリケーションの中で bot を作成し、bot の`Token`を`.env`の`DISCORD_TOKEN`に入れる

> ⚠: `Token`は Bot ページにあります。General Information ページにある`Client Secret`ではありません。

#### env の詳細

-   `DISCORD_TOKEN`

    -   bot が使うトークン

-   `SOUP_CHANNEL_NAME`

    -   bot が監視するテキストチャンネルの名前

-   `SOUP_REACTIONS`

    -   bot が質問に対してつけるリアクションのリスト

    -   `,` 区切りで記載する

-   `SET_ACTIVITY`

    -   bot が起動時にアクティビティ（～をプレイ中）をセットするかの値

    -   セットするには `true` を記載する

    -   `true` 以外の値の場合はセットしない

-   `ACTIVITY_TEXT`

    -   アクティビティをセットする際に表示するテキスト

-   `SOUP_PREFIX`

    -   bot にコマンドを送るための接頭辞

    -   デフォルトの`!soup`なら、bot のヘルプコマンドを呼ぶには`!soup help`と投稿します

### 招待

`https://discordapp.com/oauth2/authorize?&client_id=アプリケーションのClient ID&scope=bot`

を開いて bot をサーバーに招待する

### 起動

```

yarn start

```

`Soup Chef 準備完了`とログに出れば成功です。

### 権限

Bot には監視対象のチャンネルに対して少なくとも

-   メッセージを読む

-   メッセージ履歴を読む

-   リアクションの追加

の権限が必要です。

random モードでは上記に加えて

-   メッセージを送信

-   埋め込みリンク

の権限が必要です。

## Licence

This project is licensed under the MIT License.