Add the doc_shots documentation screenshot suite; mod documentation
This commit is contained in:
cthangover committed
1 parent
fe68178a7f
commit
650f87c6ed
21 files changed
+1166
-9
No files matched your search
Binary file not shown.
|
After Width: | Height: | Size: 55 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 70 KiB |
+99
@@ -0,0 +1,99 @@
|
||||
# Dialog Engine — the dialog box and the scenario language
|
||||
|
||||
Dialog Engine is what the player reads and clicks: the dialog box with its lines, portraits and answers. Behind it is the **scenario language** — small `.scenario` text files in which a story is written line by line: what is said, which answers there are, where each answer leads, and what happens in the game (a new background, music, an item, a quest step, another scene). Every game in the collection, from the novel template to RPG Plus, tells its story with it.
|
||||
|
||||
## What the player sees
|
||||
|
||||
A scene's scenario starts by itself when the player enters the scene. Lines appear in the box at the bottom; a click shows the next one:
|
||||
|
||||
|
||||
|
||||
When the story asks something, the answers appear on the right. The story waits until one is chosen:
|
||||
|
||||
|
||||
|
||||
"Go into the bar" takes the player to the bar scene, which starts its own scenario:
|
||||
|
||||
|
||||
|
||||
## The scenario behind these pictures
|
||||
|
||||
This is the whole town scenario of the novel template (`my_novel_game/scenarios/my_novel_town.scenario`):
|
||||
|
||||
```scenario
|
||||
scene: my_novel_town
|
||||
priority: 10
|
||||
---
|
||||
# The town is the hub: every visit shows the same choice.
|
||||
text "Evening town. The street lamps are already lit and a cool draught runs along the cobbles." key=my_novel/town/intro
|
||||
select "Where to go?" key=my_novel/town/prompt
|
||||
option "Go into the bar" key=my_novel/town/opt_bar -> :bar
|
||||
option "Go back home" key=my_novel/town/opt_home -> :home
|
||||
|
||||
:bar
|
||||
switch_scene my_novel_bar
|
||||
end
|
||||
|
||||
:home
|
||||
switch_scene my_novel_home
|
||||
end
|
||||
```
|
||||
|
||||
- **The header** above `---` says when the scenario plays: `scene:` names the scene, `priority:` orders several scenarios of one scene (lower plays first). More header lines are below.
|
||||
- `text "…"` shows a line and waits for a click. `key=` is the translation key of the line; the quoted text is what is shown when no translation is found.
|
||||
- `select` asks a question, and each `option` is an answer that jumps to a **label** (`-> :bar`).
|
||||
- `:bar` is a label; `switch_scene` goes to another scene; `end` finishes the scenario.
|
||||
- A line starting with `#` is a note for the author.
|
||||
|
||||
To add a story to a scene, put a `.scenario` file anywhere in your mod's `scenarios/` folder and name the scene in its header.
|
||||
|
||||
## Writing a story
|
||||
|
||||
**Lines and portraits.** `text "…" first=marao/sad` shows a portrait in the first place, `second=…` in the second (see Characters Engine). `ptext` is the same as `text`, and also replaces `${name}` with the value of a variable. `title "…"` shows a chapter title.
|
||||
|
||||
**Choices and jumps.** An answer can be shown only when a condition holds: `option "Pay" "if=item('money/coin') >= 5" -> :pay` (a condition with spaces is quoted together with `if=`). `goto -> :label` jumps without asking. `when "<condition>" -> :label` jumps if the condition holds at that moment:
|
||||
|
||||
```scenario
|
||||
when "rpg_wolf_dead == 1" -> :lantern
|
||||
```
|
||||
|
||||
**Remembering things.** `flag rpg_quest_taken 1` sets a story flag that is saved with the game; conditions read it as `rpg_quest_taken == 1`. `set name value` sets a variable of the running dialog; `ptext` shows it as `${name}` and actions can read it.
|
||||
|
||||
**Conditions** are one shared language: flags, `item('id')` from Items Base, quest checks from Quests Engine, stats and equipment from their mods, joined with `&&`, `||` and `!`.
|
||||
|
||||
**The scene.** `background`, `foreground`, `background_color`, `music`, `sound`, `effect`, `delay`, `light_set`, `hide_dialog`/`show_dialog`, `interactive_add`/`interactive_remove`, `notify`.
|
||||
|
||||
**Game actions.** `action <name> key=value …` runs an action of another mod, for example `action item.add id=money/coin count=3` or `action quest.set_status quest_id=woodland_ward status=Progress`. The schema files of the mods list the actions, and Editor Tools offers them in its scenario editor and command palette.
|
||||
|
||||
## When a scenario plays
|
||||
|
||||
The header decides it:
|
||||
|
||||
```scenario
|
||||
scene: prolog_alley
|
||||
priority: 15
|
||||
condition: AwakeningQuest.notHasTag("cloak_taken")
|
||||
is_one_run: true
|
||||
save_allowed: true
|
||||
---
|
||||
```
|
||||
|
||||
- `scene:` — the scene where it plays when the player arrives.
|
||||
- `priority:` — order among scenarios of the same scene; the lowest number that may play goes first, and the next one starts when the dialog ends.
|
||||
- `condition:` — it plays only while the condition holds; when a flag or quest changes, the scene checks again.
|
||||
- `is_one_run: true` — it plays only once per game.
|
||||
- `after:` — it waits until the named scenario has played.
|
||||
- `save_allowed: true` — the player may save in this scene.
|
||||
|
||||
A scenario without a `scene:` header is not started by a scene; it is run by something else, such as a click on an interactive object or a map event.
|
||||
|
||||
## Other mods add and replace scenarios
|
||||
|
||||
Scenarios of all mods are collected together. A mod adds a story to someone else's scene simply by naming that scene. A mod that depends on another and ships a scenario with the same file name replaces it.
|
||||
|
||||
## If something goes wrong
|
||||
|
||||
1. **A scenario never plays.** Its `scene:` name is wrong, its `condition` is false, or it has `is_one_run` and has already played.
|
||||
2. **The line is shown in the wrong language.** The `key=` is missing from the mod's `locale` files for that language; the quoted text is shown instead.
|
||||
3. **An answer leads nowhere.** The label after `->` must exist in the same file, written with a colon (`:bar`).
|
||||
4. **An `action` does nothing.** The mod that owns the action is not part of the game (the log says the action "is not registered"), or a parameter name is wrong — compare it with the action in the scenario editor of Editor Tools.
|
||||
+99
@@ -0,0 +1,99 @@
|
||||
# Dialog Engine — la caja de diálogo y el lenguaje de escenarios
|
||||
|
||||
Dialog Engine es lo que el jugador lee y pulsa: la caja de diálogo con sus líneas, retratos y respuestas. Detrás está el **lenguaje de escenarios** — pequeños archivos de texto `.scenario` en los que la historia se escribe línea a línea: quién dice qué, qué respuestas hay, adónde conduce cada una y qué ocurre en el juego (un fondo nuevo, música, un objeto, un paso de misión, otra escena). Con él cuentan su historia todos los juegos de la colección, desde la plantilla de novela hasta RPG Plus.
|
||||
|
||||
## Lo que ve el jugador
|
||||
|
||||
El escenario de una escena arranca solo cuando el jugador entra en ella. Las líneas aparecen en la caja inferior; un clic muestra la siguiente:
|
||||
|
||||
|
||||
|
||||
Cuando la historia hace una pregunta, las respuestas aparecen a la derecha, y espera a que se elija una:
|
||||
|
||||
|
||||
|
||||
«Entrar al bar» lleva al jugador a la escena del bar, que arranca su propio escenario:
|
||||
|
||||
|
||||
|
||||
## El escenario detrás de estas imágenes
|
||||
|
||||
Este es el escenario completo del pueblo de la plantilla de novela (`my_novel_game/scenarios/my_novel_town.scenario`):
|
||||
|
||||
```scenario
|
||||
scene: my_novel_town
|
||||
priority: 10
|
||||
---
|
||||
# El pueblo es el centro: en cada visita aparece la misma elección.
|
||||
text "El pueblo, al anochecer. Las farolas ya están encendidas y un aire fresco corre entre los adoquines." key=my_novel/town/intro
|
||||
select "¿A dónde ir?" key=my_novel/town/prompt
|
||||
option "Entrar al bar" key=my_novel/town/opt_bar -> :bar
|
||||
option "Volver a casa" key=my_novel/town/opt_home -> :home
|
||||
|
||||
:bar
|
||||
switch_scene my_novel_bar
|
||||
end
|
||||
|
||||
:home
|
||||
switch_scene my_novel_home
|
||||
end
|
||||
```
|
||||
|
||||
- **La cabecera**, sobre `---`, dice cuándo se reproduce el escenario: `scene:` nombra la escena y `priority:` ordena varios escenarios de una misma escena (se reproduce antes el número más bajo). Más adelante hay más líneas de cabecera.
|
||||
- `text "…"` muestra una línea y espera un clic. `key=` es la clave de traducción de la línea; el texto entrecomillado es lo que se muestra cuando no hay traducción.
|
||||
- `select` plantea una pregunta, y cada `option` es una respuesta que salta a una **etiqueta** (`-> :bar`).
|
||||
- `:bar` es una etiqueta; `switch_scene` pasa a otra escena; `end` termina el escenario.
|
||||
- Una línea que empieza por `#` es una nota para el autor.
|
||||
|
||||
Para añadir una historia a una escena, coloca un archivo `.scenario` en cualquier punto de la carpeta `scenarios/` de tu mod y nombra la escena en la cabecera.
|
||||
|
||||
## Escribir una historia
|
||||
|
||||
**Líneas y retratos.** `text "…" first=marao/sad` muestra un retrato en el primer puesto, `second=…` en el segundo (véase Characters Engine). `ptext` hace lo mismo que `text` y además sustituye `${name}` por el valor de una variable. `title "…"` muestra el título de un capítulo.
|
||||
|
||||
**Opciones y saltos.** Una respuesta puede mostrarse solo mientras se cumpla una condición: `option "Pay" "if=item('money/coin') >= 5" -> :pay` (una condición con espacios se entrecomilla junto con `if=`). `goto -> :label` salta sin preguntar. `when "<condition>" -> :label` salta si la condición se cumple en ese momento:
|
||||
|
||||
```scenario
|
||||
when "rpg_wolf_dead == 1" -> :lantern
|
||||
```
|
||||
|
||||
**Recordar cosas.** `flag rpg_quest_taken 1` activa un marcador argumental que se guarda con la partida; las condiciones lo leen como `rpg_quest_taken == 1`. `set name value` asigna una variable del diálogo en curso: `ptext` la muestra como `${name}` y las acciones pueden leerla.
|
||||
|
||||
**Las condiciones** son un único lenguaje común: marcadores, `item('id')` de Items Base, comprobaciones de misiones de Quests Engine, atributos y equipo de sus respectivos mods, unidos con `&&`, `||` y `!`.
|
||||
|
||||
**La escena.** `background`, `foreground`, `background_color`, `music`, `sound`, `effect`, `delay`, `light_set`, `hide_dialog`/`show_dialog`, `interactive_add`/`interactive_remove`, `notify`.
|
||||
|
||||
**Acciones de juego.** `action <name> key=value …` ejecuta una acción de otro mod, por ejemplo `action item.add id=money/coin count=3` o `action quest.set_status quest_id=woodland_ward status=Progress`. Los archivos schema de los mods enumeran las acciones, y Editor Tools las ofrece en su editor de escenarios y en la paleta de comandos.
|
||||
|
||||
## Cuándo se reproduce un escenario
|
||||
|
||||
Lo decide la cabecera:
|
||||
|
||||
```scenario
|
||||
scene: prolog_alley
|
||||
priority: 15
|
||||
condition: AwakeningQuest.notHasTag("cloak_taken")
|
||||
is_one_run: true
|
||||
save_allowed: true
|
||||
---
|
||||
```
|
||||
|
||||
- `scene:` — la escena donde se reproduce cuando el jugador llega.
|
||||
- `priority:` — el orden entre los escenarios de una misma escena; va primero el número más bajo que pueda reproducirse, y el siguiente empieza cuando termina el diálogo.
|
||||
- `condition:` — solo se reproduce mientras se cumple la condición; cuando cambia un marcador o una misión, la escena vuelve a comprobar.
|
||||
- `is_one_run: true` — se reproduce una sola vez por partida.
|
||||
- `after:` — espera a que se haya reproducido el escenario indicado.
|
||||
- `save_allowed: true` — el jugador puede guardar en esta escena.
|
||||
|
||||
Un escenario sin cabecera `scene:` no lo arranca ninguna escena: lo ejecuta otra cosa, como un clic sobre un objeto interactivo o un evento del mapa.
|
||||
|
||||
## Los demás mods añaden y reemplazan escenarios
|
||||
|
||||
Los escenarios de todos los mods se reúnen en un mismo conjunto. Un mod añade una historia a la escena de otro con solo nombrarla. Y un mod que depende de otro e incluye un escenario con el mismo nombre de archivo lo reemplaza.
|
||||
|
||||
## Si algo falla
|
||||
|
||||
1. **El escenario nunca se reproduce.** El nombre de `scene:` es incorrecto, la `condition` es falsa, o tiene `is_one_run` y ya se reprodujo.
|
||||
2. **La línea aparece en otro idioma.** Falta la clave `key=` en los archivos `locale` del mod para ese idioma, y se muestra el texto entrecomillado.
|
||||
3. **Una respuesta no lleva a ninguna parte.** La etiqueta tras `->` debe existir en el mismo archivo, escrita con dos puntos (`:bar`).
|
||||
4. **Una `action` no hace nada.** El mod dueño de la acción no forma parte del juego (el registro dice que la acción "is not registered") o hay un nombre de parámetro equivocado: compáralo con la acción en el editor de escenarios de Editor Tools.
|
||||
+99
@@ -0,0 +1,99 @@
|
||||
# Dialog Engine — ダイアログボックスとシナリオ言語
|
||||
|
||||
Dialog Engine は、プレイヤーが読んでクリックする部分すべてを担います。台詞・ポートレート・選択肢を表示するダイアログボックスであり、その背後には**シナリオ言語**があります。`.scenario` という小さなテキストファイルに物語を一行ずつ書いていく言語で、誰が何を言うか、どんな選択肢があり、それぞれがどこへ続くか、ゲーム内で何が起きるか（背景の切り替え、音楽、アイテム、クエストの進行、別シーンへの移動）をすべて記述します。コレクションに収録されたすべてのゲームが、小説テンプレートから RPG Plus まで、この言語で物語を語ります。
|
||||
|
||||
## プレイヤーに見えるもの
|
||||
|
||||
シーンに入ると、そのシーンのシナリオは自動的に始まります。台詞が画面下部のボックスに表示され、クリックで次の台詞に進みます。
|
||||
|
||||
|
||||
|
||||
物語が何かを尋ねるときは、選択肢が右側に現れます。選ばれるまで物語は待ちます。
|
||||
|
||||
|
||||
|
||||
「バーに入る」を選ぶと、プレイヤーはバーのシーンへ移動し、そこのシナリオが始まります。
|
||||
|
||||
|
||||
|
||||
## これらの画面の裏にあるシナリオ
|
||||
|
||||
小説テンプレートの町のシナリオ全文がこちらです（`my_novel_game/scenarios/my_novel_town.scenario`）。
|
||||
|
||||
```scenario
|
||||
scene: my_novel_town
|
||||
priority: 10
|
||||
---
|
||||
# 町はハブ:訪れるたびに同じ選択肢が表示される。
|
||||
text "夕暮れの町。街灯はすでにともり、石畳を涼しい風が抜けていく。" key=my_novel/town/intro
|
||||
select "どこへ行く？" key=my_novel/town/prompt
|
||||
option "バーに入る" key=my_novel/town/opt_bar -> :bar
|
||||
option "家に帰る" key=my_novel/town/opt_home -> :home
|
||||
|
||||
:bar
|
||||
switch_scene my_novel_bar
|
||||
end
|
||||
|
||||
:home
|
||||
switch_scene my_novel_home
|
||||
end
|
||||
```
|
||||
|
||||
- `---` より上の**ヘッダー**は、シナリオがいつ再生されるかを決めます。`scene:` はシーン名、`priority:` は同じシーンの複数シナリオの順序（小さいほうが先）です。ヘッダー行はこのほかにもあります。
|
||||
- `text "…"` は台詞を表示してクリックを待ちます。`key=` は台詞の翻訳キーで、引用したテキストは翻訳が見つからないときに表示されます。
|
||||
- `select` は質問を出し、各 `option` は**ラベル**（`-> :bar`）へ飛ぶ選択肢です。
|
||||
- `:bar` はラベル、`switch_scene` は別のシーンへの移動、`end` はシナリオの終了です。
|
||||
- `#` で始まる行は作者向けのメモです。
|
||||
|
||||
シーンに物語を追加するには、`.scenario` ファイルを自分の mod の `scenarios/` フォルダーのどこかに置き、ヘッダーでシーン名を指定します。
|
||||
|
||||
## 物語を書く
|
||||
|
||||
**台詞とポートレート。** `text "…" first=marao/sad` は一つ目の位置にポートレートを表示し、`second=…` は二つ目に表示します（Characters Engine を参照）。`ptext` は `text` と同じ動作に加え、`${name}` を変数の値で置き換えます。`title "…"` は章タイトルを表示します。
|
||||
|
||||
**選択肢とジャンプ。** 条件が満たされたときだけ選択肢を表示できます。`option "Pay" "if=item('money/coin') >= 5" -> :pay`（空白を含む条件は `if=` ごと引用符で囲みます）。`goto -> :label` は尋ねずにジャンプします。`when "<condition>" -> :label` は、その時点で条件が満たされていればジャンプします。
|
||||
|
||||
```scenario
|
||||
when "rpg_wolf_dead == 1" -> :lantern
|
||||
```
|
||||
|
||||
**状態の記憶。** `flag rpg_quest_taken 1` は、ゲームのセーブと一緒に保存される物語フラグを立てます。条件では `rpg_quest_taken == 1` と読みます。`set name value` は実行中のダイアログの変数を設定します。`ptext` はこれを `${name}` として表示し、アクションからも読めます。
|
||||
|
||||
**条件**は共通の言語です。フラグ、Items Base の `item('id')`、Quests Engine のクエスト判定、各 mod のステータスや装備を、`&&`、`||`、`!` で組み合わせられます。
|
||||
|
||||
**シーンの演出。** `background`、`foreground`、`background_color`、`music`、`sound`、`effect`、`delay`、`light_set`、`hide_dialog`/`show_dialog`、`interactive_add`/`interactive_remove`、`notify`。
|
||||
|
||||
**ゲームアクション。** `action <name> key=value …` は他の mod のアクションを実行します。例は `action item.add id=money/coin count=3` や `action quest.set_status quest_id=woodland_ward status=Progress` です。アクションの一覧は各 mod のスキーマファイルにあり、Editor Tools のシナリオエディターとコマンドパレットからも入力できます。
|
||||
|
||||
## シナリオが再生されるタイミング
|
||||
|
||||
決めるのはヘッダーです。
|
||||
|
||||
```scenario
|
||||
scene: prolog_alley
|
||||
priority: 15
|
||||
condition: AwakeningQuest.notHasTag("cloak_taken")
|
||||
is_one_run: true
|
||||
save_allowed: true
|
||||
---
|
||||
```
|
||||
|
||||
- `scene:` — プレイヤーが到着したときに再生されるシーン。
|
||||
- `priority:` — 同じシーンのシナリオ同士の順序。再生できる最小の番号が先になり、ダイアログが終わると次が始まります。
|
||||
- `condition:` — 条件が満たされている間だけ再生します。フラグやクエストが変わると、シーンは再度判定します。
|
||||
- `is_one_run: true` — 1 回のゲームで一度だけ再生。
|
||||
- `after:` — 指定したシナリオが再生されるのを待ちます。
|
||||
- `save_allowed: true` — このシーンではセーブできます。
|
||||
|
||||
`scene:` ヘッダーのないシナリオはシーンからは始まりません。インタラクティブオブジェクトのクリックやマップイベントなど、別のきっかけで実行されます。
|
||||
|
||||
## 他の mod による追加と置き換え
|
||||
|
||||
すべての mod のシナリオは一つにまとめられます。mod は、シーン名を書くだけで他人のシーンに物語を追加できます。別の mod に依存し、同じファイル名のシナリオを同梱した mod は、それを置き換えます。
|
||||
|
||||
## うまく動かないとき
|
||||
|
||||
1. **シナリオが再生されない。** `scene:` の名前が違う、`condition` が偽、あるいは `is_one_run` 付きで既に再生済みです。
|
||||
2. **台詞が別の言語で表示される。** その言語の翻訳キー `key=` が mod の `locale` ファイルになく、引用したテキストがそのまま表示されています。
|
||||
3. **選択肢がどこにも行かない。** `->` の後のラベルは、同じファイル内にコロン付き（`:bar`）で存在しなければなりません。
|
||||
4. **`action` が何もしない。** アクションを持つ mod がゲームに含まれていない（ログに "is not registered" と出ます）か、パラメーター名が間違っています。Editor Tools のシナリオエディターで該当アクションと見比べてください。
|
||||
+99
@@ -0,0 +1,99 @@
|
||||
# Dialog Engine — 대화 상자와 시나리오 언어
|
||||
|
||||
Dialog Engine은 플레이어가 읽고 클릭하는 모든 것을 담당합니다. 대사·초상화·선택지가 표시되는 대화 상자이며, 그 뒤에는 **시나리오 언어**가 있습니다. `.scenario`라는 짧은 텍스트 파일에 이야기를 한 줄씩 적어 나가는 언어로, 누가 무엇을 말하는지, 어떤 선택지가 있는지, 각 선택지가 어디로 이어지는지, 게임 안에서 무슨 일이 일어나는지(배경 전환, 음악, 아이템, 퀘스트 진행, 다른 장면으로 이동)를 모두 적습니다. 컬렉션의 모든 게임이 소설 템플릿부터 RPG Plus까지 이 언어로 이야기를 전합니다.
|
||||
|
||||
## 플레이어가 보는 것
|
||||
|
||||
장면에 들어가면 그 장면의 시나리오가 저절로 시작됩니다. 대사는 화면 아래 상자에 나타나고, 클릭하면 다음 대사로 넘어갑니다.
|
||||
|
||||
|
||||
|
||||
이야기가 무언가를 물으면 선택지가 오른쪽에 나타나고, 플레이어가 고를 때까지 기다립니다.
|
||||
|
||||
|
||||
|
||||
"술집에 들어가기"를 고르면 플레이어는 술집 장면으로 이동하고, 그곳의 시나리오가 시작됩니다.
|
||||
|
||||
|
||||
|
||||
## 이 화면 뒤의 시나리오
|
||||
|
||||
소설 템플릿 마을 시나리오의 전문입니다(`my_novel_game/scenarios/my_novel_town.scenario`).
|
||||
|
||||
```scenario
|
||||
scene: my_novel_town
|
||||
priority: 10
|
||||
---
|
||||
# 마을은 허브:방문할 때마다 같은 선택지가 표시된다.
|
||||
text "저녁 마을. 가로등은 이미 켜졌고, 돌바닥을 따라 차가운 바람이 불어 옵니다." key=my_novel/town/intro
|
||||
select "어디로 갈까요?" key=my_novel/town/prompt
|
||||
option "술집에 들어가기" key=my_novel/town/opt_bar -> :bar
|
||||
option "집으로 돌아가기" key=my_novel/town/opt_home -> :home
|
||||
|
||||
:bar
|
||||
switch_scene my_novel_bar
|
||||
end
|
||||
|
||||
:home
|
||||
switch_scene my_novel_home
|
||||
end
|
||||
```
|
||||
|
||||
- `---` 위의 **헤더**는 시나리오가 언제 재생되는지를 정합니다. `scene:`은 장면 이름, `priority:`는 같은 장면의 여러 시나리오 순서(작은 쪽이 먼저)입니다. 헤더 행은 아래에 더 있습니다.
|
||||
- `text "…"`는 대사를 보여 주고 클릭을 기다립니다. `key=`는 대사의 번역 키이며, 따옴표 안의 텍스트는 번역이 없을 때 표시됩니다.
|
||||
- `select`는 질문을 던지고, 각 `option`은 **레이블**( `-> :bar` )로 이동하는 선택지입니다.
|
||||
- `:bar`는 레이블, `switch_scene`는 다른 장면으로 이동, `end`는 시나리오 종료입니다.
|
||||
- `#`으로 시작하는 줄은 작성자를 위한 메모입니다.
|
||||
|
||||
장면에 이야기를 추가하려면 `.scenario` 파일을 자신의 mod `scenarios/` 폴더 어디에나 두고 헤더에 장면 이름을 적으면 됩니다.
|
||||
|
||||
## 이야기 쓰기
|
||||
|
||||
**대사와 초상화.** `text "…" first=marao/sad`는 첫 번째 자리에 초상화를, `second=…`는 두 번째 자리에 표시합니다(Characters Engine 참조). `ptext`는 `text`와 같으며 `${name}`을 변수 값으로 바꾸는 기능이 하나 더 있습니다. `title "…"`는 장 제목을 표시합니다.
|
||||
|
||||
**선택지와 점프.** 조건이 맞을 때만 선택지를 보이게 할 수 있습니다. `option "Pay" "if=item('money/coin') >= 5" -> :pay` (공백이 있는 조건은 `if=`까지 따옴표로 묶습니다). `goto -> :label`은 묻지 않고 건너뜁니다. `when "<condition>" -> :label`은 그 순간 조건이 맞으면 이동합니다.
|
||||
|
||||
```scenario
|
||||
when "rpg_wolf_dead == 1" -> :lantern
|
||||
```
|
||||
|
||||
**상태 기억.** `flag rpg_quest_taken 1`은 게임 저장에 함께 저장되는 스토리 플래그를 설정합니다. 조건에서는 `rpg_quest_taken == 1`로 읽습니다. `set name value`는 실행 중인 대화의 변수를 정합니다. `ptext`는 이를 `${name}`으로 표시하고 액션에서도 읽을 수 있습니다.
|
||||
|
||||
**조건**은 하나의 공용 언어입니다. 플래그, Items Base의 `item('id')`, Quests Engine의 퀘스트 확인, 각 mod의 스탯과 장비를 `&&`, `||`, `!`로 조합합니다.
|
||||
|
||||
**장면 연출.** `background`, `foreground`, `background_color`, `music`, `sound`, `effect`, `delay`, `light_set`, `hide_dialog`/`show_dialog`, `interactive_add`/`interactive_remove`, `notify`.
|
||||
|
||||
**게임 액션.** `action <name> key=value …`는 다른 mod의 액션을 실행합니다. 예를 들어 `action item.add id=money/coin count=3`, `action quest.set_status quest_id=woodland_ward status=Progress`입니다. 액션 목록은 각 mod의 스키마 파일에 있으며, Editor Tools의 시나리오 편집기와 커맨드 팔레트에서 바로 쓸 수 있습니다.
|
||||
|
||||
## 시나리오가 재생되는 시점
|
||||
|
||||
헤더가 결정합니다.
|
||||
|
||||
```scenario
|
||||
scene: prolog_alley
|
||||
priority: 15
|
||||
condition: AwakeningQuest.notHasTag("cloak_taken")
|
||||
is_one_run: true
|
||||
save_allowed: true
|
||||
---
|
||||
```
|
||||
|
||||
- `scene:` — 플레이어가 도착했을 때 시나리오가 재생되는 장면.
|
||||
- `priority:` — 같은 장면 시나리오끼리의 순서. 재생 가능한 가장 작은 번호가 먼저이며, 대화가 끝나면 다음이 시작됩니다.
|
||||
- `condition:` — 조건이 유지되는 동안에만 재생. 플래그나 퀘스트가 바뀌면 장면이 다시 확인합니다.
|
||||
- `is_one_run: true` — 게임당 한 번만 재생.
|
||||
- `after:` — 지정한 시나리오가 재생될 때까지 기다립니다.
|
||||
- `save_allowed: true` — 이 장면에서 저장할 수 있습니다.
|
||||
|
||||
`scene:` 헤더가 없는 시나리오는 장면이 시작하지 않습니다. 인터랙티브 오브젝트 클릭이나 맵 이벤트 같은 다른 계기가 실행합니다.
|
||||
|
||||
## 다른 mod의 추가와 교체
|
||||
|
||||
모든 mod의 시나리오는 한데 모입니다. mod는 장면 이름만 적으면 다른 mod의 장면에 이야기를 추가할 수 있습니다. 다른 mod에 의존하면서 같은 파일 이름의 시나리오를 포함한 mod는 그 시나리오를 교체합니다.
|
||||
|
||||
## 문제가 생겼을 때
|
||||
|
||||
1. **시나리오가 재생되지 않습니다.** `scene:` 이름이 틀렸거나, `condition`이 거짓이거나, `is_one_run`이 붙어 있어 이미 재생된 경우입니다.
|
||||
2. **대사가 다른 언어로 표시됩니다.** 해당 언어의 번역 키 `key=`가 mod의 `locale` 파일에 없어서 따옴표 안의 텍스트가 그대로 보입니다.
|
||||
3. **선택지가 어디로도 이어지지 않습니다.** `->` 뒤의 레이블은 같은 파일 안에 콜론을 붙여(`:bar`) 존재해야 합니다.
|
||||
4. **`action`이 아무것도 하지 않습니다.** 액션을 소유한 mod가 게임에 없거나(로그에 "is not registered"라고 기록됨), 매개변수 이름이 틀렸습니다. Editor Tools의 시나리오 편집기에서 해당 액션과 비교해 보세요.
|
||||
+99
@@ -0,0 +1,99 @@
|
||||
# Dialog Engine — окно диалога и язык сценариев
|
||||
|
||||
Dialog Engine — это то, что игрок читает и по чему щёлкает: окно диалога с репликами, портретами и вариантами ответа. За ним стоит **язык сценариев** — небольшие текстовые файлы `.scenario`, в которых история записана строка за строкой: кто что говорит, какие есть варианты ответа, куда ведёт каждый из них и что при этом происходит в игре (новый фон, музыка, предмет, шаг задания, другая сцена). С его помощью рассказывает свою история каждая игра коллекции — от шаблона новеллы до RPG Plus.
|
||||
|
||||
## Что видит игрок
|
||||
|
||||
Сценарий сцены запускается сам, как только игрок входит в неё. Реплики появляются в окне внизу экрана; щелчок показывает следующую:
|
||||
|
||||
|
||||
|
||||
Когда история о чём-то спрашивает, справа появляются варианты ответа — и она ждёт, пока игрок выберет один из них:
|
||||
|
||||
|
||||
|
||||
Вариант «Зайти в бар» переносит игрока в сцену бара, где запускается уже его собственный сценарий:
|
||||
|
||||
|
||||
|
||||
## Сценарий этих кадров
|
||||
|
||||
Вот весь сценарий города из шаблона новеллы (`my_novel_game/scenarios/my_novel_town.scenario`):
|
||||
|
||||
```scenario
|
||||
scene: my_novel_town
|
||||
priority: 10
|
||||
---
|
||||
# Город — хаб: при каждом визите игрок видит один и тот же выбор.
|
||||
text "Вечерний город. Фонари уже горят, по мостовой тянет прохладой." key=my_novel/town/intro
|
||||
select "Куда пойти?" key=my_novel/town/prompt
|
||||
option "Зайти в бар" key=my_novel/town/opt_bar -> :bar
|
||||
option "Вернуться домой" key=my_novel/town/opt_home -> :home
|
||||
|
||||
:bar
|
||||
switch_scene my_novel_bar
|
||||
end
|
||||
|
||||
:home
|
||||
switch_scene my_novel_home
|
||||
end
|
||||
```
|
||||
|
||||
- **Заголовок** над `---` говорит, когда сценарий играет: `scene:` называет сцену, `priority:` упорядочивает несколько сценариев одной сцены (с меньшим числом играет первым). Ниже встречаются и другие строки заголовка.
|
||||
- `text "…"` показывает реплику и ждёт щелчка. `key=` — ключ перевода реплики; текст в кавычках показывается, если перевода не нашлось.
|
||||
- `select` задаёт вопрос, и каждый `option` — вариант ответа, который ведёт к **метке** (`-> :bar`).
|
||||
- `:bar` — метка; `switch_scene` уходит в другую сцену; `end` завершает сценарий.
|
||||
- Строка, начинающаяся с `#`, — заметка для автора.
|
||||
|
||||
Чтобы добавить историю в сцену, положите файл `.scenario` в любое место папки `scenarios/` своего мода и назовите сцену в заголовке.
|
||||
|
||||
## Как писать историю
|
||||
|
||||
**Реплики и портреты.** `text "…" first=marao/sad` показывает портрет на первом месте, `second=…` — на втором (см. Characters Engine). `ptext` делает то же, что `text`, и вдобавок подставляет вместо `${name}` значение переменной. `title "…"` показывает заголовок главы.
|
||||
|
||||
**Выбор и переходы.** Вариант ответа можно показывать только при выполнении условия: `option "Pay" "if=item('money/coin') >= 5" -> :pay` (условие с пробелами берётся в кавычки вместе с `if=`). `goto -> :label` перескакивает без вопросов. `when "<condition>" -> :label` выполняет переход, если условие выполнено в этот момент:
|
||||
|
||||
```scenario
|
||||
when "rpg_wolf_dead == 1" -> :lantern
|
||||
```
|
||||
|
||||
**Запоминание.** `flag rpg_quest_taken 1` ставит сюжетный флаг, который сохраняется вместе с игрой; условия читают его как `rpg_quest_taken == 1`. `set name value` задаёт переменную текущего диалога: `ptext` покажет её как `${name}`, а действия смогут её прочитать.
|
||||
|
||||
**Условия** — один общий язык: флаги, `item('id')` из Items Base, проверки заданий из Quests Engine, характеристики и экипировка из своих модов, соединённые через `&&`, `||` и `!`.
|
||||
|
||||
**Сцена.** `background`, `foreground`, `background_color`, `music`, `sound`, `effect`, `delay`, `light_set`, `hide_dialog`/`show_dialog`, `interactive_add`/`interactive_remove`, `notify`.
|
||||
|
||||
**Игровые действия.** `action <name> key=value …` запускает действие другого мода, например `action item.add id=money/coin count=3` или `action quest.set_status quest_id=woodland_ward status=Progress`. Все действия перечислены в schema-файлах модов, а Editor Tools предлагает их в редакторе сценариев и палитре команд.
|
||||
|
||||
## Когда сценарий запускается
|
||||
|
||||
Решает заголовок:
|
||||
|
||||
```scenario
|
||||
scene: prolog_alley
|
||||
priority: 15
|
||||
condition: AwakeningQuest.notHasTag("cloak_taken")
|
||||
is_one_run: true
|
||||
save_allowed: true
|
||||
---
|
||||
```
|
||||
|
||||
- `scene:` — сцена, в которой сценарий играет, когда игрок приходит.
|
||||
- `priority:` — порядок среди сценариев одной сцены; первым играет тот, у кого наименьшее допустимое число, а следующий стартует, когда диалог закончится.
|
||||
- `condition:` — сценарий играет, только пока условие выполнено; когда флаг или задание меняется, сцена проверяет снова.
|
||||
- `is_one_run: true` — играется один раз за игру.
|
||||
- `after:` — ждёт, пока названный сценарий не будет пройден.
|
||||
- `save_allowed: true` — в этой сцене можно сохраняться.
|
||||
|
||||
Сценарий без строки `scene:` не запускается сценой — его запускает что-то другое: например, щелчок по интерактивному объекту или событие на карте.
|
||||
|
||||
## Чужие моды добавляют и заменяют сценарии
|
||||
|
||||
Сценарии всех модов собираются в общий набор. Добавить историю в чужую сцену просто: назовите эту сцену в заголовке. А мод, который зависит от владельца и кладёт в себя сценарий с тем же именем файла, заменяет его.
|
||||
|
||||
## Если что-то пошло не так
|
||||
|
||||
1. **Сценарий никогда не играет.** Ошибочное имя в `scene:`, ложное условие в `condition` — или у сценария есть `is_one_run`, и он уже играл.
|
||||
2. **Реплика показывается не на том языке.** Ключа `key=` нет в файлах `locale` мода для этого языка, и вместо перевода показывается текст в кавычках.
|
||||
3. **Ответ ведёт в никуда.** Метка после `->` должна существовать в том же файле и записываться с двоеточием (`:bar`).
|
||||
4. **`action` ничего не делает.** Мод — владелец действия не входит в игру (в логе написано, что действие "is not registered"), или имя параметра неверное — сверьте его с действием в редакторе сценариев Editor Tools.
|
||||
+99
@@ -0,0 +1,99 @@
|
||||
# Dialog Engine — hộp hội thoại và ngôn ngữ kịch bản
|
||||
|
||||
Dialog Engine là mọi thứ người chơi đọc và nhấp vào: hộp hội thoại với các câu thoại, chân dung và phương án trả lời. Đằng sau đó là **ngôn ngữ kịch bản** — những tệp văn bản `.scenario` nhỏ, nơi câu chuyện được viết từng dòng: ai nói gì, có những lựa chọn nào, mỗi lựa chọn dẫn đi đâu, và chuyện gì xảy ra trong game (đổi nền, bật nhạc, thêm vật phẩm, tiến nhiệm vụ, sang cảnh khác). Mọi trò chơi trong bộ sưu tập, từ mẫu truyện đến RPG Plus, đều kể câu chuyện của mình bằng ngôn ngữ này.
|
||||
|
||||
## Những gì người chơi nhìn thấy
|
||||
|
||||
Kịch bản của một cảnh tự bắt đầu khi người chơi bước vào. Các câu thoại hiện trong hộp ở đáy màn hình; mỗi cú nhấp hiện câu tiếp theo.
|
||||
|
||||
|
||||
|
||||
Khi câu chuyện hỏi điều gì đó, các lựa chọn hiện ra bên phải, và câu chuyện chờ cho đến khi người chơi chọn xong.
|
||||
|
||||
|
||||
|
||||
"Ghé vào quán bar" đưa người chơi sang cảnh quán bar, nơi bắt đầu kịch bản riêng của nó.
|
||||
|
||||
|
||||
|
||||
## Kịch bản đứng sau những hình này
|
||||
|
||||
Đây là toàn bộ kịch bản thị trấn của mẫu truyện (`my_novel_game/scenarios/my_novel_town.scenario`).
|
||||
|
||||
```scenario
|
||||
scene: my_novel_town
|
||||
priority: 10
|
||||
---
|
||||
# Thị trấn là điểm tụ: lần nào ghé thăm cũng thấy cùng một lựa chọn.
|
||||
text "Buổi chiều ở thị trấn. Đèn đường đã sáng, một cơn gió mát thổi qua đường lát đá." key=my_novel/town/intro
|
||||
select "Đi đâu đây?" key=my_novel/town/prompt
|
||||
option "Ghé vào quán bar" key=my_novel/town/opt_bar -> :bar
|
||||
option "Về nhà" key=my_novel/town/opt_home -> :home
|
||||
|
||||
:bar
|
||||
switch_scene my_novel_bar
|
||||
end
|
||||
|
||||
:home
|
||||
switch_scene my_novel_home
|
||||
end
|
||||
```
|
||||
|
||||
- **Phần đầu** phía trên `---` cho biết kịch bản chạy khi nào: `scene:` nêu tên cảnh, `priority:` sắp thứ tự cho nhiều kịch bản của cùng một cảnh (số nhỏ chạy trước). Bên dưới còn vài dòng đầu khác sẽ được giới thiệu.
|
||||
- `text "…"` hiện một câu thoại và chờ cú nhấp. `key=` là khóa dịch của câu thoại; văn bản trong ngoặc kép được hiển thị khi không tìm thấy bản dịch.
|
||||
- `select` đặt một câu hỏi, mỗi `option` là một lựa chọn nhảy tới một **nhãn** (`-> :bar`).
|
||||
- `:bar` là nhãn; `switch_scene` chuyển sang cảnh khác; `end` kết thúc kịch bản.
|
||||
- Dòng bắt đầu bằng `#` là ghi chú dành cho tác giả.
|
||||
|
||||
Muốn thêm câu chuyện vào một cảnh, bạn chỉ cần đặt tệp `.scenario` vào bất kỳ đâu trong thư mục `scenarios/` của mod và nêu tên cảnh trong phần đầu.
|
||||
|
||||
## Viết câu chuyện
|
||||
|
||||
**Câu thoại và chân dung.** `text "…" first=marao/sad` hiện chân dung ở vị trí thứ nhất, `second=…` ở vị trí thứ hai (xem Characters Engine). `ptext` giống `text` và thay thêm `${name}` bằng giá trị của biến. `title "…"` hiện tiêu đề chương.
|
||||
|
||||
**Lựa chọn và bước nhảy.** Có thể chỉ hiện một lựa chọn khi điều kiện thỏa mãn: `option "Pay" "if=item('money/coin') >= 5" -> :pay` (điều kiện có dấu cách thì bọc cả `if=` trong ngoặc kép). `goto -> :label` nhảy luôn không hỏi. `when "<condition>" -> :label` nhảy nếu điều kiện thỏa tại thời điểm đó.
|
||||
|
||||
```scenario
|
||||
when "rpg_wolf_dead == 1" -> :lantern
|
||||
```
|
||||
|
||||
**Ghi nhớ thông tin.** `flag rpg_quest_taken 1` đặt một cờ cốt truyện được lưu cùng game; điều kiện đọc nó dưới dạng `rpg_quest_taken == 1`. `set name value` đặt biến của phiên hội thoại đang chạy: `ptext` hiển thị nó dưới dạng `${name}` và các hành động cũng đọc được.
|
||||
|
||||
**Điều kiện** là một ngôn ngữ chung: cờ, `item('id')` từ Items Base, phép kiểm tra nhiệm vụ từ Quests Engine, chỉ số và trang bị từ mod tương ứng, nối với nhau bằng `&&`, `||` và `!`.
|
||||
|
||||
**Tổ chức cảnh.** `background`, `foreground`, `background_color`, `music`, `sound`, `effect`, `delay`, `light_set`, `hide_dialog`/`show_dialog`, `interactive_add`/`interactive_remove`, `notify`.
|
||||
|
||||
**Hành động của game.** `action <name> key=value …` chạy một hành động của mod khác, ví dụ `action item.add id=money/coin count=3` hay `action quest.set_status quest_id=woodland_ward status=Progress`. Các tệp schema của mod liệt kê hành động, còn Editor Tools đưa chúng vào trình soạn thảo kịch bản và bảng lệnh.
|
||||
|
||||
## Khi nào kịch bản chạy
|
||||
|
||||
Phần đầu quyết định điều đó.
|
||||
|
||||
```scenario
|
||||
scene: prolog_alley
|
||||
priority: 15
|
||||
condition: AwakeningQuest.notHasTag("cloak_taken")
|
||||
is_one_run: true
|
||||
save_allowed: true
|
||||
---
|
||||
```
|
||||
|
||||
- `scene:` — cảnh mà kịch bản chạy khi người chơi tới.
|
||||
- `priority:` — thứ tự giữa các kịch bản của cùng một cảnh; số nhỏ nhất được phép chạy sẽ chạy trước, kịch bản kế tiếp bắt đầu khi hội thoại kết thúc.
|
||||
- `condition:` — chỉ chạy khi điều kiện còn thỏa mãn; khi cờ hoặc nhiệm vụ đổi, cảnh sẽ kiểm tra lại.
|
||||
- `is_one_run: true` — chỉ chạy một lần mỗi ván chơi.
|
||||
- `after:` — chờ cho đến khi kịch bản được nêu đã chạy xong.
|
||||
- `save_allowed: true` — người chơi được lưu trong cảnh này.
|
||||
|
||||
Kịch bản không có dòng `scene:` thì không do cảnh khởi chạy; nó do thứ khác chạy, chẳng hạn cú nhấp vào vật thể tương tác hay sự kiện bản đồ.
|
||||
|
||||
## Mod khác thêm và thay thế kịch bản
|
||||
|
||||
Kịch bản của mọi mod được gom chung với nhau. Một mod thêm câu chuyện vào cảnh của mod khác đơn giản chỉ bằng cách nêu tên cảnh đó. Mod phụ thuộc vào mod khác và kèm theo một tệp kịch bản trùng tên sẽ thay thế tệp ấy.
|
||||
|
||||
## Khi có trục trặc
|
||||
|
||||
1. **Kịch bản không bao giờ chạy.** Tên trong `scene:` sai, `condition` sai, hoặc kịch bản có `is_one_run` và đã chạy rồi.
|
||||
2. **Câu thoại hiện sai ngôn ngữ.** Thiếu khóa `key=` trong các tệp `locale` của mod cho ngôn ngữ đó; văn bản trong ngoặc kép được hiển thị thay thế.
|
||||
3. **Lựa chọn dẫn đến hư không.** Nhãn sau `->` phải tồn tại trong cùng tệp, viết kèm dấu hai chấm (`:bar`).
|
||||
4. **`action` không làm gì cả.** Mod sở hữu hành động không có trong game (log ghi hành động "is not registered"), hoặc tên tham số sai — hãy so với hành động trong trình soạn thảo kịch bản của Editor Tools.
|
||||
+99
@@ -0,0 +1,99 @@
|
||||
# Dialog Engine — 对话框与剧本语言
|
||||
|
||||
Dialog Engine 负责玩家阅读和点击的一切：带台词、肖像和选项的对话框。它背后是**剧本语言**——一些简短的 `.scenario` 文本文件，故事在其中一行一行地写下来：谁说了什么、有哪些选项、每个选项通向哪里、游戏里会发生什么（换背景、放音乐、给物品、推进任务、切换场景）。合集里的每一款游戏，从小说模板到 RPG Plus，都用它讲述自己的故事。
|
||||
|
||||
## 玩家看到什么
|
||||
|
||||
进入场景时，场景的剧本会自动开始。台词出现在屏幕下方的对话框里，点击一下就显示下一句：
|
||||
|
||||
|
||||
|
||||
当故事向玩家提问时，选项会出现在右侧，并等待玩家做出选择：
|
||||
|
||||
|
||||
|
||||
选择"去酒吧"后，玩家来到酒吧场景，那里开始播放自己的剧本：
|
||||
|
||||
|
||||
|
||||
## 这些截图背后的剧本
|
||||
|
||||
这就是小说模板小镇场景的完整剧本（`my_novel_game/scenarios/my_novel_town.scenario`）：
|
||||
|
||||
```scenario
|
||||
scene: my_novel_town
|
||||
priority: 10
|
||||
---
|
||||
# 小镇是枢纽：每次到访都显示同样的选择。
|
||||
text "傍晚的小镇。路灯已经亮起，石板路上吹过一阵凉风。" key=my_novel/town/intro
|
||||
select "接下来去哪儿？" key=my_novel/town/prompt
|
||||
option "去酒吧" key=my_novel/town/opt_bar -> :bar
|
||||
option "回家" key=my_novel/town/opt_home -> :home
|
||||
|
||||
:bar
|
||||
switch_scene my_novel_bar
|
||||
end
|
||||
|
||||
:home
|
||||
switch_scene my_novel_home
|
||||
end
|
||||
```
|
||||
|
||||
- `---` 之上的**头部**说明剧本何时播放：`scene:` 指明场景，`priority:` 排定同一场景多个剧本的先后（数字小的先播）。后文还会介绍其他头部行。
|
||||
- `text "…"` 显示一句台词并等待点击。`key=` 是这句台词的翻译键；引号里的文本在找不到翻译时显示。
|
||||
- `select` 提出一个问题，每个 `option` 都是一个选项，跳转到某个**标签**（`-> :bar`）。
|
||||
- `:bar` 是标签；`switch_scene` 切换到另一场景；`end` 结束剧本。
|
||||
- 以 `#` 开头的行是给作者看的注释。
|
||||
|
||||
要给场景添加故事，只需把 `.scenario` 文件放进自己 mod 的 `scenarios/` 文件夹（位置不限），并在头部写明场景名。
|
||||
|
||||
## 编写故事
|
||||
|
||||
**台词与肖像。** `text "…" first=marao/sad` 在第一个位置显示肖像，`second=…` 在第二个位置（参见 Characters Engine）。`ptext` 与 `text` 相同，还会把 `${name}` 替换为变量的值。`title "…"` 显示章节标题。
|
||||
|
||||
**选项与跳转。** 选项可以只在条件成立时显示：`option "Pay" "if=item('money/coin') >= 5" -> :pay`（条件里有空格时，连 `if=` 一起加引号）。`goto -> :label` 不作询问直接跳转。`when "<condition>" -> :label` 在条件此刻成立时跳转：
|
||||
|
||||
```scenario
|
||||
when "rpg_wolf_dead == 1" -> :lantern
|
||||
```
|
||||
|
||||
**记住状态。** `flag rpg_quest_taken 1` 设置一个随游戏存档保存的剧情标记；条件写作 `rpg_quest_taken == 1` 即可读取。`set name value` 设置当前对话的变量：`ptext` 把它显示为 `${name}`，动作也能读取它。
|
||||
|
||||
**条件**是一门统一的语言：标记、来自 Items Base 的 `item('id')`、来自 Quests Engine 的任务检查、各 mod 自带的属性与装备，用 `&&`、`||` 和 `!` 组合起来。
|
||||
|
||||
**场景演出。** `background`、`foreground`、`background_color`、`music`、`sound`、`effect`、`delay`、`light_set`、`hide_dialog`/`show_dialog`、`interactive_add`/`interactive_remove`、`notify`。
|
||||
|
||||
**游戏动作。** `action <name> key=value …` 执行另一个 mod 的动作，例如 `action item.add id=money/coin count=3` 或 `action quest.set_status quest_id=woodland_ward status=Progress`。各 mod 的 schema 文件列出了这些动作，Editor Tools 会在剧本编辑器和命令面板中提供它们。
|
||||
|
||||
## 剧本何时播放
|
||||
|
||||
这由头部决定：
|
||||
|
||||
```scenario
|
||||
scene: prolog_alley
|
||||
priority: 15
|
||||
condition: AwakeningQuest.notHasTag("cloak_taken")
|
||||
is_one_run: true
|
||||
save_allowed: true
|
||||
---
|
||||
```
|
||||
|
||||
- `scene:` — 玩家到达时播放剧本的场景。
|
||||
- `priority:` — 同一场景中各剧本的先后顺序；可播放的编号最小者先播，对话结束后下一个才开始。
|
||||
- `condition:` — 仅在条件成立时播放；标记或任务发生变化时，场景会重新检查。
|
||||
- `is_one_run: true` — 每局游戏只播放一次。
|
||||
- `after:` — 等待指定剧本播放完毕。
|
||||
- `save_allowed: true` — 玩家可以在该场景存档。
|
||||
|
||||
没有 `scene:` 头部的剧本不会由场景启动，而是由其他东西触发，比如点击场景中的交互物或地图事件。
|
||||
|
||||
## 其他 mod 的添加与替换
|
||||
|
||||
所有 mod 的剧本汇总在一起。mod 只要在头部写明场景名，就能把自己的故事加进别人的场景。声明了依赖并附带同名剧本文件的 mod 会替换原剧本。
|
||||
|
||||
## 出问题时
|
||||
|
||||
1. **剧本从不播放。** `scene:` 的场景名写错了、`condition` 为假，或者剧本带 `is_one_run` 且已经播放过。
|
||||
2. **台词显示成了别的语言。** 该语言的翻译键 `key=` 在 mod 的 `locale` 文件里缺失，于是显示引号里的原文。
|
||||
3. **选项跳了个空。** `->` 后面的标签必须存在于同一文件中，并带冒号（`:bar`）。
|
||||
4. **`action` 没有反应。** 动作所属的 mod 不在游戏内（日志提示动作 "is not registered"），或者参数名写错——与 Editor Tools 剧本编辑器中的动作对照一下。
|
||||
Reference in new issue
Block a user