@liminalia/runtime 0.0.0-stage → 0.8.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +106 -0
- package/dist/src/chat.js +60 -0
- package/dist/src/commands-play.js +300 -0
- package/dist/src/commands.js +534 -0
- package/dist/src/coverage.js +208 -0
- package/dist/src/headless.js +109 -0
- package/dist/src/host.js +1 -0
- package/dist/src/index.js +15 -0
- package/dist/src/prefetch.js +80 -0
- package/dist/src/program.js +131 -0
- package/dist/src/project-options.js +84 -0
- package/dist/src/retranslate.js +44 -0
- package/dist/src/route.js +242 -0
- package/dist/src/runtime.js +1929 -0
- package/dist/src/save.js +51 -0
- package/dist/src/scenario-test.js +200 -0
- package/dist/src/state.js +62 -0
- package/dist/src/value.js +464 -0
- package/dist/src/voice-observe.js +82 -0
- package/package.json +33 -4
- package/src/chat.ts +109 -0
- package/src/commands-play.ts +280 -0
- package/src/commands.ts +457 -0
- package/src/coverage.ts +257 -0
- package/src/headless.ts +139 -0
- package/src/host.ts +116 -0
- package/src/index.ts +16 -0
- package/src/prefetch.ts +78 -0
- package/src/program.ts +186 -0
- package/src/project-options.ts +128 -0
- package/src/retranslate.ts +67 -0
- package/src/route.ts +365 -0
- package/src/runtime.ts +2143 -0
- package/src/save.ts +60 -0
- package/src/scenario-test.ts +218 -0
- package/src/state.ts +353 -0
- package/src/value.ts +443 -0
- package/src/voice-observe.ts +85 -0
- package/types/src/chat.d.ts +63 -0
- package/types/src/commands-play.d.ts +2 -0
- package/types/src/commands.d.ts +2 -0
- package/types/src/coverage.d.ts +100 -0
- package/types/src/headless.d.ts +77 -0
- package/types/src/host.d.ts +140 -0
- package/types/src/index.d.ts +16 -0
- package/types/src/prefetch.d.ts +18 -0
- package/types/src/program.d.ts +107 -0
- package/types/src/project-options.d.ts +103 -0
- package/types/src/retranslate.d.ts +39 -0
- package/types/src/route.d.ts +181 -0
- package/types/src/runtime.d.ts +553 -0
- package/types/src/save.d.ts +21 -0
- package/types/src/scenario-test.d.ts +43 -0
- package/types/src/state.d.ts +357 -0
- package/types/src/value.d.ts +61 -0
- package/types/src/voice-observe.d.ts +26 -0
- package/README.md +0 -3
package/src/save.ts
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import type { SaveData } from "./state.ts";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* セーブデータの版。セーブの形(SaveData や舞台の状態)を、古いセーブがそのまま読めない形に変えたら一つ上げ、
|
|
5
|
+
* MIGRATIONS の末尾に「一つ前の版 → この版」の変換を足す。変換は消さない(どれだけ古いセーブも順にたどって今の版にする)。
|
|
6
|
+
* 項目を足すだけで、無ければ既定で補える変更(読み込み時に補う)は版を上げない。
|
|
7
|
+
*/
|
|
8
|
+
export const SAVE_VERSION = 1;
|
|
9
|
+
|
|
10
|
+
type Raw = Record<string, unknown>;
|
|
11
|
+
|
|
12
|
+
/** MIGRATIONS[i] は版 i + 1 のセーブを版 i + 2 にする。 */
|
|
13
|
+
const MIGRATIONS: readonly ((save: Raw) => Raw)[] = [];
|
|
14
|
+
|
|
15
|
+
/** 読めないセーブの理由。newer: この版のゲームより新しいゲームで作られた。broken: セーブの形をしていない・変換の途中で壊れた。 */
|
|
16
|
+
export type SaveProblem = "newer" | "broken";
|
|
17
|
+
|
|
18
|
+
export class SaveVersionError extends Error {
|
|
19
|
+
constructor(
|
|
20
|
+
readonly problem: SaveProblem,
|
|
21
|
+
message: string,
|
|
22
|
+
) {
|
|
23
|
+
super(message);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/** セーブを今の版にする。読めなければ SaveVersionError。元の値は変えない。 */
|
|
28
|
+
export function migrateSave(raw: unknown): SaveData {
|
|
29
|
+
return migrateWith(raw, MIGRATIONS, SAVE_VERSION) as unknown as SaveData;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/** 読めないセーブなら理由、読めるなら null(ロードの前に知らせるため)。 */
|
|
33
|
+
export function saveProblem(raw: unknown): SaveProblem | null {
|
|
34
|
+
try {
|
|
35
|
+
migrateSave(raw);
|
|
36
|
+
return null;
|
|
37
|
+
} catch (e) {
|
|
38
|
+
return e instanceof SaveVersionError ? e.problem : "broken";
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/** 変換の連なりをたどる(テストのため変換と今の版を渡せる)。 */
|
|
43
|
+
export function migrateWith(raw: unknown, migrations: readonly ((save: Raw) => Raw)[], current: number): Raw {
|
|
44
|
+
if (!isRaw(raw) || !isRaw(raw.position) || typeof raw.position.unit !== "string") throw new SaveVersionError("broken", "セーブデータの形をしていません");
|
|
45
|
+
const version = raw.version;
|
|
46
|
+
if (typeof version !== "number" || !Number.isInteger(version) || version < 1) throw new SaveVersionError("broken", `セーブデータのバージョン(${String(version)})を読み込めません`);
|
|
47
|
+
if (version > current) throw new SaveVersionError("newer", `新しいバージョンのゲームで作られたセーブデータです(セーブデータのバージョン ${version}、このゲームは ${current} まで対応)`);
|
|
48
|
+
let save: Raw = structuredClone(raw);
|
|
49
|
+
for (let v = version; v < current; v++) {
|
|
50
|
+
const step = migrations[v - 1];
|
|
51
|
+
if (!step) throw new SaveVersionError("broken", `バージョン ${v} のセーブデータを ${v + 1} に変換する処理がありません`);
|
|
52
|
+
save = step(save);
|
|
53
|
+
save.version = v + 1;
|
|
54
|
+
}
|
|
55
|
+
return save;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
function isRaw(v: unknown): v is Raw {
|
|
59
|
+
return typeof v === "object" && v !== null && !Array.isArray(v);
|
|
60
|
+
}
|
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
import { endingKinds, endingLabel, endingMatches, endingRef, parse, parseExpr, parseTargetText, variablePaths, type Diagnostic, type EndingRef, type Expr, type ScenarioTest } from "@liminalia/lang";
|
|
2
|
+
import { HeadlessHost, type TraceEntry } from "./headless.ts";
|
|
3
|
+
import { Runtime, type RunResult, type RuntimeOptions } from "./runtime.ts";
|
|
4
|
+
import type { SaveData } from "./state.ts";
|
|
5
|
+
import { display, evaluate, EvalError, truthy, type Value } from "./value.ts";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* 台本の自動テスト(@liminalia/lang の ScenarioTest)を画面なしで流し、期待(expect)を確かめる。ブラウザでも Node でも動く(lim test)。
|
|
9
|
+
* 実行時のエラーは、expect no-errors を書かなくても失敗にする。
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
export interface ScenarioTestOptions {
|
|
13
|
+
loadSource(file: string): Promise<string>;
|
|
14
|
+
/** 実行器の設定(話者・作品の命令・変数の初期値など)。onStep はテストが使うので渡さない。 */
|
|
15
|
+
runtime?: Omit<RuntimeOptions, "onStep" | "seed">;
|
|
16
|
+
/** from を書かないテストの開始位置(liminalia.json の entry)。 */
|
|
17
|
+
entry: string;
|
|
18
|
+
/** from-state のファイルを読む(パスはテストのファイルに書いたまま)。読めなければ例外。 */
|
|
19
|
+
readState?(path: string): unknown;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/** 失敗一つ。line はテストのファイルの行。diagnostic は実行時の診断から来たもの(英語にするため)。 */
|
|
23
|
+
export interface TestFailure {
|
|
24
|
+
line: number;
|
|
25
|
+
ja: string;
|
|
26
|
+
en: string;
|
|
27
|
+
diagnostic?: Diagnostic;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export interface ScenarioTestResult {
|
|
31
|
+
name: string;
|
|
32
|
+
line: number;
|
|
33
|
+
ok: boolean;
|
|
34
|
+
failures: TestFailure[];
|
|
35
|
+
result: RunResult;
|
|
36
|
+
/** 出したページの数と、選んだ選択肢(文の並びと選んだ番号。0 始まり)。 */
|
|
37
|
+
pages: number;
|
|
38
|
+
choices: { options: string[]; selected: number | null }[];
|
|
39
|
+
/** 終わったときのゲームの変数。 */
|
|
40
|
+
game: Record<string, Value>;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/** テストの既定のページ数の上限(これに達したら、終わらないテストとして失敗にする)。 */
|
|
44
|
+
export const DEFAULT_TEST_LIMIT = 5000;
|
|
45
|
+
|
|
46
|
+
export async function runScenarioTest(test: ScenarioTest, o: ScenarioTestOptions): Promise<ScenarioTestResult> {
|
|
47
|
+
const failures: TestFailure[] = [];
|
|
48
|
+
const fail = (line: number, ja: string, en: string, diagnostic?: Diagnostic) => failures.push({ line, ja, en, ...(diagnostic ? { diagnostic } : {}) });
|
|
49
|
+
const limit = test.limit ?? DEFAULT_TEST_LIMIT;
|
|
50
|
+
const host = new HeadlessHost({ loadSource: (f) => o.loadSource(f), choices: test.choices.map((c) => c.pick), whenChoicesRunOut: test.rest, maxPages: limit });
|
|
51
|
+
const reached = new Set<string>();
|
|
52
|
+
const files = new Set<string>();
|
|
53
|
+
const runtime = new Runtime(host, {
|
|
54
|
+
...o.runtime,
|
|
55
|
+
seed: test.seed ?? 1,
|
|
56
|
+
onStep: (at) => {
|
|
57
|
+
reached.add(`${at.file}:${at.line}`);
|
|
58
|
+
files.add(at.file);
|
|
59
|
+
},
|
|
60
|
+
});
|
|
61
|
+
let limited = false;
|
|
62
|
+
host.onLimit = () => {
|
|
63
|
+
limited = true;
|
|
64
|
+
runtime.stop();
|
|
65
|
+
};
|
|
66
|
+
const value = (src: { value: Expr; source: string; line: number }): Value | undefined => {
|
|
67
|
+
try {
|
|
68
|
+
return evaluate(src.value, { lookup: () => null, random: () => 0 });
|
|
69
|
+
} catch (e) {
|
|
70
|
+
fail(src.line, `set の式を求められません: ${e instanceof Error ? e.message : String(e)}`, `Can't evaluate the set expression: ${src.source}`);
|
|
71
|
+
return undefined;
|
|
72
|
+
}
|
|
73
|
+
};
|
|
74
|
+
// 始める前の値(system は実行器に、game と temp は始めるときに入れる)
|
|
75
|
+
const start: Record<string, Value> = {};
|
|
76
|
+
for (const s of test.sets) {
|
|
77
|
+
const v = value(s);
|
|
78
|
+
if (v === undefined) continue;
|
|
79
|
+
if (s.path.startsWith("system.")) runtime.setVariable(s.path, v);
|
|
80
|
+
else start[s.path] = v;
|
|
81
|
+
}
|
|
82
|
+
let result: RunResult;
|
|
83
|
+
if (test.fromState !== undefined) {
|
|
84
|
+
let save: SaveData;
|
|
85
|
+
try {
|
|
86
|
+
const raw = o.readState?.(test.fromState) as { save?: SaveData } & Partial<SaveData>;
|
|
87
|
+
save = structuredClone((raw && typeof raw === "object" && raw.save ? raw.save : raw) as SaveData);
|
|
88
|
+
if (!save || typeof save !== "object" || !save.position) throw new Error("セーブの形ではありません");
|
|
89
|
+
} catch (e) {
|
|
90
|
+
fail(test.line, `from-state ${test.fromState} を読めません(${e instanceof Error ? e.message : String(e)})`, `Can't read from-state ${test.fromState}`);
|
|
91
|
+
return { name: test.name, line: test.line, ok: false, failures, result: { reason: "error", at: { unit: "", index: 0 }, message: "from-state" }, pages: 0, choices: [], game: {} };
|
|
92
|
+
}
|
|
93
|
+
for (const [path, v] of Object.entries(start)) {
|
|
94
|
+
if (path.startsWith("temp.")) runtime.setVariable(path, v);
|
|
95
|
+
else setPath(save.game, path.slice("game.".length), v);
|
|
96
|
+
}
|
|
97
|
+
result = await runtime.load(save);
|
|
98
|
+
} else {
|
|
99
|
+
result = await runtime.start(test.from ?? o.entry, { variables: start });
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
const trace = host.trace;
|
|
103
|
+
const pages = trace.flatMap((t) => (t.type === "page" ? [t] : []));
|
|
104
|
+
const choices = trace.flatMap((t) => (t.type === "choice" ? [{ options: t.options, selected: t.selected }] : []));
|
|
105
|
+
// 選ぶ文が無かった選択肢と、使わなかった choose の行
|
|
106
|
+
let made = 0;
|
|
107
|
+
for (const [i, t] of trace.entries()) {
|
|
108
|
+
if (t.type === "choice") made++;
|
|
109
|
+
if (t.type === "diagnostic" && t.diagnostic.code === "unknown-option") {
|
|
110
|
+
const c = test.choices[made];
|
|
111
|
+
// 並んでいた選択肢(診断のすぐ後の選択の記録)。日本語の文は診断に入っている
|
|
112
|
+
const shown = trace.slice(i + 1).find((x) => x.type === "choice");
|
|
113
|
+
const options = shown?.type === "choice" ? ` (${shown.options.join(" / ")})` : "";
|
|
114
|
+
fail(c?.line ?? test.line, t.diagnostic.message, `The option to choose isn't there: ${String(c?.pick ?? "")}${options}`);
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
const unused = test.choices[Math.min(made, test.choices.length)];
|
|
118
|
+
if (made < test.choices.length && unused) fail(unused.line, `この choose を使う前に終わりました(選択肢は ${made} 回)`, `It ended before using this choose (${made} choices made)`);
|
|
119
|
+
// 実行時のエラーは、書かなくても失敗にする
|
|
120
|
+
const diagnostics = trace.flatMap((t) => (t.type === "diagnostic" && t.diagnostic.code !== "unknown-option" ? [t.diagnostic] : []));
|
|
121
|
+
for (const d of diagnostics.filter((x) => x.severity === "error")) fail(test.line, `実行時のエラー(${d.file}:${d.line}): ${d.message}`, `Runtime error (${d.file}:${d.line})`, d);
|
|
122
|
+
if (result.reason === "max-steps") fail(test.line, "命令の数の上限に達しました(終わらない繰り返しがないか確かめます)", "Reached the step limit (check for an endless loop)");
|
|
123
|
+
if (limited && test.limit === undefined) fail(test.line, `ページの数の上限(${limit})に達しました。終わらないなら choose を足すか、limit を書きます`, `Reached the page limit (${limit}). Add choose lines or write limit`);
|
|
124
|
+
|
|
125
|
+
for (const e of test.expects) {
|
|
126
|
+
switch (e.kind) {
|
|
127
|
+
case "expr": {
|
|
128
|
+
let v: Value;
|
|
129
|
+
try {
|
|
130
|
+
v = runtime.eval(e.expr);
|
|
131
|
+
} catch (err) {
|
|
132
|
+
if (!(err instanceof EvalError)) throw err;
|
|
133
|
+
fail(e.line, `expect ${e.source} を求められません: ${err.message}`, `Can't evaluate expect ${e.source}`);
|
|
134
|
+
break;
|
|
135
|
+
}
|
|
136
|
+
if (!truthy(v)) {
|
|
137
|
+
const values = [...new Set(variablePaths(e.expr))].map((p) => `${p} = ${shown(runtime.eval(parseExpr(p)))}`);
|
|
138
|
+
fail(e.line, `expect ${e.source} が偽です${values.length > 0 ? `(${values.join("、")})` : ""}`, `expect ${e.source} is false${values.length > 0 ? ` (${values.join(", ")})` : ""}`);
|
|
139
|
+
}
|
|
140
|
+
break;
|
|
141
|
+
}
|
|
142
|
+
case "reach": {
|
|
143
|
+
const hit = await reachedPlace(e.place, reached, files, o.loadSource);
|
|
144
|
+
if (hit === null) fail(e.line, `${e.place} はありません`, `${e.place} doesn't exist`);
|
|
145
|
+
else if (hit === e.not) fail(e.line, e.not ? `${e.place} を通りました` : `${e.place} を通りませんでした`, e.not ? `Went through ${e.place}` : `Didn't go through ${e.place}`);
|
|
146
|
+
break;
|
|
147
|
+
}
|
|
148
|
+
case "text": {
|
|
149
|
+
const found = pages.some((p) => p.text.includes(e.text) || (p.label ?? p.speaker ?? "").includes(e.text));
|
|
150
|
+
if (found === e.not) fail(e.line, e.not ? `「${e.text}」が出ました` : `「${e.text}」はどのページにも出ませんでした`, e.not ? `"${e.text}" was shown` : `"${e.text}" wasn't shown on any page`);
|
|
151
|
+
break;
|
|
152
|
+
}
|
|
153
|
+
case "ending": {
|
|
154
|
+
// 種類(bad など)で引く。種類でない文字は、エンディングの名前(title=。前の書き方なら書いた文言)に含むもの
|
|
155
|
+
const kinds = endingKinds(o.runtime?.endingKinds);
|
|
156
|
+
const endings = trace.flatMap((t): EndingRef[] => {
|
|
157
|
+
if (t.type !== "command" || runtime.registry.get(t.name)?.ends !== true) return [];
|
|
158
|
+
const ref = endingRef(t.args.ending, t.args.title, kinds);
|
|
159
|
+
return ref ? [ref] : [];
|
|
160
|
+
});
|
|
161
|
+
const seen = endings.map(endingLabel);
|
|
162
|
+
if (!endings.some((r) => endingMatches(r, e.name, kinds))) fail(e.line, `エンディング ${e.name} で終わりませんでした${seen.length > 0 ? `(${seen.join("、")})` : ""}`, `Didn't end with the ending ${e.name}${seen.length > 0 ? ` (${seen.join(", ")})` : ""}`);
|
|
163
|
+
break;
|
|
164
|
+
}
|
|
165
|
+
case "end": {
|
|
166
|
+
// プレイを終えるコマンド(@title-screen など)で止まったのも終わり(選択肢を使い切ったり、ページの上限で止めたりしたのとは分ける)
|
|
167
|
+
const last = trace.findLast((t) => t.type !== "diagnostic");
|
|
168
|
+
const endedByCommand = result.reason === "stopped" && !limited && last?.type === "command" && runtime.registry.get(last.name)?.ends === true;
|
|
169
|
+
if (result.reason !== "end" && !endedByCommand) fail(e.line, `台本の終わりまで流れませんでした(${result.reason})`, `Didn't run to the end of the script (${result.reason})`);
|
|
170
|
+
break;
|
|
171
|
+
}
|
|
172
|
+
case "no-errors":
|
|
173
|
+
// エラーは上で知らせている
|
|
174
|
+
break;
|
|
175
|
+
case "no-warnings":
|
|
176
|
+
for (const d of diagnostics.filter((x) => x.severity === "warning")) fail(e.line, `実行時の警告(${d.file}:${d.line}): ${d.message}`, `Runtime warning (${d.file}:${d.line})`, d);
|
|
177
|
+
break;
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
return { name: test.name, line: test.line, ok: failures.length === 0, failures, result, pages: pages.length, choices, game: structuredClone(runtime.state.game) };
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
/** 場所を通ったか(`ファイル`、`ファイル#ラベル`、`ファイル:行`)。ファイルかラベルが無ければ null。 */
|
|
184
|
+
async function reachedPlace(place: string, reached: ReadonlySet<string>, files: ReadonlySet<string>, loadSource: (file: string) => Promise<string>): Promise<boolean | null> {
|
|
185
|
+
const line = /^(.+):(\d+)$/.exec(place);
|
|
186
|
+
if (line) return reached.has(`${line[1]}:${line[2]}`);
|
|
187
|
+
const target = parseTargetText(place);
|
|
188
|
+
if (!target?.file) return null;
|
|
189
|
+
if (target.label === null) {
|
|
190
|
+
try {
|
|
191
|
+
await loadSource(target.file);
|
|
192
|
+
} catch {
|
|
193
|
+
return null;
|
|
194
|
+
}
|
|
195
|
+
return files.has(target.file);
|
|
196
|
+
}
|
|
197
|
+
let source: string;
|
|
198
|
+
try {
|
|
199
|
+
source = await loadSource(target.file);
|
|
200
|
+
} catch {
|
|
201
|
+
return null;
|
|
202
|
+
}
|
|
203
|
+
const label = parse(source, target.file).body.find((s) => s.kind === "label" && s.name === target.label);
|
|
204
|
+
return label ? reached.has(`${target.file}:${label.line}`) : null;
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
function setPath(root: Record<string, Value>, path: string, value: Value): void {
|
|
208
|
+
const parts = path.split(".");
|
|
209
|
+
let o = root;
|
|
210
|
+
for (const p of parts.slice(0, -1)) o = (o[p] && typeof o[p] === "object" && !Array.isArray(o[p]) ? o[p] : (o[p] = {})) as Record<string, Value>;
|
|
211
|
+
o[parts.at(-1)!] = value;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
function shown(v: Value): string {
|
|
215
|
+
return typeof v === "string" ? JSON.stringify(v) : v === null ? "null" : display(v);
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
export type { TraceEntry };
|
package/src/state.ts
ADDED
|
@@ -0,0 +1,353 @@
|
|
|
1
|
+
import type { TextStyle } from "./host.ts";
|
|
2
|
+
import type { TextOrigin } from "./retranslate.ts";
|
|
3
|
+
import type { Scope, Value } from "./value.ts";
|
|
4
|
+
import { SAVE_VERSION } from "./save.ts";
|
|
5
|
+
export { voiceFile } from "@liminalia/lang";
|
|
6
|
+
|
|
7
|
+
export interface Position {
|
|
8
|
+
/** Unit の id("chapter1" や "chapter1::title-card")。 */
|
|
9
|
+
unit: string;
|
|
10
|
+
/** 次に実行する命令の位置。 */
|
|
11
|
+
index: number;
|
|
12
|
+
/**
|
|
13
|
+
* セーブした場所の目印(本文・選択肢の行と、その文から作る鍵)。作品を更新して台本の行がずれても、
|
|
14
|
+
* ロードで同じページを探して再開する(Runtime.load)。セーブのときだけ付ける。
|
|
15
|
+
*/
|
|
16
|
+
anchor?: {
|
|
17
|
+
line: number;
|
|
18
|
+
key: string;
|
|
19
|
+
/** 呼び出しの戻り先の目印のとき、目印は戻り先の一つ前の命令(呼んだ命令。鍵は命令の名前と引数)。 */
|
|
20
|
+
after?: boolean;
|
|
21
|
+
};
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/** 吹き出しの置き方(@balloon on)。 */
|
|
25
|
+
export interface Balloon {
|
|
26
|
+
width?: number;
|
|
27
|
+
/** 話者の立ち絵が出ていないときに置く左上(px)。書かなければ、立ち絵の無い台詞はメッセージ枠で出す。 */
|
|
28
|
+
x?: number;
|
|
29
|
+
y?: number;
|
|
30
|
+
/** 尾の向き(立ち絵の無い吹き出しのもの。auto は下。立ち絵があれば立ち絵へ向ける)・尾を出さない(none)。 */
|
|
31
|
+
tail?: "auto" | "down" | "up" | "none";
|
|
32
|
+
/** 尾の位置(吹き出しの左端からの px)。書かなければ立ち絵の真ん中(立ち絵が無ければ吹き出しの真ん中)。 */
|
|
33
|
+
tailX?: number;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export interface Sprite {
|
|
37
|
+
/** 差分(表情・ポーズ)。 */
|
|
38
|
+
variant: string;
|
|
39
|
+
/** 立ち絵セット。空文字はキャストの既定(描画側が defaultAppearance → default → 最初のもの、の順に選ぶ)。 */
|
|
40
|
+
appearance: string;
|
|
41
|
+
/** 立ち位置。差分の枠の positions の名前か "auto"(auto の立ち絵どうしで横に並べる。並べ方は描画側が状態だけから決める)。 */
|
|
42
|
+
at: string;
|
|
43
|
+
/** 位置未指定で新しい自動配置に入った人物。明示位置の人物と区別し、セーブにも残す。 */
|
|
44
|
+
autoLayout?: boolean;
|
|
45
|
+
/**
|
|
46
|
+
* 自動配置の枠(何人の並びの左から何番目か)。新しく来た人物を入れる場所、退場しても動かさない並べ方、人物ごとの定位置を
|
|
47
|
+
* 使う作品だけが残す(@liminalia/lang の assignAutoSlots)。
|
|
48
|
+
*/
|
|
49
|
+
autoSlot?: { index: number; count: number };
|
|
50
|
+
flip: boolean;
|
|
51
|
+
/** 左端・上端の位置(px)。あれば at より優先する。 */
|
|
52
|
+
x?: number;
|
|
53
|
+
y?: number;
|
|
54
|
+
/** 大きさ(px)。あれば差分の大きさより優先する。 */
|
|
55
|
+
width?: number;
|
|
56
|
+
height?: number;
|
|
57
|
+
/** 重なり順(@chara の z)。大きいほど手前。同じなら出した順(挿入順)。省略は 0。 */
|
|
58
|
+
z?: number;
|
|
59
|
+
/**
|
|
60
|
+
* 立ち絵に付いた、プラグインの状態(std の @emote の漫符など)。@chara で差し替えても残り、立ち絵を消すと一緒に消える。
|
|
61
|
+
* 鍵はプラグインの名前を頭に付ける("std.emote")。
|
|
62
|
+
*/
|
|
63
|
+
extra?: Record<string, Value>;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
/** 音の鳴らし方(@bgm・@se のパラメータ)。ループの位置はミリ秒、pan は -100(左)〜100(右)、rate は再生速度(1 で等速)。 */
|
|
67
|
+
export interface SoundOptions {
|
|
68
|
+
loopStart?: number;
|
|
69
|
+
loopEnd?: number;
|
|
70
|
+
pan?: number;
|
|
71
|
+
rate?: number;
|
|
72
|
+
/** 音のフィルター(@bgm・@se の filter。こもり・電話・無線・広間)。 */
|
|
73
|
+
filter?: SoundFilterState;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/** 音のフィルター(type は muffled・phone・radio・hall、strength は 0〜100)。 */
|
|
77
|
+
export interface SoundFilterState {
|
|
78
|
+
type: string;
|
|
79
|
+
strength: number;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/** その話者のボイスに掛け続けているフィルター(@voice-filter。話者のものが無ければすべての話者のもの)。 */
|
|
83
|
+
export function voiceFilterFor(stage: Pick<StageState, "voiceFilter">, who: string | null): SoundFilterState | null {
|
|
84
|
+
const filters = stage.voiceFilter;
|
|
85
|
+
if (!filters) return null;
|
|
86
|
+
return (who !== null ? filters[who] : undefined) ?? filters[""] ?? null;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
/** 命令の filter・filter-strength を状態の形にする(none・書いていない・強さ 0 は null)。 */
|
|
90
|
+
export function filterArg(a: Readonly<Record<string, unknown>>): SoundFilterState | null {
|
|
91
|
+
if (typeof a.filter !== "string" || a.filter === "none") return null;
|
|
92
|
+
const strength = typeof a["filter-strength"] === "number" ? Math.max(0, Math.min(100, a["filter-strength"])) : 100;
|
|
93
|
+
return strength === 0 ? null : { type: a.filter, strength };
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/** 画面と音の状態。描画側はこれだけを見れば今の画面を組み立て直せる。 */
|
|
97
|
+
/** NVL の読み終えた段落の一片。 */
|
|
98
|
+
export type NvlPart = { text: string; ruby: string | null; style: TextStyle } | { br: true };
|
|
99
|
+
export interface NvlPage {
|
|
100
|
+
speaker: string | null;
|
|
101
|
+
label?: string;
|
|
102
|
+
parts: NvlPart[];
|
|
103
|
+
/**
|
|
104
|
+
* 本文の行の元(書いたファイル、原文、場面、{name …} の原文)。別の言語でロードしたときに、今の言語の本文と名前を作り直す
|
|
105
|
+
* (Runtime.retranslate)。前の版のセーブには無く、そのページは書いたときの言語のまま出す。
|
|
106
|
+
*/
|
|
107
|
+
origin?: { file: string; source: string; context?: string; name?: string; id?: string };
|
|
108
|
+
/**
|
|
109
|
+
* 本文の流れに出して選んだ選択肢(ui.choice.position が inline のとき。options は出した文、picked は選んだ番号)。
|
|
110
|
+
* @nvl の間は段落と同じく本文の一部として積まれるので、ロードで出し直す。
|
|
111
|
+
*/
|
|
112
|
+
choice?: { options: { text: string; origin?: TextOrigin }[]; picked: number };
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
export interface StageState {
|
|
116
|
+
background: string | null;
|
|
117
|
+
/** 単色の背景(@bg color=・@scene-change bg-color=。#rrggbb など)。background があればそちらが勝ち、背景の絵を出す命令で外れる。 */
|
|
118
|
+
backgroundColor?: string;
|
|
119
|
+
/**
|
|
120
|
+
* 奥行きのある背景の絵(@plane)。名前 → 絵(bgimage)と奥行き(0 は立ち絵と同じに動き、1 に近いほどカメラが動いても動かない。
|
|
121
|
+
* 負なら手前で、より大きく動く)。front は立ち絵より手前に置く。@bg で外れる。
|
|
122
|
+
*/
|
|
123
|
+
planes?: Record<string, { image: string; depth: number; front?: boolean }>;
|
|
124
|
+
/** 表示中の立ち絵。キーはキャスト名。重なり順は z、同じなら挿入順。 */
|
|
125
|
+
sprites: Record<string, Sprite>;
|
|
126
|
+
/** 立ち絵を表示していないキャラクターの、顔ウィンドウの表情(@face。立ち絵を消したときは消す前のもの)。キーはキャスト名。 */
|
|
127
|
+
faces?: Record<string, { appearance: string; variant: string }>;
|
|
128
|
+
/** @face で出した顔(ui.face の show が explicit のとき、これだけを出す)。@face-off で消える。 */
|
|
129
|
+
faceShown?: { who: string; appearance: string; variant: string };
|
|
130
|
+
/** メッセージウィンドウの背景の画像(@window-image)。省略は ui.message.image。 */
|
|
131
|
+
windowImage?: string;
|
|
132
|
+
/**
|
|
133
|
+
* paused は @pause-bgm で一時停止しているとき true。pausedAt は止めた位置(秒。描画側が書く)で、ロードしたあとの @resume-bgm はそこから続ける。
|
|
134
|
+
*/
|
|
135
|
+
bgm: ({ file: string; volume: number; loop: boolean; paused?: boolean; pausedAt?: number } & SoundOptions) | null;
|
|
136
|
+
/** ループ再生中の効果音(チャンネルごと)。単発の効果音は状態に残らない。 */
|
|
137
|
+
loopingSe: Record<string, { file: string; volume: number; paused?: boolean } & SoundOptions>;
|
|
138
|
+
window: boolean;
|
|
139
|
+
/** 暗転・場面転換などで、次の本文まで一時的に枠を隠している。@window hide とは別。 */
|
|
140
|
+
windowSuppressed?: boolean;
|
|
141
|
+
/** @window hide で消したまま(show するまで true)。消していなければ、本文の前にウィンドウを自動で出す。 */
|
|
142
|
+
windowHidden?: boolean;
|
|
143
|
+
/** 画面全体に文章を積んでいく表示(@nvl on)。省略は false。 */
|
|
144
|
+
nvl?: boolean;
|
|
145
|
+
/** NVL の見た目の名前(@nvl on style=。liminalia.json の ui.nvlStyles)。省略は ui.nvl の見た目。 */
|
|
146
|
+
nvlStyle?: string;
|
|
147
|
+
/** 今の NVL の画面に積んである、読み終えた段落(ロードで出し直す)。@clear や表示の切り替えで消える。 */
|
|
148
|
+
nvlPages?: NvlPage[];
|
|
149
|
+
/**
|
|
150
|
+
* クリックを待たずに次へ進んだページ(行の最後の {noclick})の本文。次のページを出すまでメッセージウィンドウに残るので、
|
|
151
|
+
* その間のセーブ(選択肢など)をロードしたら出し直す。次のページ、@clear、@window hide、表示の切り替えで消える。
|
|
152
|
+
*/
|
|
153
|
+
noclickPage?: NvlPage;
|
|
154
|
+
/** 本文の縦書き(@vertical)。省略は作品の設定(ui.message.vertical)。 */
|
|
155
|
+
vertical?: boolean;
|
|
156
|
+
mask: string | null;
|
|
157
|
+
camera: { zoom: number; x: number; y: number; rotate: number };
|
|
158
|
+
/** 一文字あたりのミリ秒。null は設定画面の値。 */
|
|
159
|
+
textSpeed: number | null;
|
|
160
|
+
/** 作品固有の命令が持つ状態。 */
|
|
161
|
+
extra: Record<string, Value>;
|
|
162
|
+
/** システム画面への要求のうち、続いている状態(@menu-button・@shortcuts・@backlog)。省略は既定(すべて true)。 */
|
|
163
|
+
ui?: { menuButton: boolean; shortcuts: boolean; backlog: boolean };
|
|
164
|
+
/** ボイス。next は次の台詞で鳴らすもの(@voice)、auto は話者ごとの連番の自動再生(@voice-auto)。省略は何もない。 */
|
|
165
|
+
voice?: { next?: VoiceCue | null; auto?: Record<string, VoiceAuto> };
|
|
166
|
+
/** ボイスに掛け続ける音のフィルター(@voice-filter)。キーは話者名、"" はすべての話者。省略は掛けない。 */
|
|
167
|
+
voiceFilter?: Record<string, SoundFilterState>;
|
|
168
|
+
/** 立ち絵の振る舞い(@chara-config)。省略した項目は作品の設定(ui.chara)、それも無ければ既定(目立たせない、跳ねない)。 */
|
|
169
|
+
spriteConfig?: SpriteConfig;
|
|
170
|
+
/** 話者の名前欄に出す名前(@name)。キーは話者名。話者ごとの処理(口パク、ボイスなど)は話者名のまま。 */
|
|
171
|
+
names?: Record<string, string>;
|
|
172
|
+
/** 文字を出すときの音(@text-sound)。キーは話者名、"" はほかのすべて。 */
|
|
173
|
+
textSound?: Record<string, { file: string; volume: number; every: number }>;
|
|
174
|
+
/** 吹き出し(@balloon on)。省略・null はメッセージ枠。 */
|
|
175
|
+
balloon?: Balloon | null;
|
|
176
|
+
/** 立ち絵の色調(@tone)。キーはキャスト名、"" はすべての立ち絵。値は色調の名前。背景の色調より先に効く。 */
|
|
177
|
+
tones?: Record<string, string>;
|
|
178
|
+
/**
|
|
179
|
+
* @bg(@scene-change)の tone= で決めた背景の色調(none なら掛けない)。image はその背景で、背景がほかの絵に替わったら効かない。
|
|
180
|
+
* 省略は liminalia.json の ui.backgroundTones(描画側が背景の名前で引く)。
|
|
181
|
+
*/
|
|
182
|
+
backgroundTone?: { image: string; tone: string };
|
|
183
|
+
/**
|
|
184
|
+
* 被写界深度(@dof)。on のところにピントを合わせ、ほかをぼかす(blur は px)。chara は who の立ち絵に合わせ、
|
|
185
|
+
* 背景とほかの立ち絵をぼかす。省略・null はぼかさない。
|
|
186
|
+
*/
|
|
187
|
+
dof?: { on: "background" | "sprites" | "chara"; who?: string; blur: number } | null;
|
|
188
|
+
/**
|
|
189
|
+
* 場面の切れ目まで待たせている命令(@notify when=scene-break。命令の ctx.atSceneBreak)。セーブに入るので、待っている間に
|
|
190
|
+
* セーブとロードをしても消えない。due は場面の切れ目を過ぎた数(先頭から)で、次の本文か選択肢の前に描画側へ渡して外す
|
|
191
|
+
* (外したあとのセーブには入らないので、ロードで二度出ない)。省略は待っているものが無い。
|
|
192
|
+
*/
|
|
193
|
+
sceneWait?: SceneWait;
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
/** 場面の切れ目まで待たせている命令(StageState.sceneWait)。 */
|
|
197
|
+
export interface SceneWait {
|
|
198
|
+
commands: { name: string; args: Record<string, Value> }[];
|
|
199
|
+
due?: number;
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
export interface SpriteConfig {
|
|
203
|
+
/** 話していないキャラクターの見せ方(省略は作品の設定 ui.chara.focus。それも無ければ none)。 */
|
|
204
|
+
focus?: "none" | "dim" | "blur" | "dim-blur" | "lower" | "dim-lower";
|
|
205
|
+
dim?: number;
|
|
206
|
+
/** 下げる量(px)。 */
|
|
207
|
+
lower?: number;
|
|
208
|
+
jump?: boolean;
|
|
209
|
+
/** 自動配置で並べ直す時間(ミリ秒)。 */
|
|
210
|
+
moveTime?: number;
|
|
211
|
+
easing?: string;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
/** 鳴らすボイス一つ。folder は素材のフォルダ(voice か sound)。 */
|
|
215
|
+
export interface VoiceCue {
|
|
216
|
+
file: string;
|
|
217
|
+
volume: number;
|
|
218
|
+
folder: string;
|
|
219
|
+
/** 連番のボイス(@voice-auto)なら番号。 */
|
|
220
|
+
n?: number;
|
|
221
|
+
/** 字幕(@voice の caption。本文に書いていない声)。 */
|
|
222
|
+
caption?: string;
|
|
223
|
+
/** ボイスのチャンネル(1 から。省略は 1)。同じチャンネルのボイスは置き換わり、違うチャンネルなら同時に鳴る。 */
|
|
224
|
+
channel?: number;
|
|
225
|
+
/** このボイスの話者(@voice の who。省略はそのページの話者)。口パクと名前欄に使う。 */
|
|
226
|
+
who?: string;
|
|
227
|
+
/** 音のフィルター(@voice の filter か、@voice-filter で掛け続けているもの)。null は掛けない(@voice filter=none)。 */
|
|
228
|
+
filter?: SoundFilterState | null;
|
|
229
|
+
/** 同じページで同時に鳴らすボイス(二人が同時に話す。二つ目の @voice か channel=2)。 */
|
|
230
|
+
also?: VoiceCue[];
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* 話者の連番のボイス。pattern の {n}({n:3} なら 3 桁)を next に置き換えたファイルを鳴らし、鳴らすたびに next を一つ進める。
|
|
235
|
+
* off は止めている間 true(番号は保つ)。
|
|
236
|
+
*/
|
|
237
|
+
export interface VoiceAuto {
|
|
238
|
+
pattern: string;
|
|
239
|
+
next: number;
|
|
240
|
+
volume: number;
|
|
241
|
+
folder: string;
|
|
242
|
+
off?: boolean;
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* 呼び出しの記録(@call・マクロ・@with の中身)。return は戻る位置、locals は戻ったときの局所変数。
|
|
247
|
+
* result はマクロの戻り値(@return (式))を入れる変数、content は @with で渡された中身の実行単位の id(マクロの中の @content が入る)。
|
|
248
|
+
*/
|
|
249
|
+
export interface CallFrame {
|
|
250
|
+
return: Position;
|
|
251
|
+
locals: Scope;
|
|
252
|
+
result?: string;
|
|
253
|
+
content?: string;
|
|
254
|
+
/**
|
|
255
|
+
* 場面の呼び出し(Runtime.callScene)。呼んだ場面が次のラベルかファイルの終わりに着いたら、@return を書かなくても return へ戻る。
|
|
256
|
+
* 場面の中で @jump したり、選択肢でほかへ飛んだりしたら、戻らずにこの枠を捨てる。
|
|
257
|
+
*/
|
|
258
|
+
scene?: true;
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
/** @sleep-game・@checkpoint で取っておく、ある時点の状態。 */
|
|
262
|
+
export interface Snapshot {
|
|
263
|
+
position: Position;
|
|
264
|
+
locals: Scope;
|
|
265
|
+
callStack: CallFrame[];
|
|
266
|
+
game: Scope;
|
|
267
|
+
stage: StageState;
|
|
268
|
+
seed: number;
|
|
269
|
+
visits?: Record<string, number>;
|
|
270
|
+
chosen?: Record<string, number>;
|
|
271
|
+
variants?: Record<string, number[]>;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
/** セーブデータ。この値を JSON にして保存し、そのまま戻せば再開できる。 */
|
|
275
|
+
export interface SaveData {
|
|
276
|
+
/** セーブの形の版(save.ts の SAVE_VERSION)。読み込むときに今の版へ変換する。 */
|
|
277
|
+
version: number;
|
|
278
|
+
position: Position;
|
|
279
|
+
locals: Scope;
|
|
280
|
+
callStack: CallFrame[];
|
|
281
|
+
game: Scope;
|
|
282
|
+
stage: StageState;
|
|
283
|
+
seed: number;
|
|
284
|
+
/** @sleep-game で取っておいた状態(@awake-game で戻る)。 */
|
|
285
|
+
sleep?: Snapshot | null;
|
|
286
|
+
/** @checkpoint で名前を付けて取っておいた状態。 */
|
|
287
|
+
checkpoints?: Record<string, Snapshot>;
|
|
288
|
+
/** このプレイでラベル(`ファイル#ラベル`)とファイルの頭(`ファイル`)に入った回数(式の visits())。無ければ 0。 */
|
|
289
|
+
visits?: Record<string, number>;
|
|
290
|
+
/** このプレイで選んだ選択肢の文(飾りを外した原文)→ 回数(式の chosen())。 */
|
|
291
|
+
chosen?: Record<string, number>;
|
|
292
|
+
/**
|
|
293
|
+
* 本文の出し分け({seq a|b} など)を通った回数と、前に出したものの番号(出していなければ -1)。鍵はファイルと原文のハッシュと、
|
|
294
|
+
* その文の何番目の出し分けか(`ファイル#ハッシュ:番号`。同じファイルの同じ文の行は数を分け合う)。
|
|
295
|
+
*/
|
|
296
|
+
variants?: Record<string, number[]>;
|
|
297
|
+
/**
|
|
298
|
+
* 作品の版(liminalia.json の version。Runtime の options.gameVersion)。セーブするときに今の版を入れる。
|
|
299
|
+
* 式の save.version で読む(ロードしたプレイはそのセーブを作った版、新しく始めたプレイは今の版。版を入れる前のセーブには無く、空として読む)。
|
|
300
|
+
*/
|
|
301
|
+
gameVersion?: string;
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
export interface GameState extends SaveData {
|
|
305
|
+
/** そのプレイ中だけの変数。セーブには入らない。 */
|
|
306
|
+
temp: Scope;
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
export function initialStage(): StageState {
|
|
310
|
+
return {
|
|
311
|
+
background: null,
|
|
312
|
+
sprites: {},
|
|
313
|
+
bgm: null,
|
|
314
|
+
loopingSe: {},
|
|
315
|
+
window: false,
|
|
316
|
+
mask: null,
|
|
317
|
+
camera: { zoom: 1, x: 0, y: 0, rotate: 0 },
|
|
318
|
+
textSpeed: null,
|
|
319
|
+
extra: {},
|
|
320
|
+
};
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
export function createState(unit: string, seed = 1): GameState {
|
|
324
|
+
return {
|
|
325
|
+
version: SAVE_VERSION,
|
|
326
|
+
position: { unit, index: 0 },
|
|
327
|
+
locals: {},
|
|
328
|
+
callStack: [],
|
|
329
|
+
game: {},
|
|
330
|
+
temp: {},
|
|
331
|
+
stage: initialStage(),
|
|
332
|
+
seed,
|
|
333
|
+
};
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
export function toSaveData(state: GameState): SaveData {
|
|
337
|
+
const { temp: _, ...save } = state;
|
|
338
|
+
return clonePlain(save);
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* 状態の深い写し。状態はセーブ(JSON)に書ける値だけなので、配列とふつうのオブジェクトを辿って写す。
|
|
343
|
+
* structuredClone と同じ結果だが、台詞ごとに取る写し(再開の控え)では数倍速い。ふつうでないもの(Map、Date など)はそこだけ structuredClone にする。
|
|
344
|
+
*/
|
|
345
|
+
export function clonePlain<T>(value: T): T {
|
|
346
|
+
if (value === null || typeof value !== "object") return value;
|
|
347
|
+
if (Array.isArray(value)) return value.map(clonePlain) as T;
|
|
348
|
+
const proto = Object.getPrototypeOf(value);
|
|
349
|
+
if (proto !== Object.prototype && proto !== null) return structuredClone(value);
|
|
350
|
+
const out: Record<string, unknown> = {};
|
|
351
|
+
for (const key of Object.keys(value)) out[key] = clonePlain((value as Record<string, unknown>)[key]);
|
|
352
|
+
return out as T;
|
|
353
|
+
}
|