Skip to content

Commit

Permalink
chore(docs): フォーマット、軽微な修正
Browse files Browse the repository at this point in the history
  • Loading branch information
raiga0310 committed Sep 14, 2023
1 parent e94a1b8 commit 395eee2
Showing 1 changed file with 53 additions and 49 deletions.
102 changes: 53 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,63 +3,63 @@

## 導入の仕方

0. 事前にDocker、Docker Compose v2がインストールされている必要があります。
1. 事前にDocker、Docker Compose v2がインストールされている必要があります。

### 利用者向け(`compose.yml`のみ利用する方式)
1. トップページ右下部の[Releases](releases)をクリックし、「Assets」のドロップダウンメニューにある[compose.yml](compose.yml)をダウンロードしてください。
1. トップページ右下部の[Releases](releases)をクリックし、「Assets」のドロップダウンメニューにある[compose.yml](deployment/compose.yml)をダウンロードしてください。

2. 以下のファイルを次の形式で作成してください。
### `.env` (環境変数用)
```
PREFIX=-
```
+ `-`の部分は、すきな接頭辞を設定できます。`!`を指定した場合、コマンドは`!zunda`の用に利用できます。

### `.secret`(機密情報用)
```
TOKEN=BotEXAMPLETOKEN
```
+ Discord Developer Portalで作成したBotのトークンを`TOKEN=`につづいてコピペなどで作成してください。
+ **`.secret`は絶対に外部に公開しないでください。** これが外部に公開された場合、第三者によって悪意ある操作が行われ、犯罪に巻き込まれる可能性があります。
### `.env` (環境変数用)
```
PREFIX=-
```
+ `-`の部分は、すきな接頭辞を設定できます。`!`を指定した場合、コマンドは`!zunda`の用に利用できます。
### `.secret`(機密情報用)
```
TOKEN=BotEXAMPLETOKEN
```
+ Discord Developer Portalで作成したBotのトークンを`TOKEN=`につづいてコピペなどで作成してください。
+ **`.secret`は絶対に外部に公開しないでください。** これが外部に公開された場合、第三者によって悪意ある操作が行われ、犯罪に巻き込まれる可能性があります。

3. 以下のコマンドを実行してください ($は入力しないでください)
```bash
$ docker compose build
$ docker compose up -d
```
```bash
$ docker compose build
$ docker compose up -d
```

### 開発者向け(クローンする方式)
1. Repositoryをクローンしてください。
GitHub CLIの場合:
```bash
$ gh repo clone https://github.com/approvers/yomiage-mon
```
GitHub CLIの場合:
```bash
$ gh repo clone https://github.com/approvers/yomiage-mon
```

2. 環境変数を`.secret`, `.env`に記述してください。以下を必ず設定してください。 なお、書き方は[.secret.example](.secret.example)、[.env.example](.env.example)を参考にしてください。

### .secret

| 環境変数名 | 説明 |
|:---:|:---:|
| TOKEN | Botのトークン |

### .env

| 環境変数名 | 説明 |
|:---:|:---:|
| PREFIX | Botのコマンドの接頭辞 |

(注:`TOKEN`を記載した`.secret`を外部に公開しないでください! Gitでコミットする前にかならず`.env``.gitignore`に追加するなど予防策をとってください。)
### .secret
| 環境変数名 | 説明 |
|:-----:|:--------:|
| TOKEN | Botのトークン |
### .env
| 環境変数名 | 説明 |
|:------:|:------------:|
| PREFIX | Botのコマンドの接頭辞 |
(注:`TOKEN`を記載した`.secret`を外部に公開しないでください! Gitでコミットする前にかならず`.env``.gitignore`に追加するなど予防策をとってください。)

3. Dockerのビルドを行ってください。
```bash
$ docker compose build
``````
```bash
$ docker compose build
``````
4. Dockerの起動を行ってください。
```bash
$ docker compose up -d
```
```bash
$ docker compose up -d
```

## 使い方

Expand All @@ -72,13 +72,17 @@ Botには以下の権限が必要です。
- VCで発言(`Speak`)

Botをサーバーに追加後は、以下のコマンドが実行できます。

| コマンド | 説明 |
|:---:|:---:|
| `zunda` | ずんだもんがあなたに挨拶してくれます。 |
| `help` | ヘルプを表示します。 |
| `vc` | BotをVCに参加させます。ただしコマンドの送り主がVCに接続している必要があります。 |
| `leave` | BotをVCから退出させます。 |
設定された`PREFIX`をつけて送信してください。(例:`PREFIX``!`の場合、 `!zunda`など)

| コマンド | 説明 |
|:---------------:|:-------------------------------------------:|
| `zunda` | ずんだもんがあなたに挨拶してくれます。 |
| `help` | ヘルプを表示します。 |
| `vc` | BotをVCに参加させます。ただしコマンドの送り主がVCに接続している必要があります。 |
| `leave` | BotをVCから退出させます。 |
| `list` | Botが読み上げる対象のテキストチャンネルを表示します。 |
| `listen`, `add` | コマンドを送信したテキストチャネルをBotが読み上げる対象に追加します。 |
| `remove` | コマンドを送信したテキストチャネルをBotが読み上げる対象から削除します。 |

またVCに接続しているBot以外の利用者がいなくなった場合、BotはVCから退出します。

Expand All @@ -88,7 +92,7 @@ Botをサーバーに追加後は、以下のコマンドが実行できます
[限界開発鯖](https://approvers.dev)のメンバーはDiscordでの問い合わせも可能です。

機能要望は[GitHub Issues](https://github.com/approvers/yomiage-mon/issues)にて受け付けています。
(現在Disscussionsを整備中です。)
(現在Discussionsを整備中です。)

## ライセンス
MIT Licenseに準拠します。
Expand Down

0 comments on commit 395eee2

Please sign in to comment.