Nelfie(ネルフィー) は、Discord 上で会話・ツール実行・VOICEVOX 読み上げを統合して動かす Rust 製の bot です。
Observer-rust の後継プロジェクトとして、スタンドアローン動作を前提に設計されており、OpenAI API を利用した会話機能を中心に、様々なツールや機能を提供します。
- 会話: OpenAI API を利用した会話機能 モデル選択可能 レート制限可能 システムプロンプト設定可能
- tools:
- get_time.rs: 国コードから現在の時刻を取得
- latex.rs: TeX 数式を画像化
- file.rs: Discord添付ファイルの一覧・読み取り・Responses API入力
- typst.rs: TypstからPNG・SVGページ画像またはPDFを生成
- modal_builder.rs: ストレージなしの短い stateless trigger でモーダルダイアログを動的に構築
- discord.rs: Discord 操作系ツール（例: メッセージ検索、プロフィール、チャンネル管理）
- discord_reply.rs: 1回1投稿の会話返信（返信先・ユーザーメンションに対応）
- voicevox.rs: VOICEVOX 操作系ツール（例: 話者変更、スタイル変更、読み上げ）
- tools:
- VOICEVOX 読み上げ: VC内でのテキスト読み上げ機能 話者・スタイル選択可能 自動読み上げ機能
- TeX 数式の画像化: TeX 数式を画像化して Discord に送信する機能
- Typst: Typstコードと添付素材からPNG・SVGページ画像またはPDFを生成して Discord に送信する機能
- OS: Windows 10/11 (64-bit), Linux (x86_64)
- RAM: 3GB以上（ページアウトを期待できるなら2GBでも動作可能）
- CPU: x86_64-v3(AVX2をサポートしていなければなりません)
- ストレージ: 4GB以上の空き容量（VOICEVOXモデルとONNX Runtimeを含む）
ONNX Runtime の HWアクセラレーション についてはvoicevox_onnxruntimeのリリースノートを参照してください。
-
リリースからバイナリをダウンロード
-
.envを作成して秘密情報を設定
# required
DISCORD_TOKEN=xxxxxxxxxxxxxxxx
OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx
# 詳細ログが必要な場合のみ指定（既定は warn,nelfie=info）
# RUST_LOG=warn,nelfie=debug- 起動
初回起動時に config.yaml がなければ、既定値を入れたファイルを自動生成します。起動時に VOICEVOX core を初期化してから Discord Gateway を開始します。必要な辞書・モデル・ONNX Runtime が配置されていない場合は取得するため、初回起動にはネット接続と時間が必要です。
config.yaml は起動時の作業ディレクトリに置きます。ファイルがなければ、現在の既定値を入れたものを起動時に生成します。システムプロンプト、レート制限、管理者ID、応答タイムアウト、コンテキスト上限、VOICEVOX、TCP監視、オンライン状態Intentを設定できます。YAMLにない項目は既定値で補完します。未知の項目や型の誤りは起動時にエラーとして示します。
DISCORD_TOKEN と OPENAI_API_KEY は秘密情報なので、.env または環境変数に設定してください。これらのキーを config.yaml に書くことはできません。Botの動作設定は config.yaml から読み込みます。以前の非秘密な設定用環境変数は無視されるため、起動設定はこのファイルへ移してください。ログ出力の調整に使う RUST_LOG は従来どおり環境変数で指定できます。
admin_users は /rate config と /set_system_prompt を使える Discord user ID の一覧です。既定の空配列では管理者はいません。discord_presence_intent_enabled: true にするとオンライン状態の絞り込みが有効になります。先に Discord Developer Portal で Bot の GUILD_PRESENCES Privileged Gateway Intent を有効にしてください。既定は false です。
ログは既定でNelfie自身をINFO、serenityなどの依存ライブラリをWARN以上に絞ります。端末ではINFOやWARNなどのレベルを自動で色分けし、RUST_LOG_STYLE=alwaysまたはneverで明示できます。モデル応答はANSIエスケープ列と制御文字を除去して1行で記録します。詳細調査時はRUST_LOG=warn,nelfie=debug、依存ライブラリも含める場合は標準のRUST_LOGフィルタ構文で対象モジュールを追加してください。
現行実装ではVOICEVOX coreを起動時に初期化し、選択されたVVMをすべて読み込みます。 VVM の更新では新しいファイルを一時ディレクトリへ先に取得します。取得に失敗した場合や、入れ替え失敗後に旧 VVM を復元できた場合は、それを使って起動を続けます。復元にも失敗した場合と初回取得に失敗した場合は起動エラーになります。
身内用機能です。
Nelfieはconfig.yaml の monitor_tcp_bind で指定したアドレスにTCP監視サーバーを起動します。既定は127.0.0.1:9791です。監視サーバーから接続し、METRICS\nを送ると、key-value形式のメトリクスを返します。応答は空行で終わります。
192.168.0.254で待ち受ける場合は、config.yaml の値を変更して再起動してください。
monitor_tcp_bind: "192.168.0.254:9791"- id: "discord-bot.nelfie"
name: "nelfie"
type: tcp
host: "192.168.0.254"
port: 9791
interval: 60
timeout: 5
slow_ms: 500
hide_target: true
exclude_status: false
send: "METRICS\n"
response_end: "\n\n"
order: 200
max_bytes: 16384
response_codes:
0: operational
1: degraded
2: downこの bot は slash command と prefix command（!）の両方を登録します。
BASIC:
/ping: Discord API との遅延を測定して返す/status: Nelfieのバージョンと実行環境を表示/tex <expr>: TeX 数式を画像化して送信/typst <source | source_file> [asset_file] [asset_ids] [format]: Typst を出力。formatはpng（既定）、svg、pdf
CHAT BOT:
/enable mode:<mention|auto-reply>: ChatBot 機能を有効化します。mode省略時はmention（メンション時のみ応答）、auto-replyは会話をDecisions APIで判定して自動応答します。auto-replyは管理者のみ指定できます。- JudgeはDecisions APIを使い、チャンネルごとに10秒あたり1回までです。チャンネル内で通常返信やJudgeの推論中は、追加のJudgeを開始しません。
sleep判定では監視を1分から始め、連続するsleep判定ごとに2倍、最大32分まで停止します。Judgeがrespondと判定すると1分に戻ります。 /disable: ChatBot 機能を無効化/clear: 会話履歴をクリア/model: 使用する OpenAI モデルを選択/rate config <target_user> <limit>: レート制限の設定(管理者のみ)/rate status [target_user]: 現在のモデルコスト、一般/cronバケットのrate_line、残量、毎時回復量を表示/set_system_prompt: システムプロンプトの設定(管理者のみ)/cron add <schedule> <prompt>: 実行したチャンネルに、cron 表記で定期実行プロンプトを登録/cron test [id]: 登録済み cron を時刻に関係なく即時実行。IDを省略できるのは、このチャンネルに登録が1件だけの場合です。/cron delete <id>: 登録済み cron を削除
AI は file ツールで添付と get_user_profile が取得したプロフィール画像の一覧・UTF-8テキストの読み取り・次回API入力への追加を行います。プロフィール画像には再利用可能なIDが付き、file と typst-render.asset_ids から使えます。ユーザーがアップロードした .typ は添付IDを typst-render に直接渡すため、ソース本文を会話トークンとして送る必要はありません。typst-render は固有の draft_id を付けたPNGプレビューをAIへ返し、Discordには投稿しません。AIが確認したプレビューの draft_id を typst-publish に渡すため、別のレンダー結果が誤って投稿されません。添付本文は保存せず、チャンネルごとに直近256件のDiscord参照だけをプロセス内に保持します。/clear でそのチャンネルの参照も消去され、プロセス再起動後には残りません。
Typst は別プロセスで実行し、AIはまず全ページのPNGプレビューを確認します。Discordへの最終出力はPNG（既定）、SVG、または明示指定されたPDFです。入力は1ファイル25 MiB・合計50 MiB、出力合計18 MiB、ページ画像は最大50ページです。ワーカーは同時1つ、メモリ1 GiB、CPU 1コア相当、実行時間120秒に制限します。AI応答全体の既定期限は300秒で、config.yaml の timeout_millis を30,000〜600,000の範囲で変更できます。WindowsではJob Objectで制限します。Linuxでは systemd-run --user による一時serviceが必要です。ユーザーsystemd managerが利用できない、またはCPU・メモリ制限を適用できない環境ではレンダリングを開始しません。パッケージは公式 @preview のみ取得し、その他のURLとホスト上のファイルは参照できません。
VC / TTS:
/vc join [auto_read]: ボイスチャンネルに参加します。オプションでこのテキストチャンネルの自動読み上げを有効化できます。/vc leave: ボイスチャンネルから退出します。/vc say <text>: 指定したテキストを読み上げます。/vc download <text>: 現在の話者設定でWAV音声を生成し、ダウンロード可能なファイルとして送信します。/vc config [system_read] [auto_read] [parallel_count]: システム読み上げ、自動読み上げ、並列数を更新します。省略した項目は現在の設定を維持します。/vc autoread <enabled>: このテキストチャンネルでの自動読み上げの有効/無効を切り替えます。/vc dict <source> <target>: このテキストチャンネルの読み上げ辞書を登録または更新します。/vc dict-list: このテキストチャンネルの読み上げ辞書を登録者・最終更新者とともに10件ずつ表示します。ボタンでページを切り替えられます。/vc dict-delete <source>: このテキストチャンネルの読み上げ辞書エントリを削除します。/vc dict-user <source> <target>: 自分用の読み上げ辞書を登録または更新します。/vc dict-user-list: 自分用の読み上げ辞書を登録者・最終更新者とともに10件ずつ表示します。ボタンでページを切り替えられ、スラッシュコマンドでは本人にだけ表示します。/vc dict-user-delete <source>: 自分用の読み上げ辞書エントリを削除します。/vc speaker <speaker> <style> [speed] [pitch] [pan]: 自分の話者、スタイル、話速、音高、左右パンを設定します。/vc status: 現在の VC 状態と VOICEVOX 設定を表示します。
cron は実行環境のローカル時刻で、標準的な 5 フィールド表記（例: */30 * * * *）を使います。prefix command では cron add "*/30 * * * *" <prompt> のように cron 表記を引用してください。AI も cron-tool で cron の作成・一覧・削除を行えます。cron 実行は通常応答とは別の guild 単位 cron バケットで制御され、標準設定では 1 guild あたりおおむね 1 時間に 1 回実行できます。通常の /rate config は一般応答用のレート制限だけを変更します。
Mainline LLM の利用可能なモデルは gpt-6-luna のみです。モデル選択コマンドと選択状態は維持しており、現在は同じモデルを選択できます。画像生成モデルの選択肢はこの制限の対象外です。アプリのレート制限は実際のtoken数ではなく、モデルごとの固定コスト係数を使います。実際のAPI請求額はtoken数や長文context向け価格によって変わります。モデル一覧と現在モデルでは、レート制限で消費するコストを xN 形式で表示します。ユーザー既定、システム、cron、context要約のモデルは Models の USER_DEFAULT_MODEL、SYSTEM_MODEL、CRON_MODEL、CONTEXT_SUMMARY_MODEL で用途別に定義します。現在はいずれも gpt-6-luna です。
model-control ツールで mainline Responses モデルと画像生成モデルを切り替えられます。画像生成モデルの初期値は gpt-image-2.6-flare です。画像生成前にモデル設定を読み取るか変更し、次のResponses APIラウンドで設定済みモデルを使うネイティブ image_generation ツールを有効にします。推論レベルは常に low です。画像生成の開始1回ごとに追加でレート枠を1単位消費します。スラッシュコマンドでは /model get と /model image-set で確認・変更できます。
通常応答はチャンネルごとに安定したprompt_cache_keyを送信して、同じ会話contextのprefix cacheを再利用します。5.6系モデルではさらにprompt_cache_retention=24hを明示してextended prompt cacheを有効化します。GPT-6系モデルはAPIの標準cache制御を使います。APIが返すcached_tokensはtool-callを含む全ラウンドで集計し、応答完了ログへprompt_cache=hitまたはprompt_cache=missとともに表示します。
会話履歴は固定件数のローリングウィンドウでは削除しません。応答要求がレート制限を通過した時点で、tiktoken-rs の o200k_base による見積りが context_compaction_token_limit (既定64,000) 以上なら、古いturnの要約をバックグラウンドで開始します。応答APIには履歴全体を送らず、同じ見積りでしきい値の75% (既定48,000) に収まる直近turnを使います。GPT-6用 tokenizer の対応表はないため、この値はAPIの実測token数ではなく、画像・要求定義用の余裕を含めた推定です。要約入力の上限や失敗時の扱いはコンテキスト圧縮の仕様を参照してください。メンションのない発言から応答・圧縮APIは呼びません。
Discordの添付ファイルURLは署名付きで、クエリパラメータの ex は有効期限の16進Unix timestamp、is は発行時刻、hm は期限まで有効な署名です。詳細はDiscord公式のSigned Attachment CDN URLsを参照してください。
Nelfieは画像バイナリをBOT側でダウンロードせず、URLと元メッセージ/添付IDだけを会話履歴に保持します。OpenAI APIへ送信する直前に ex を確認し、有効期限の10分前を過ぎていればDiscordのメッセージを再取得してURLを更新します。ex が存在しない、または解析できないURLでは、取得から1時間後に更新するフォールバックを使います。
DiscordはTTLの固定値を公式には保証していません。Discord添付バイナリURLのTTLは、現時点では最短24時間、最長14日程度と推測されています。公式ドキュメントの例は is から ex までちょうど14日ですが、実装はこの推測値に依存せず、各URLの ex を基準にします。
コード構成、開発手順、VOICEVOX の処理設計は docs/README.md から参照できます。
DISCORD_TOKEN must be set:.envにDISCORD_TOKENを設定してください。OPENAI_API_KEY must be set:.envにOPENAI_API_KEYを設定してください。- VOICEVOX 関連で辞書/モデル/onnxruntime が見つからない:
config.yamlのvoicevox_open_jtalk_dict_dir、voicevox_vvm_dir、voicevox_onnxruntime_filename、またはvoicevox_core配下のディレクトリ構成を確認してください。
- KaTeX font と Noto Serif JP のライセンスは THIRD_PARTY_LICENSES.md に記載しています。
fontsディレクトリを再配布する場合は、上記ライセンス表記を同梱してください。
ダウンロードコンテンツはREADMEを含むのでそちらを参照。