KaedeVN リファレンス#

この説明書は KaedeVN 0.2.0（2026-10-21）のものです。

Unreal Engine の中でノベルゲームを作るプラグイン KaedeVN の、ノベルエディタのブロック・KS 台本の命令・検査・設定の項目を全部引ける説明書です。載せているのは UE で動く範囲だけで、台本に書けても UE で何もしない命令は §4.3 に名前だけを並べています。

• 入れてから見本を動かし、書き出すまでの手順は導入ガイドにあります。初めての人はそちらから読んでください。
• English

目次#

1. このリファレンスの読み方
2. ノベルエディタの画面
3. ブロック
4. KS 台本
5. KS 台本エディタ
6. 検査
7. 設定
8. 書き出し
9. モジュールとファイル
10. まだできないこと
11. 同梱物の権利

1. このリファレンスの読み方#

1.1 開く#

• ノベルエディタ: レベルエディタのメニューの Tools → KaedeVN → KaedeVN ノベルエディタ。どのマップを開いていても使えます。
• KS 台本エディタ: Tools → KaedeVN → KaedeVN KS台本エディタ、またはコンテンツブラウザで KaedeVN KS台本プロジェクト のアセットをダブルクリック。
• プロジェクトの設定: Edit → Project Settings → Plugins → KaedeVN（§7.1）。

1.2 用語#

1.3 表の読み方#

• §3〜§7 の表は、源（プラグインのソースと同梱のコンパイラ）から脚本が作っています。項目の数と名前は、この版のプラグインと同じです。
• 「欄」の列はエディタに出る名前です。エディタの表示はいまは日本語です。
• 「出る Op」は、そのブロックや命令がビルドで作る Op の名前です。ゲームが動かないときに scenario.json を見る手がかりになります。
• 命令の書き方の <…> は書く値、[…] は省いてよい部分です。fade=500 の形の引数は、fade 500 と空白で分けても同じです。

2. ノベルエディタの画面#

2.1 4 つの区画#

上の段には、作品を選ぶ欄（作品:）と、作品の画面の大きさ（解像度: 720p・1080p）、ボタンが並びます。

2.2 ボタンとキー#

ビルドの検査の指摘は下の一覧に出ます。行を押すと、その話を開いてそのブロックを選びます。

3. ブロック#

ノベルエディタの ＋ブロック で置けるブロックと、その欄です。option（選択肢）は choice の中にだけ置けます。

text（テキスト）#

台詞か地の文を 1 つ出し、クリックを待つ。

出る Op: TEXT_APPEND・WAIT_CLICK

bg（背景）#

背景を替える。

出る Op: BG_SET

ch（立ち絵）#

立ち絵を出す、または消す。

出る Op: CH_HIDE・CH_SET

set_var（変数設定）#

変数に入れる・足す・引く。

出る Op: VAR_ADD・VAR_SUB・VAR_SET

jump（ジャンプ）#

別の話へ飛ぶ。

出る Op: JUMP

if（条件分岐）#

条件で分ける。中に「合うとき」と「合わないとき」のブロックを置く。

出る Op: JUMP_IF・JUMP

choice#

選択肢を出す。中に「選択肢」を置き、それぞれの中に選んだ後のブロックを置く。

欄なし。

出る Op: CHOICE・JUMP

option（選択肢）#

選択肢 1 つ（choice の中にだけ置ける）。

4. KS 台本#

KS 台本は 1 話 1 ファイルの文字の台本です。ノベルエディタで保存すると、ブロックから同じ中身の .ks が書かれます。KS 台本エディタで直接書くこともできます（§5）。

; title: 枯れた泉
*start
@bg forest fade=500
#ナレーション
ルカは、いつもの足取りで村の中央にある泉へと向かっていた。
@l
@ch luca default center
#ルカ
……泉が、枯れている。
@p
@jump next

4.1 行の種類#

4.2 命令#

@ で始まる行です。ここに載せたのは、UE のゲームで絵・文字・流れに効く命令だけです。例の next はラベル *next の名前です。

UE で効く命令は 39 個（別名 2 個を除く）。

@bg#

背景を替える。id を書かない @bg だけの行は、背景を消す（BG_CLEAR）。

書き方: @bg <id> [fade=<ms>|slide_left=<ms>|slide_right=<ms>] [x=<n>] [y=<n>] [s=<scale>]

例:

@bg forest fade=500
@bg

出る Op: BG_SET・BG_CLEAR

@ch#

立ち絵を出す。同じ名前の立ち絵が出ていれば、ポーズと位置を差し替える。

書き方: @ch <name> <pose> <pos> [fade=<ms>] [x=<n>] [y=<n>] [s=<scale>]

例:

@ch luca default center fade=300

出る Op: CH_SET

@ch_hide#

立ち絵を 1 人消す。

