Skip to content

Commit 8248da5

Browse files
MakinoharaShokoMakinoharaShoko
authored
Merge pull request #90 from starrybamboo/docs/complete-script-reference-gaps
doc： 用claude 和 gpt 弥合了下现有脚本和实际文档的区别
2 parents 398a518 + 023cf0e commit 8248da5

92 files changed

Lines changed: 4803 additions & 685 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/.vuepress/sidebar/en.ts‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,44 @@ export const enSidebar = sidebar({
4242
"developers/terre",
4343
]
4444
},
45+
{
46+
text: "Script Reference",
47+
prefix: "script-reference/",
48+
children: [
49+
{
50+
text: "Commands",
51+
prefix: "commands/",
52+
children: [
53+
"global",
54+
"say",
55+
"changeBg",
56+
"changeFigure",
57+
"bgm",
58+
"intro",
59+
"changeScene",
60+
"choose",
61+
"label",
62+
"jumpLabel",
63+
"setVar",
64+
"setTextbox",
65+
"setAnimation",
66+
"playEffect",
67+
"setTempAnimation",
68+
"setTransform",
69+
"getUserInput",
70+
"applyStyle",
71+
"callSteam",
72+
],
73+
},
74+
{
75+
text: "Other",
76+
prefix: "others/",
77+
children: [
78+
"transform-reference",
79+
"animation-reference",
80+
],
81+
},
82+
],
83+
},
4584
],
4685
});

‎src/.vuepress/sidebar/ja.ts‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,44 @@ export const jaSidebar = sidebar({
4242
"developers/terre",
4343
]
4444
},
45+
{
46+
text: "スクリプトリファレンス",
47+
prefix: "script-reference/",
48+
children: [
49+
{
50+
text: "コマンド",
51+
prefix: "commands/",
52+
children: [
53+
"global",
54+
"say",
55+
"changeBg",
56+
"changeFigure",
57+
"bgm",
58+
"intro",
59+
"changeScene",
60+
"choose",
61+
"label",
62+
"jumpLabel",
63+
"setVar",
64+
"setTextbox",
65+
"setAnimation",
66+
"playEffect",
67+
"setTempAnimation",
68+
"setTransform",
69+
"getUserInput",
70+
"applyStyle",
71+
"callSteam",
72+
],
73+
},
74+
{
75+
text: "その他",
76+
prefix: "others/",
77+
children: [
78+
"transform-reference",
79+
"animation-reference",
80+
],
81+
},
82+
],
83+
},
4584
],
4685
});

‎src/.vuepress/sidebar/zh.ts‎

Lines changed: 109 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,108 +1,109 @@
1-
import { sidebar } from "vuepress-theme-hope";
2-
3-
export const zhSidebar = sidebar({
4-
"/": [
5-
{
6-
text: "游戏开发指引",
7-
// prefix: "/",
8-
children: [
9-
"getting-started",
10-
"resources",
11-
"config",
12-
{
13-
text: "部署或发布我的视觉小说？",
14-
link: "publish/",
15-
collapsible: true, // 是否可折叠
16-
prefix: "publish/",
17-
children: [
18-
"web",
19-
"desktop",
20-
"android",
21-
]
22-
},
23-
"faq",
24-
"live2D",
25-
"migration",
26-
"derivative",
27-
],
28-
},
29-
{
30-
text: "WebGAL 脚本教程",
31-
prefix: "webgal-script/",
32-
children: [
33-
"base",
34-
"dialogue",
35-
"bg-and-figure",
36-
"audio",
37-
"video",
38-
"scenes",
39-
"variable",
40-
"animation",
41-
"special-effect",
42-
]
43-
},
44-
{
45-
text: "开发信息",
46-
children: [
47-
"developers",
48-
"tech",
49-
"info",
50-
"sponsor",
51-
"developers/joinus",
52-
"developers/terre",
53-
]
54-
},
55-
{
56-
text: "脚本参考",
57-
prefix: "script-reference/",
58-
children: [
59-
{
60-
text: "命令",
61-
prefix: "commands/",
62-
children:[
63-
"global",
64-
"say",
65-
"changeBg",
66-
"changeFigure",
67-
"bgm",
68-
"playVideo",
69-
"pixiPerform",
70-
"pixiInit",
71-
"intro",
72-
"miniAvatar",
73-
"changeScene",
74-
"choose",
75-
"end",
76-
"setComplexAnimation",
77-
"label",
78-
"jumpLabel",
79-
"setVar",
80-
"callScene",
81-
"showVars",
82-
"unlockCg",
83-
"unlockBgm",
84-
"filmMode",
85-
"setTextbox",
86-
"setAnimation",
87-
"playEffect",
88-
"setTempAnimation",
89-
"comment",
90-
"setTransform",
91-
"setTransition",
92-
"getUserInput",
93-
"applyStyle",
94-
"wait",
95-
]
96-
},
97-
{
98-
text: "其他",
99-
prefix: "others/",
100-
children:[
101-
"transform-reference",
102-
"animation-reference",
103-
]
104-
},
105-
],
106-
},
107-
],
108-
});
1+
import { sidebar } from "vuepress-theme-hope";
2+
3+
export const zhSidebar = sidebar({
4+
"/": [
5+
{
6+
text: "游戏开发指引",
7+
// prefix: "/",
8+
children: [
9+
"getting-started",
10+
"resources",
11+
"config",
12+
{
13+
text: "部署或发布我的视觉小说？",
14+
link: "publish/",
15+
collapsible: true, // 是否可折叠
16+
prefix: "publish/",
17+
children: [
18+
"web",
19+
"desktop",
20+
"android",
21+
]
22+
},
23+
"faq",
24+
"live2D",
25+
"migration",
26+
"derivative",
27+
],
28+
},
29+
{
30+
text: "WebGAL 脚本教程",
31+
prefix: "webgal-script/",
32+
children: [
33+
"base",
34+
"dialogue",
35+
"bg-and-figure",
36+
"audio",
37+
"video",
38+
"scenes",
39+
"variable",
40+
"animation",
41+
"special-effect",
42+
]
43+
},
44+
{
45+
text: "开发信息",
46+
children: [
47+
"developers",
48+
"tech",
49+
"info",
50+
"sponsor",
51+
"developers/joinus",
52+
"developers/terre",
53+
]
54+
},
55+
{
56+
text: "脚本参考",
57+
prefix: "script-reference/",
58+
children: [
59+
{
60+
text: "命令",
61+
prefix: "commands/",
62+
children:[
63+
"global",
64+
"say",
65+
"changeBg",
66+
"changeFigure",
67+
"bgm",
68+
"playVideo",
69+
"pixiPerform",
70+
"pixiInit",
71+
"intro",
72+
"miniAvatar",
73+
"changeScene",
74+
"choose",
75+
"end",
76+
"setComplexAnimation",
77+
"label",
78+
"jumpLabel",
79+
"setVar",
80+
"callScene",
81+
"showVars",
82+
"unlockCg",
83+
"unlockBgm",
84+
"filmMode",
85+
"setTextbox",
86+
"setAnimation",
87+
"playEffect",
88+
"setTempAnimation",
89+
"comment",
90+
"setTransform",
91+
"setTransition",
92+
"getUserInput",
93+
"applyStyle",
94+
"wait",
95+
"callSteam",
96+
]
97+
},
98+
{
99+
text: "其他",
100+
prefix: "others/",
101+
children:[
102+
"transform-reference",
103+
"animation-reference",
104+
]
105+
},
106+
],
107+
},
108+
],
109+
});

