https://github.com/penguincabinet/yominon
The OSS speaking bot for Discord.
https://github.com/penguincabinet/yominon
bot discord-bot javascript nodejs voice
Last synced: 4 months ago
JSON representation
The OSS speaking bot for Discord.
- Host: GitHub
- URL: https://github.com/penguincabinet/yominon
- Owner: PenguinCabinet
- License: mit
- Created: 2021-02-22T16:49:22.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-11-20T04:57:44.000Z (7 months ago)
- Last Synced: 2025-11-20T06:20:01.265Z (7 months ago)
- Topics: bot, discord-bot, javascript, nodejs, voice
- Language: JavaScript
- Homepage:
- Size: 41 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[English README](./README_en.md)
# よみのん
よみのんはOSSのDiscord読み上げBotです
# 特徴
* よみのんはオンプレミス環境で動作しOSSです
* よみのんはDockerを利用しているため、簡単にデプロイできます
* よみのんはクラウドサービスを利用していません
* よみのんはラズパイ上で動作することができます(ARMv6はサポートしていません)
# Quick strat
## よみのんの構築(推奨方法)
```bash
git clone https://github.com/PenguinCabinet/yominon
cd yominon
vim docker-compose-example.yml
# docker-compose-example.ymlの環境変数のBOT_KEYに開発者ページで作成したDiscord BotのKeyを入力してください
#もしくはホストOS上で"export yominon_BOT_KEY="を実行します
docker-compose -f docker-compose-example.yml up -d
```
## よみのんの構築(ほかのやりかた)
自前でビルドするため、時間がかかります
```bash
git clone https://github.com/PenguinCabinet/yominon
cd yominon
vim docker-compose.yml
# docker-compose.ymlの環境変数のBOT_KEYに開発者ページで作成したDiscord BotのKeyを入力してください
#もしくはホストOS上で"export yominon_BOT_KEY="を実行します
docker-compose up -d
```
## Botの作成
[Discordの開発者ページ](http://discord.com/developers/)にアクセスしてBotを作成したのち、よみのんに適切な権限を与えてください
```
よみのんに必要な権限
* メッセージを読む
* メッセージの履歴を読む
* ボイスチャンネルへの接続
* 発言
```
# 使い方
1. あなたがボイスチャンネルに接続します
2. よみのんが読むことのできる適切なテキストチャンネルに".join"と入力します
3. よみのんがあなたと同じボイスチャンネルに参加します
4. よみのんが読むことのできるテキストチャンネルで書き込まれたテキストを読み上げます
5. よみのんを退出させたい場合、".bye"と入力します
# よみのんに使用しているソフトウェア
```
open jtalk
mmdagent
```