書き方: @ch_hide <name> [fade=<ms>]

例:

@ch_hide luca fade=300

出る Op: CH_HIDE

@ch_clear#

立ち絵を全部消す。

書き方: @ch_clear [fade=<ms>]

例:

@ch_clear fade=300

出る Op: CH_CLEAR

@ch_expr#

出ている立ち絵の表情（ポーズ）だけを替える。位置はそのまま。

書き方: @ch_expr <name> <expression> [fade=<ms>]

例:

@ch_expr luca default fade=200

出る Op: CH_EXPR

@ch_move#

出ている立ち絵を別の立ち位置へ動かす。動いている間も本文は進められる。

書き方: @ch_move <name> <pos> [<ms>|time=<ms>]

例:

@ch_move luca left time=500

出る Op: CH_MOVE

@text_clear#

表示中の本文を消す。クリックは待たない（@p と違い、すぐ次の行へ進む）。

書き方: @text_clear [all|current|target=all|target=current]

例:

@text_clear all

出る Op: TEXT_CLEAR

@sprite#

絵（スプライト）を 1 枚、決めた位置に出す。看板・小物・図などに使う。

書き方: @sprite <id> <storage> [layer=front|back] [x=<n>] [y=<n>] [opacity=<0-1>] [fade=<ms>]

例:

@sprite sign 01KSHMK3T7F6PTKTEX6DW06WZ7 layer=front x=100 y=80 fade=300

出る Op: SPRITE_SET

@sprite_move#

出ているスプライトを動かす・透かす・拡大する。書かない引数は今の値のまま。

書き方: @sprite_move <id> [x=<n>] [y=<n>] [opacity=<0-1>] [scale=<scale>] [time=<ms>]

例:

@sprite_move sign x=400 time=500

出る Op: SPRITE_MOVE

@sprite_hide#

スプライトを 1 枚消す。

書き方: @sprite_hide <id> [fade=<ms>]

例:

@sprite_hide sign fade=300

出る Op: SPRITE_HIDE

@sprite_clear#

スプライトを全部（または片方のレイヤだけ）消す。

書き方: @sprite_clear [layer=front|back] [fade=<ms>]

例:

@sprite_clear fade=300

出る Op: SPRITE_CLEAR

@text#

メッセージ枠の外の、決めた位置に文字を出す（場所の名前・日付など）。