‎src/config.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
| Legacy_Expression_Blend_Mode | 是否启用 Live2D 的旧表情混合模式，设置为 true 或 false |
1616
| Max_line | 文本框的最大显示行数 |
1717
| Line_height | 文本框的行高（单位：em） |
18+
| Steam_AppID | Steam 应用 ID，用于初始化 Steam 集成，仅在 Electron 构建环境下有效 |
1819

1920
以下是配置文件示例：
2021

‎src/en/config.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Under the `game` folder, there is a file named `config.txt`, you can fill in the
1515
| Legacy_Expression_Blend_Mode | Whether to enable legacy expression blend mode for Live2D, set to true or false |
1616
| Max_line | Maximum number of displayed lines in the text box |
1717
| Line_height | Line height of the text box (unit: em) |
18+
| Steam_AppID | Steam App ID, used to initialize Steam integration. Only effective in Electron builds |
1819

1920
The following is a sample configuration file:
2021

‎src/en/script-reference/arguments/duration.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
### duration
2+
- Number
3+
- Range: 0 to positive infinity
4+
- Unit: milliseconds
5+
6+
The duration of the animation.

‎src/en/script-reference/arguments/ease.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
### ease
2+
- String
3+
4+
Sets the easing type used by the animation. The default value is `easeInOut`. Available values include:
5+
- `linear`: linear
6+
- `easeIn`: ease in
7+
- `easeOut`: ease out
8+
- `easeInOut`: ease in and out
9+
- `circIn`: circular ease in
10+
- `circOut`: circular ease out
11+
- `circInOut`: circular ease in and out
12+
- `backIn`: back ease in
13+
- `backOut`: back ease out
14+
- `backInOut`: back ease in and out
15+
- `bounceIn`: bounce in
16+
- `bounceOut`: bounce out
17+
- `bounceInOut`: bounce in and out
18+
- `anticipate`: anticipate
19+
20+
Any other string falls back to the default value.

‎src/en/script-reference/arguments/enter.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
### enter
2+
- String
3+
4+
Sets the animation played when the object enters the stage, replacing the default opacity fade-in entrance animation.

‎src/en/script-reference/arguments/exit.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
### exit
2+
- String
3+
4+
Sets the animation played when the object exits the stage, replacing the default opacity fade-out exit animation.

‎src/en/script-reference/arguments/keep.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### keep
2+
- Boolean
3+
4+
Converts the animation into a cross-statement animation. The current animation keeps playing while subsequent statements run, until it ends or is interrupted by another `setTransform`, `setAnimation`, or `setTempAnimation` with the same target.
5+
It is usually used together with the `next` parameter.

0 commit comments

Comments
 (0)