Skip to content

Commit e7b2d9e

Browse files
committed
Minor update on rest of doc
1 parent 47c0a4b commit e7b2d9e

File tree

6 files changed

+36
-28
lines changed

6 files changed

+36
-28
lines changed

docs/zh/engine/renpy.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
1-
# Ren'Py 引擎
1+
# Ren'Py 引擎
2+
3+
链接:
4+
5+
* [中文网站首页](https://www.renpy.cn/)
6+
* [中文文档](https://doc.renpy.cn/zh-CN/)
7+
* [英文(原版)网站首页](https://renpy.org/)
8+
* [英文(原版)文档](https://renpy.org/doc/html/)
9+
10+
现阶段, Ren'Py 引擎是语涵编译器支持能力最高的引擎。(文档还没写完,敬请期待。。)
11+
12+
## 文件导出规则
13+
14+
除非功能上平替或超越,语涵编译器不会覆盖已有的工程文件。从默认新建工程起,语涵编译器只会覆盖 `script.rpy` 使其跳转至入口。每个剧本文件都会导出为一个独立的 `.rpy` 文件。
15+

docs/zh/engine/webgal.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
11
# WebGal 引擎
2+
3+
链接:
4+
5+
* [网站首页](https://www.openwebgal.com/zh-cn/)
6+
* [文档](https://docs.openwebgal.com/)
7+
8+
语涵编译器对该引擎的支持仍是试验性质,暂无详细文档。
-56 KB
Binary file not shown.

docs/zh/intro/functionality.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,11 @@
1010

1111
语涵编译器的核心部分,用 Python 编写。由于语涵编译器在设计之初就想支持第三方集成、允许其他人的程序使用语涵编译器的功能,所以所有的功能、内嵌资源都在命令行核心中,用户或第三方的脚本可以使用这个程序使用所有功能。调用这个命令行模式的文件可以避免在特定环境下由于使用窗口导致出错。除非您知道自己在做什么,否则都推荐用以下的图形界面来使用本程序。
1212

13-
### 初版 UI
14-
15-
图标和文件名:<img src="preppipe_gui.ico" alt="初版UI的图标" width="64" height="64"/> preppipe_gui.exe
16-
17-
该程序是套在命令行核心外的壳,所有功能通过调用命令行核心来完成。推荐使用该图形界面。此文档的所有说明也均围绕该 UI 展开。
18-
19-
语涵编译器项目在(2023年)修改定位前只考虑剧本录入、自动演出等功能,不包含素材库、没有需要频繁与用户交互的功能,所以图形窗口没有与核心耦合的需求,完全可以做成独立的程序。使用Qt/C++开发初版 UI 只是因为作者对此比较熟悉,平台稳定可靠。但是这版 UI 也有局限,界面复杂难懂。我们在新版 UI 成熟后会放弃这版 UI。
20-
21-
### 新版 UI (开发中)
13+
### UI
2214

2315
图标和文件名:<img src="preppipe.ico" alt="新版UI的图标" width="64" height="64"/> preppipe.exe
2416

25-
目前仍在开发中的新 UI,也由 Python 编写。设计上支持以下功能和特性:
26-
27-
* 更方便、完善的多语言支持(包括简中、繁中、英语)
28-
* UI 重新设计,用户无需花时间阅读文档或介绍视频即可上手使用
29-
* 开发效率更高
17+
该 UI 是套在命令行核心外的壳,大部分功能通过调用命令行核心来完成,也由 Python 编写。
3018

3119
## 核心模块
3220

@@ -93,7 +81,7 @@ graph LR
9381

9482
* 素材库:为了支持在只有剧本、没有素材的情况下生成实机演示,语涵编译器项目内嵌了一些素材。所有素材均可从语涵编译器的代码仓库直接下载,您即使不使用语涵编译器也可以使用我们准备的素材。
9583
* 前端剧本读取、解析、自动演出:语涵编译器可以读取符合[剧本格式要求](../script/overview.md)的剧本,以此生成游戏工程文件。剧本内可以引用素材库中的内容。
96-
* 中端分析优化工具:语涵编译器可以分析剧本并生成报告,用以引导制作者进行迭代。详情请见[中端工具总览](../middleend/overview.md)
97-
* 后端工程导出:语涵编译器目前可以生成 [Ren'Py](../engine/renpy.md)[WebGal](../engine/webgal.md) 的游戏工程。目前 WebGal 的支持暂时还不完整,部分功能用不了,之后会慢慢完善。
84+
* 中端分析优化工具:语涵编译器可以分析剧本并生成报告,用以引导制作者进行迭代。详情请见[中端工具总览](../middleend/overview.md)(注:目前尚不可用)
85+
* 后端工程导出:语涵编译器目前可以生成 [Ren'Py](../engine/renpy.md)[WebGal](../engine/webgal.md) 的游戏工程。目前 WebGal 的支持仍是试验性质,部分功能用不了,之后会慢慢完善。
9886

9987
前、中、后端在本文档里都有各自的部分进行介绍,详情请阅读对应章节。关于素材的使用方法将在前端部分介绍。

docs/zh/intro/usage.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -333,11 +333,3 @@
333333
### 未完成的功能
334334

335335
变量、特效、指定转场等功能都还没做,敬请期待。
336-
337-
## 资源使用情况分析
338-
339-
程序可以统计各项资源的使用情况(如每个立绘、背景一共在多少句发言里被用到),辅助用户决定素材制作计划,及早发现不合理的素材安排。请勾选下图所示的选框以启用该功能:
340-
341-
![资源使用情况分析设置项位置](assetusage_chkbox.png)
342-
343-
(您不一定需要指定导出位置;程序会把所有未指定的输出都放在新建的临时目录里。)

docs/zh/intro/why_preppipe.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,13 @@ graph TB
6767
release --> patching;
6868
```
6969

70+
!!! note "准备期务必完成大纲"
71+
72+
我们强烈建议制作组在准备期完成所有大纲内容,确定主要剧情、素材需求和预算范围,并收集反馈意见;迭代完成之前不建议开始组建团队、开启正式制作。原因如下:
73+
74+
* 完整的大纲已经能够暴露出方向性的问题(如选题、项目规模、受众等),能收集到有效的反馈意见;
75+
* 大纲阶段是能够无成本解决方向性问题的最后机会。
76+
7077
## 本可避免的问题
7178

7279
对于爱好者团体(而非经验丰富的商业化公司)来说,上述流程可能会出现以下问题:
@@ -86,7 +93,7 @@ graph TB
8693
语涵编译器项目有以下两个主要目标:
8794

8895
* 能在开发早期(演出之前)就能有可以运行的实机Demo。语涵编译器读取剧本和素材,导出用户指定的引擎所用的游戏工程文件(如 Ren'Py, WebGal 等)。
89-
* 集成分析工具和常用功能,提高游戏制作效率。
96+
* 集成分析工具和常用功能,提高游戏制作效率。(注:分析工具正在迭代中,敬请期待)
9097

9198
因此,使用语涵编译器的团队除了上述的传统工作流程外,还可以采用如下快速迭代流程:
9299

@@ -125,11 +132,11 @@ graph TB
125132
* 资源配置不合理:我们可以通过分析工具整理资源需求、了解资源使用情况,团队可以以此为基础去调整需求、优先完成更重要的部分。
126133
* 引擎选择不当:(目前还不完善,但)语涵编译器可以生成不止一种游戏引擎所用的游戏工程,制作团队可以先完成游戏内容,再根据效果决定所使用的引擎。语涵编译器也可以支持用户添加对自研引擎的支持。
127134

128-
某种程度上说,对于视觉小说制作过程中碰到的可以自动化处理的一切问题,如果没有被引擎和发行平台解决的话,以后都可以在语涵编译器中解决。如果成熟的制作团队内部有自己开发的辅助工具的话,语涵编译器就是要抢这些工具的饭碗。
135+
某种程度上说,对于视觉小说制作过程中碰到的可以自动化处理的一切问题,如果没有被引擎和发行平台解决的话,我们希望以后都可以在语涵编译器中解决。如果成熟的制作团队内部有自己开发的辅助工具的话,语涵编译器就是要抢这些工具的饭碗。
129136

130137
语涵编译器对输入剧本的格式也有要求,不过我们在设计上尽可能接近创作者的自然写作习惯,由于演出需要所添加的命令也尽可能设计得好懂,含义一目了然。如果我们发现新的符合自然写作习惯的表述方式,我们会修改程序来添加支持。换句话说,如果其他引擎的语言是“创作者学习引擎的规则”,那么语涵编译器是去“主动学习创作者的规则”。
131138

132-
由于视觉小说引擎的设计千差万别,所支持的演出效果和特性等也大相径庭,所以我们不可能保证每个引擎的所有特性都能在语涵编译器内得到支持。因此,语涵编译器尽可能支持视觉小说引擎共通的一部分功能和特性,其余与引擎深度绑定的优化、演出等仍然需要用户脱离语涵编译器后手动完成
139+
由于视觉小说引擎的设计千差万别,所支持的演出效果和特性等也大相径庭,所以我们不可能保证每个引擎的所有特性都能在语涵编译器内得到支持。因此,语涵编译器尽可能支持视觉小说引擎共通的一部分功能和特性,其余与引擎深度绑定的优化、演出等可能仍然需要用户脱离语涵编译器后手动完成
133140

134141
## 总结
135142

0 commit comments

Comments
 (0)