書き方: @text <id> "<text>" [x=<n>] [y=<n>] [size=<n>] [color=#rrggbb] [bold=true] [layer=front|back] [fade=<ms>]

例:

@text place "Chapter 1" x=40 y=40 size=32 color=#ffffff

出る Op: TEXT_SPRITE_SET

@ui_show#

MomijiUI の画面（作品の ui/<id>.json）を出す。

書き方: @ui_show <screenId> [wait=true]

例:

@ui_show menu wait=true

出る Op: UI_SHOW

@ui_hide#

@ui_show で出した画面を閉じる。

書き方: @ui_hide

引数なし。

例:

@ui_hide

出る Op: UI_HIDE

@layer#

背景・立ち絵・重ね絵のレイヤを、まとめて隠す・透かす。

書き方: @layer name=<layer> [visible=true|false] [opacity=<0-1>]

例:

@layer name=character visible=false

出る Op: LAYER_SET

@transition#

レイヤの切り替えの溶けこみを始める。待たずに次へ進むので、終わりを待つには @wait_transition を続ける。

書き方: @transition [target=<layer>] [type=fade] [time=<ms>]

例:

@transition target=background type=fade time=800

出る Op: TRANSITION

@wait_transition#

@transition が終わるまで待つ。

書き方: @wait_transition [target=<layer>]

例:

@wait_transition target=background

出る Op: WAIT_TRANSITION

@mask#

画面全体を 1 色で覆う（暗転の幕など）。

書き方: @mask [color=#rrggbb] [opacity=<0-1>] [time=<ms>]

例:

@mask color=#000000 opacity=1 time=500

出る Op: MASK_SET

@mask_clear#

@mask の幕を外す。

書き方: @mask_clear [time=<ms>]

例:

@mask_clear time=500

出る Op: MASK_CLEAR

@wait_camera#

@camera の動きが終わるまで待つ。

書き方: @wait_camera

引数なし。

例:

@wait_camera

出る Op: WAIT_CAMERA

@wait#

決めた時間だけ待つ（クリックでは飛ばせない）。

書き方: @wait <sec>

例:

@wait 1.5

出る Op: WAIT_MS

@timeline_play#

タイムライン（複数の動きを時間に沿って並べた演出）を再生し、終わるまで待つ。scenario.json と同じフォルダの timelines.json から id で引く。無い id は何もせず先へ進む。

書き方: @timeline_play <timelineId>

例:

@timeline_play opening

出る Op: TIMELINE_PLAY

@filter#

画面全体に色のフィルタをかける。UE で効く名前は grayscale（mono）・sepia・warm（morning）・cool（night）。

別名: @screenFilter（同じ働き）。

書き方: @filter <type> [<intensity>]

例:

@filter sepia 0.8

出る Op: SCREEN_FILTER

@filter_clear#

画面のフィルタを外す。

別名: @screenFilterClear（同じ働き）。

書き方: @filter_clear

引数なし。

例:

@filter_clear

出る Op: SCREEN_FILTER_CLEAR

@shake#

画面を揺らす。揺れ終わるまで待つ。

書き方: @shake [<intensity>] [<duration>]

例:

@shake 8 400

出る Op: SHAKE

@flash#

画面を一瞬白く光らせる。終わるまで待つ。

書き方: @flash [<duration>]

例:

@flash 200

出る Op: FLASH

@fade_black#

画面を黒へ暗くする（暗転）。終わるまで待つ。戻すのは @black_in。

書き方: @fade_black [<duration>]

例:

@fade_black 500

出る Op: FADE_BLACK

@fade_white#

画面を白へ飛ばす。終わるまで待つ。戻すのは @white_in。

書き方: @fade_white [<duration>]

例:

@fade_white 500

出る Op: FADE_WHITE

@black_in#

黒い画面から絵へ明ける。終わるまで待つ。

書き方: @black_in [<duration>]

例:

@black_in 500

出る Op: BLACK_IN

@white_in#

白い画面から絵へ戻す。終わるまで待つ。

書き方: @white_in [<duration>]

例:

@white_in 500

出る Op: WHITE_IN

@overlay#

画面の前に絵を重ねる（雨・霧・枠など）。同じ id を出し直すと、位置と倍率を差し替える。

書き方: @overlay <id> [fade=<ms>] [x=<n>] [y=<n>] [s=<scale>]

例:

@overlay rain fade=300

出る Op: OVERLAY_SET

@overlay_hide#

重ねた絵を消す。id を書かなければ全部。

書き方: @overlay_hide [<id>] [fade=<ms>]

例:

@overlay_hide rain fade=300

出る Op: OVERLAY_HIDE

@camera#

画面のカメラを動かす（寄る・ずらす）。待たずに次へ進むので、終わりを待つには @wait_camera を続ける。

書き方: @camera [x=<n>] [y=<n>] [zoom=<scale>] [time=<ms>] [reset]

例:

@camera zoom=1.5 x=100 y=0 time=800

出る Op: CAMERA_SET

@call#

ラベルへ飛び、そこで @return に来たら、この行の次へ戻る（サブルーチン）。

書き方: @call <label>

例:

@call next

出る Op: CALL

@return#

@call で来た所へ戻る。@call で来ていなければ台本を終える。

書き方: @return

引数なし。

例:

@return

出る Op: RETURN

@jump#

ラベルへ飛ぶ。別の話（別のファイル）のラベルへも飛べる。

書き方: @jump <label>

例:

@jump next

出る Op: JUMP

@l#

クリックを待つ（本文は消さない）。本文の行の終わりに @l と続けて書くこともできる。

書き方: @l

引数なし。

例:

@l

出る Op: WAIT_CLICK

@p#

クリックを待ち、本文を消して次のページにする。

書き方: @p

引数なし。

例:

@p

出る Op: PAGE

@r#

本文を改行する。

書き方: @r

引数なし。

例:

@r

出る Op: TEXT_NL

4.3 UE ではまだ動かない命令#

次の命令は、台本に書けばビルドは通りますが、UE のゲームでは何も起きません（Live2D・VRM・粒子・RPG のマップなど、ほかの再生のための命令と、まだ UE で音を鳴らしていない音の命令）。UE の再生がこれを読み飛ばしても、台本はそのまま先へ進みます。

37 個。台本に書いてもコンパイルは通るが、UE のゲームでは何も起きない。

4.4 KSC#

.ksc の中で呼べる関数のうち、UE の再生が受け取るものです。ここに無い関数は、UE では呼んでも何もせずに先へ進みます。

35 個（うち 5 個は UE では何も出ない）。

5. KS 台本エディタ#

5.1 画面#

KS 台本エディタは、台本の行を木で見せ、選んだ行の欄・プレビュー・検査（§6.2）を並べる画面です。

• 行の種類は 6 つ: 空行・注釈（;）・ラベル（*）・タグ（@ の命令）・話者（#）・本文。
• 本文と話者の行には専用の欄があります。タグの行は、下の表のタグなら専用の欄、ほかのタグとラベル・注釈は「行テキスト」の欄で 1 行をそのまま直します。
• 欄を直しても、その行のほかの引数（知らない key=value）は消えずに残ります。エディタはほかの行と整形に手を触れません（台本の正は文字のファイル）。
• ＋行追加・行削除・↑・↓・＋ページ・ページ削除・保存・ビルド（kaedevn-ks-compile.exe で scenario.json に組む）。

5.2 専用の欄のあるタグ#

6. 検査#

6.1 ビルドの検査#

ノベルエディタのビルドが見る点です。どれもビルドは止めません（組めて、遊ぶとおかしくなる所を知らせます）。素材が見つからない検査は、作品の assets.json を読めたときだけ働きます。

15 種。

6.2 KS の検査#

KS 台本エディタが行ごとに付ける印です。エラーはビルドか遊ぶときに壊れる所、警告は画面が崩れる所、情報は誤りではないが気を付ける所です。

8 種。

7. 設定#

7.1 プロジェクトの設定#

Edit → Project Settings → Plugins → KaedeVN。既定はプラグインの Config/DefaultKaedeVN.ini にあり、プロジェクトの Config/DefaultKaedeVN.ini で上書きします。

7.2 作品のデータの鍵#

作品の置き場の中のファイルです（見本の作品から拾った鍵）。ノベルエディタの「解像度」を選ぶと、work.json に画面の大きさ（screen）が書かれ、ビルドで scenario.json に渡ります。

7.3 ゲームのコンフィグ画面#

見本の作品のコンフィグ画面（ui/config.json）の項目です。画面は MomijiUI の JSON なので、作品ごとに項目を増やし・減らせます。

17 項目。UE のゲームが反映するのは 4 項目で、残りは画面で選べるが UE のゲームは使わない。

8. 書き出し#

• ゲームの土台は KaedeVnHost モジュールの GameInstance・GameMode・PlayerController です。GameInstance を設定していないプロジェクトでも、GameMode を KaedeVnGameMode にすれば、PlayerController がノベルの画面を載せます。操作（進む・選ぶ・戻る・オート・スキップ・クイックセーブ／ロード・メニュー）は Enhanced Input でプラグインが割り当てます。
• 作品の置き場（§7.1 の WorkRoot）を UFS に入れます。既定の Game なら、プロジェクトの Config/DefaultGame.ini の [/Script/UnrealEd.ProjectPackagingSettings] に +DirectoriesToAlwaysStageAsUFS=(Path="../Game") の 1 行。この行が無いと、書き出したゲームは起動しても台本が見つかりません。
• 書き出しの命令（RunUAT の BuildCookRun）には -nodebuginfo を付けます。付けないと PDB がアーカイブに入り、大きくなります。
• アーカイブの置き場は回ごとに空になりません。大きさを測る前に Saved/Package と Saved/StagedBuilds を空にします。
• 書き出したゲームのログとセーブは、.exe の隣でなく %LOCALAPPDATA%\<プロジェクト名>\Saved に書かれます。

9. モジュールとファイル#

同梱の exe（ThirdParty/Win64/。ネットワークには出ない。出所と作り直し方は ThirdParty/Win64/README.md、同じ物かは SHA256SUMS.txt で確かめる）:

画面の描画と書体は MomijiUI プラグインです（Fab の無料の商品。KaedeVN の .uplugin が有効にします）。

10. まだできないこと#

• 作るのは Windows のエディタだけです（Mac・Linux のエディタでは作れません）。
• エディタの表示は日本語です。このリファレンスの英語版は欄の名前を英語で説明しています。
• §4.3 の命令は UE では何もしません。BGM・効果音・声の命令もその中にあり、いまの UE の再生は音を鳴らしません（BGM の名前はセーブに入りますが、鳴りません）。
• §4.2 の命令でも、引数の表で「効かない」とした引数は UE では使いません（背景と立ち絵の位置ずらし・拡大、背景の滑らせる切り替え、立ち絵が消えるときのフェードなど）。
• コンフィグ画面の項目のうち、UE のゲームが反映するのは §7.3 の表の「反映する」の項目だけです。
• KS の選択肢の条件（"…" if (…) {）はまだ効きません。

11. 同梱物の権利#

• KaedeVN は MIT ライセンスです（© 2026 kaedeasset。プラグインの LICENSE）。
• 同梱の exe 3 本は Node.js の単一実行ファイル（Node.js は MIT と、その同梱物のライセンス）に、KaedeVN の MIT のコンパイラを入れたものです（CREDITS.md）。
• 書体のファイルは入っていません。文字は MomijiUI の書体（SIL Open Font License 1.1）で描きます。
• 見本の作品の絵（背景 2 枚・立ち絵 2 枚）は作者が Midjourney で作ったもので、CC0 1.0 です。音と書体は入っていません（Resources/Samples/LICENSE-ASSETS.md）。
• Unreal と Unreal Engine は Epic Games, Inc. の商標です。KaedeVN は Epic Games と関係のない、独立した非公式のプラグインです。