VContainer + VitalRouter.MRuby を前提とした、Unity 向けの汎用ノベルゲームライブラリ。
void2610 の複数 Unity プロジェクト（color-recollection / unity1week-2026-03 / apocalyptic-apartment-hunting ほか）で個別実装されていたノベルゲーム機能を、 1 つの再利用可能なライブラリへ統合することを目的とする。
ステータス: 実装初期（API は流動的） コア（ランナー / DSL 語彙 / 状態ブリッジ / インラインタグ / 参考 View）は実装済みで、 サンプルシーンで全パイプラインの動作を確認済み。ただし型名・API・DSL は変わる可能性がある。 設計判断・残論点は
Knowledge~/design/に OKF 形式で記録している。
- 最小チュートリアル →
Docs/getting-started.md（セットアップ・シーン配線・再生・自前 View 差し替え） - シナリオの書き方（ライター向け） →
Docs/scenario/（全命令・インラインタグ・分岐とフラグ・制約と落とし穴）
| 役割 | パッケージ |
|---|---|
| DI | VContainer |
| コマンドバス | VitalRouter |
| シナリオスクリプト | VitalRouter.MRuby (MRubyCS) |
| 非同期 | UniTask |
| リアクティブ | R3 |
スプレッドシート等によるシナリオ読み込みは対象外。シナリオは MRuby (.rb → .mrb) で記述する。
4 アセンブリ + game 側配線層に分割する。
| asmdef | 内容 |
|---|---|
Novel.Commands |
[MRubyObject] record struct : ICommand 群。VitalRouter + MRubyCS.Serializer のみ依存 |
Novel.Runtime |
純 C# コア。ランナー / IScenarioSource / INovelView / [Routes] ハンドラ / プリアンブル / タイプライタ / 状態ストア / バックログ |
Novel.View |
任意の MonoBehaviour 参考 View（メッセージ窓・立ち絵・選択 UI 等）。game は無視して自前供給も可 |
Novel.Editor |
.rb ScriptedImporter + カタログ/検証 |
詳細は Knowledge~/design/architecture.md を参照。
設計・仕様・意思決定は Knowledge~/（OKF v0.1）で管理する。
運用規約は submodule Knowledge~/conventions/ を参照（読み取り専用）。
clone 時は submodule を含めること:
git clone --recurse-submodules https://github.com/void2610/novel-kit.git
# 付け忘れた場合:
git submodule update --init --recursive