FindSenryu4Discord

FindSenryu4Discord

Discordで川柳を検出します

Invite

Commands

メッセージコマンド

詠め

今までにギルド内で詠まれた句をもとに、新しい川柳を生成します。

詠むな

理不尽な要求なので、最後に詠んだ人とその内容を晒しあげます。

スラッシュコマンド

/mute

このチャンネルでの川柳検出をミュートします。親チャンネルをミュートすると、その中のスレッドでも検出がスキップされます。

/unmute

このチャンネルでの川柳検出のミュートを解除します。

/rank

ギルド内で詠んだ回数が多い人のランキングを表示します。

/delete [user]

自分の川柳を選択して削除します。サーバー管理者は user オプションで他ユーザーの川柳も削除できます。

/detect on | off | status

自分の川柳検出のオン/オフをサーバー単位で切り替えます。status で現在の設定を確認できます。

/channel

チャンネルタイプ別の川柳検出設定を変更します（サーバー管理者のみ）。ボタン付きの設定パネルが表示され、チャンネルタイプごとに検出の有効/無効を切り替えられます。

/doctor

このチャンネルでBotが正常に動作するか診断します。権限・チャンネルタイプ・ミュート状態などをチェックし、問題があれば対処方法を表示します。

/contact

Bot管理者にお問い合わせを送信します。モーダルで件名と内容を入力でき、管理チャンネルに転送されます。contact_channel_id が設定されている場合のみ利用可能です。

管理者コマンド

管理用ギルド (admin.guild_id) でのみ使用可能です。admin.owner_ids に登録されたユーザーのみ実行できます。

/admin stats

Botの稼働状況（稼働時間・接続サーバー数・DB統計）を表示します。

/admin guilds

接続中の全サーバー一覧を表示します。

/admin backup

データベースのバックアップを手動で作成します（SQLite のみ）。

Self-hosting

設定

sample.config.toml を config.toml にコピーして編集してください。

[discord]
token = ""       # Discord Bot トークン（必須）
playing = ""     # Botのプレイ中ステータス

[database]
driver = "sqlite3"  # sqlite3 or postgres
path = "data/senryu.db"
# dsn = "host=localhost user=findsenryu dbname=findsenryu sslmode=disable"

[log]
level = "info"   # debug, info, warn, error
format = "text"  # json, text

[admin]
owner_ids = []         # Bot管理者のDiscord ID
guild_id = ""          # 管理コマンド登録先ギルドID
log_channel_id = ""    # サーバー参加/脱退通知・日次サマリー送信先
contact_channel_id = "" # /contact コマンドのお問い合わせ通知先

[server]
enabled = true   # ヘルスチェック/メトリクスサーバー
port = 9090

[backup]
enabled = false
interval_hour = 24
path = "data/backups"
max_backups = 7

[encryption]
# key = ""  # hex エンコードされた32バイトのAES-256キー（未設定で暗号化無効）

環境変数 FINDSENRYU_ プレフィックスで設定を上書きできます（例: FINDSENRYU_DISCORD_TOKEN）。

川柳データの暗号化

川柳の内容（上の句・中の句・下の句）をAES-256-GCMで暗号化してデータベースに保存できます。

1. 暗号化キーを生成:

   openssl rand -hex 32
   

2. config.toml に設定:

   [encryption]
   key = "生成した64文字のhex文字列"
   

   または環境変数で設定:

   FINDSENRYU_ENCRYPTION_KEY=生成した64文字のhex文字列
   

3. Bot を起動すると、既存の平文データが自動的に暗号化されます（初回のみ）

暗号化を有効にした後にキーを削除すると、データが読めなくなるため起動が拒否されます。キーは安全に管理してください。

機能

• 川柳検出 — メッセージから5-7-5の音節パターンを自動検出・記録。テキストチャンネル、スレッド、フォーラム投稿、ボイスチャンネル、ステージチャンネルに対応
• チャンネルタイプ設定 — /channel でチャンネルタイプごとの検出有効/無効をサーバー単位で設定
• チャンネルミュート — チャンネル単位で検出を無効化。親チャンネルをミュートすると、その中のスレッドでも検出がスキップされます
• お問い合わせ — /contact でBot管理者にフィードバックや問い合わせを送信
• ユーザーオプトアウト — ユーザー単位・サーバー単位で検出を無効化
• 自動ミュート — Bot権限不足（Missing Access / Missing Permissions / メッセージ履歴読み取り不可）で返信に失敗した場合、該当チャンネルを自動的にミュートします（/unmute で解除可能）
• データ暗号化 — 川柳の内容をAES-256-GCMで暗号化してデータベースに保存（設定で有効化）
• 自動バックアップ — SQLite データベースの定期バックアップ（設定で有効化）
• 管理者通知 — サーバー参加/脱退通知と日次サマリーを管理チャンネルに送信（脱退時は川柳・オプトアウト設定を自動削除）
• ヘルスチェック — /health, /ready, /stats エンドポイント
• Prometheus メトリクス — /metrics エンドポイントで各種メトリクスを公開

License

This project is licensed under the MIT License.