💬 sokujichan: 8dx 6v6 the score overlay for broadcast with discord bot.
これはなに / What is this?
マリオカート8DX 6v6 のスコアオーバーレイを配信ソフト上で表示するDiscord Botです。
MarioKart 8DX 6v6 the score overlay for broadcast with discord bot.
Botの一般提供は行っていません。各自でインストールを行ってください。
No provided a public bot. Please install yourself.
_sokujichan for help
動作環境
Linux/macOS/Windows
インストールに必要なもの
インストール / Installation
- Discord Developer Portal にてBotを作成します。
- Privileged Gateway Intents を ON の状態にします。
Dockerでの導入 (推奨)
このようなタグがあります
iamtakagi/sokujichan:latest
master ブランチへのプッシュの際にビルドされます。安定しています。
iamtakagi/sokujichan:dev
dev ブランチへのプッシュの際にビルドされます。開発版のため, 不安定である可能性があります。
iamtakagi/sokujichan:<tag>
GitHub 上のリリースに対応します。
touch docker-compose.yml
BOT_TOKEN
にBotのTokenを入力します。
docker-compose.yml
version: '3.8'
services:
# Bot
sokujichan:
container_name: sokujichan
image: iamtakagi/sokujichan:latest
restart: always
ports:
- 8080:8080
depends_on:
- mongo
environment:
# Bot Token (ここだけ書き換えれば動く: 入力必須)
BOT_TOKEN: xxx
# Base Uri
BASE_URI: /
# Server Host
HOST: 0.0.0.0
# Server Port (必要次第で書き換えてください)
PORT: 8080
# HOSTNAME (外部公開しない場合: null で可)
HOSTNAME:
# Logger
LOG: DEBUG
# Embed color
EMBED_COLOR: 83,221,172
# Mongo DB (基本的には書き換えない)
MONGO_HOST: mongo
MONGO_PORT: 27017
MONGO_USER: user
MONGO_PASS: pass
# DB
mongo:
image: mongo
container_name: mongo
restart: always
volumes:
- ./mongodb:/data/db
environment:
MONGO_INITDB_ROOT_USERNAME: user
MONGO_INITDB_ROOT_PASSWORD: pass
ports:
- 27017:27017
# イメージ更新 / Update
docker pull iamtakagi/sokujichan:latest
# 起動 / Start
docker-compose up -d
# 停止 / Shutdown
docker-compose down
# ログ確認 / Logs
docker-compose logs -f
直接実行 (非推奨)
リリースから Jar を取ってきて実行するか ./gradlew run
で実行できます。
設定値の変更は 環境変数経由でしか行なえません。ご了承ください。
LOG=DEBUG java -jar /path/to/sokujichan.jar
インストールはこれで終了です。
配信ソフト (OBSでの設定例)
ソース -> ブラウザ -> URLを貼り付け
※ 途中でオーバーレイが消えてしまう場合は オーバーレイを右クリック -> 対話
を表示したままにしてください
外部公開する場合
ポート開放は各自で行ってください。
セキュリティに関する問題は、一切の責任を負いかねます。
docker-compose.yml
# Server Port (必要次第で書き換えてください)
PORT: 8080
# HOSTNAME (外部公開しない場合: null で可)
HOSTNAME: ホスト名, ドメイン, IPアドレス等
開発を行う場合 / Development mode
git clone https://github.com/USERNAME/sokujichan
touch docker-compose.dev.yml
docker-compose.dev.yml
version: '3.8'
services:
# Bot
sokujichan:
build: .
restart: always
ports:
- 8080:8080
depends_on:
- mongo
environment:
# Bot Token (ここだけ書き換えれば動く: 入力必須)
BOT_TOKEN: xxx
# Base Uri
BASE_URI: /
# Server Host
HOST: 0.0.0.0
# Server Port (必要次第で書き換えてください)
PORT: 8080
# HOSTNAME (外部公開しない場合: null で可)
HOSTNAME:
# Logger
LOG: DEBUG
# Embed color
EMBED_COLOR: 83,221,172
# Mongo DB (基本的には書き換えない)
MONGO_HOST: mongo
MONGO_PORT: 27017
MONGO_USER: user
MONGO_PASS: pass
# DB
mongo:
image: mongo
container_name: mongo
restart: always
volumes:
- ./mongodb:/data/db
environment:
MONGO_INITDB_ROOT_USERNAME: user
MONGO_INITDB_ROOT_PASSWORD: pass
ports:
- 27017:27017
貢献 / Contribution
Issues
バグの報告・改善点・提案等を行ってください。
Pull Requests
開発には Intellij IDEA を使用しています。