Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tamakiruri/ruri-bot

Ruri's bot for VRChat related servers
https://github.com/tamakiruri/ruri-bot

discord-bot discordjs

Last synced: about 4 hours ago
JSON representation

Ruri's bot for VRChat related servers

Awesome Lists containing this project

README

        

## Ruri Bot

**Ruri BotはVRChat関連のDiscordサーバー向けのBotです**

このBotはDiscord js v14を利用します。利用するにはgitとNode JSが必要です。

---

> **注意**: このBotはまだ完成していません。

### **機能**:

- **ランダムワールド** (./commands/json/worlds.jsonにリンクの追加が必要です。)
- **ランダム衣装** (./commands/json/costume.jsonにリンクの追加が必要です。)
- **改変チュートリアル** いまはRuriのアバターライティングFAQしかありません。
- **ボイスチャット検知**/setchannel で通知送信チャンネルを設定できます(再起動するたびに設定が必要です)
- **ランダム機能** 4つの選択肢からランダムに一つを選ぶ機能です
---

### WIP

- /setchannel の保存
- ボイスチャット検知をコマンドで無効にできるようにする

### インストール

**Node.js 16.11.0 以降が必要です**

### このBotを利用する前に、Discord Developer PortalにApplicationとBotを作る必要があります。[Discord Developer Portal](https://discord.com/developers/applications)作ったあとにtokenとClient IDを保存します(tokenは公開しないでください)。

### OAuth2 でbot、Bot PermissionsでReadMessages/ViewChannelsとSend Messagesを選択し、生成したURLでBotを管理しているサーバーにインバイトしてください。

1. Botを保存したいディレクトリに移動し、ターミナルを開きます。

```
git clone https://github.com/TamakiRuri/Ruri-Bot.git
```

2. config.jsonを作ります。

```
cp config.json.example config.json
```

3. config.jsonを編集します。

```
{
"clientId": "BotのClient ID",
"guildId": "", //すでに破棄されました。初めて使用する場合何も入力しないでください。古いバージョンを使う場合は一回動かしてから消してください。
"token": "BotのToken"
}
```

4. Botを動かします。

```
npm install
node index.js
```

5. もしLogged Inというメセージがターミナルで出たら完成です。エラーが出た場合はconfig.jsonに問題があるか見てください。Ctrl + Cを同時に押すとBotが終了します。

> 他になにか問題がある場合、Issuesに書いてくれると助かります。

### 0.2.1から更新される方へ

1. アバター機能が削除されました。
2. 一部のコマンドが変更されました。
3. コマンドの登録が Guildからグローバルになりました。一回動かしてからconfig.jsonからGuildIdを消してください。

### 0.2.2から更新される方へ

1. ボイスチャット検知機能が追加されました。
2. **Permissions**の更新が必要です。サーバーにインバイトし直してください。
3. この機能は今のところ**無効にできません**
4. 必ず/setchannelで送信するチャンネルを設定してください。