Skip to content

Commit 77dac81

Browse files
committed
docs(zh-hans): rewrite battle system documentation
1 parent ae9e199 commit 77dac81

File tree

7 files changed

+2345
-27
lines changed

7 files changed

+2345
-27
lines changed
Lines changed: 127 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,130 @@
11
# 欢迎来到皇家厨房
22

3-
这里是什么地方?(关于 SoupRune)
4-
看看其他大厨的杰作(Showcase)
3+
```dialogue
4+
<path:/images/faces/toriel.png>
5+
* 欢迎,我的孩子。我看到你对制作游戏充满了热情。
6+
* 不用紧张,我会一步步教你的,就像烤派一样简单。
7+
```
58

6-
(TODO)
9+
欢迎来到 **SoupRune**——一个为创作 Deltarune / Undertale 风格游戏而生的现代化框架。
10+
11+
如果你是第一次来到这里,可能会有些不知所措。这么多文件,这么多术语……别担心,深呼吸,让我慢慢为你讲解。
12+
13+
## 🥣 这到底是什么?
14+
15+
想象一下,你走进了一间厨房。
16+
17+
在这间厨房里:
18+
- **炉灶**已经准备好了(Bevy 引擎)
19+
- **锅碗瓢盆**都摆放整齐(核心系统)
20+
- **基础食材**已经备好(配置模板)
21+
22+
你需要做的,只是:
23+
1. 拿起菜谱(配置文件)
24+
2. 按照步骤添加材料(编写 RON 文件)
25+
3. 偶尔调整火候(修改参数)
26+
27+
就这样,一道美味的游戏就诞生了!
28+
29+
```dialogue
30+
<path:/images/faces/toriel.png>
31+
* 最重要的是——你不需要成为专业厨师。
32+
* 只要会读食谱,就能做出美味的派。
33+
```
34+
35+
## 🍲 S.O.U.P 原则
36+
37+
SoupRune 的设计理念可以用一碗热气腾腾的汤来概括:
38+
39+
### **S - Strong (强劲内核)**
40+
底层使用 **Rust****Bevy 引擎**,拥有出色的性能和并行计算能力。就像一口结实的铸铁锅,能承受高温和重压。
41+
42+
### **O - Open (自由开源)**
43+
采用 **LGPL-3.0** 协议。引擎代码开源,但你的游戏项目完全属于你自己。就像公共厨房——设备是大家的,但你做出的菜是你的。
44+
45+
### **U - User-friendly (易于上手)**
46+
提供开箱即用的功能:对话系统、战斗框架、地图编辑器集成。就像预制的半成品——加热就能吃。
47+
48+
### **P - Polyglot (多语言支持)**
49+
支持 Rust、C#、Haxe 等多种编程语言。就像准备了多种餐具——筷子、刀叉、勺子,用你最顺手的那个!
50+
51+
## 🎮 你能做什么?
52+
53+
使用 SoupRune,你可以创作:
54+
55+
**回合制战斗系统**(像 Undertale 那样的弹幕战斗)
56+
**开放世界探索**(像 Deltarune 的城镇和迷宫)
57+
**对话和剧情系统**(用 Mortar 脚本语言)
58+
**自定义 UI 界面**(战斗菜单、道具栏等)
59+
**动画和特效**(集成 Alight Motion 动画工具)
60+
61+
## 🎯 "不写代码"是真的吗?
62+
63+
是的——**绝大部分内容**都可以通过配置文件完成!
64+
65+
举个例子,创建一场战斗,你只需要写这样的配置文件:
66+
67+
```ron
68+
// battle.ron
69+
(
70+
player_hp: 92,
71+
player_speed: 200.0,
72+
battle_box_size: (150.0, 150.0),
73+
chapters: [
74+
// 玩家选择攻击目标
75+
UIInteraction(ui_layout: "battle_menu"),
76+
// 播放弹幕攻击
77+
DanmakuPerformance(
78+
performance: "attacks/flowey_bullets.ron",
79+
position: Some((0.0, 100.0)),
80+
),
81+
// 等待3秒
82+
Wait(3.0),
83+
]
84+
)
85+
```
86+
87+
看到了吗?就像填表格一样!
88+
89+
当然,如果你想实现更复杂的逻辑(比如独特的 Boss 机制),你可以用 Rust、C# 或 Haxe 编写脚本。但对于大部分内容来说,配置文件就够了。
90+
91+
```dialogue
92+
<path:/images/faces/toriel.png>
93+
* 别担心,孩子。我们会从最简单的开始。
94+
* 一步一个脚印,很快你就能烤出自己的派了。
95+
```
96+
97+
## 🏗️ 引擎 vs 项目:游戏机与卡带
98+
99+
这个比喻非常重要,让我们用任天堂 Switch 来类比:
100+
101+
| 部分 | 比喻 | 说明 | 你需要做什么? |
102+
|-----|------|------|-------------|
103+
| **Engine (引擎)** | Switch 主机 | 负责运行游戏的底层系统 | ❌ 不需要改动 |
104+
| **Core (核心库)** | 操作系统 | 提供基础功能(碰撞、渲染等) | ❌ 不需要改动 |
105+
| **Project (项目)** | 游戏卡带 | 你的游戏内容和剧情 | ✅ 这是你的主战场 |
106+
| **Assets (资源)** | 游戏数据 | 图片、音乐、配置文件 | ✅ 这是你的创意空间 |
107+
108+
所以你要做的,就是**制作游戏卡带**——编写配置文件、准备素材、编排剧情。
109+
110+
引擎会帮你处理所有复杂的技术问题(渲染、物理、音频等),你只需要专注于创意!
111+
112+
## 📚 关于这份文档
113+
114+
这份文档分为几个部分:
115+
116+
- **Part 0: 备菜阶段**(你现在这里)— 环境配置和基础知识
117+
- **Part 1: 辛辣的主菜** — 战斗系统开发
118+
- **Part 2: 精致摆盘** — 世界场景与叙事
119+
- **Part 3: 灵魂甜点** — 视听效果与美化
120+
- **Part 4: 分子料理** — 高级脚本与底层开发
121+
122+
```dialogue
123+
<path:/images/faces/toriel.png>
124+
* 准备好了吗,孩子?
125+
* 让我们开始你的烹饪之旅吧。
126+
```
127+
128+
---
129+
130+
**下一步:[挑选你的厨具 →](0.2_setup.md)**
Lines changed: 202 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,205 @@
11
# 挑选你的厨具
22

3-
只需三步,点火开灶(快速安装指南)
4-
*特别收录:如果锅炸了怎么办?(常见安装报错)*
3+
```dialogue
4+
<path:/images/faces/toriel.png>
5+
* 好的,孩子。在开始烹饪之前...
6+
* 我们需要确保厨房里有所有必要的工具。
7+
* 别担心,我会帮你检查每一件的。
8+
```
59

6-
(TODO)
10+
在真正开始制作游戏之前,我们需要准备好开发环境。这就像准备厨具——工欲善其事,必先利其器。
11+
12+
## 🔧 你需要什么?
13+
14+
### 必备工具清单
15+
16+
| 工具 | 作用 | 必需? |
17+
|-----|------|--------|
18+
| **Rust** | 编译和运行引擎 | ✅ 必须 |
19+
| **Git** | 版本控制和克隆仓库 | ✅ 必须 |
20+
| **系统依赖库** | 图形和音频支持 | ✅ 必须 |
21+
| **代码编辑器** | 编写配置文件 | 🟡 推荐 |
22+
23+
```dialogue
24+
<path:/images/faces/toriel.png>
25+
* 让我们一件一件来准备吧。
26+
```
27+
28+
## 📦 Step 1: 安装 Rust
29+
30+
Rust 是 SoupRune 的核心语言。不用担心,你不需要学习 Rust 编程——它只是用来编译和运行引擎的。
31+
32+
### Windows
33+
34+
1. 访问 [https://rustup.rs/](https://rustup.rs/)
35+
2. 下载并运行 `rustup-init.exe`
36+
3. 按照提示完成安装(默认选项即可)
37+
4. 重启终端
38+
39+
**检查安装:**
40+
```bash
41+
rustc --version
42+
cargo --version
43+
```
44+
45+
如果看到版本号,说明安装成功了!
46+
47+
```dialogue
48+
<path:/images/faces/toriel.png>
49+
* 很好!第一步完成了。
50+
```
51+
52+
### Linux (Ubuntu/Debian)
53+
54+
首先安装系统依赖:
55+
```bash
56+
sudo apt-get update
57+
sudo apt-get install -y \
58+
g++ \
59+
pkg-config \
60+
libx11-dev \
61+
libasound2-dev \
62+
libudev-dev \
63+
libwayland-dev \
64+
libxkbcommon-dev
65+
```
66+
67+
然后安装 Rust:
68+
```bash
69+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
70+
source $HOME/.cargo/env
71+
```
72+
73+
**检查安装:**
74+
```bash
75+
rustc --version
76+
cargo --version
77+
```
78+
79+
### macOS
80+
81+
1. 打开终端
82+
2. 运行以下命令:
83+
```bash
84+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
85+
```
86+
3. 按照提示完成安装
87+
4. 运行 `source $HOME/.cargo/env`
88+
89+
**检查安装:**
90+
```bash
91+
rustc --version
92+
cargo --version
93+
```
94+
95+
## 🌐 Step 2: 安装 Git
96+
97+
Git 用于克隆 SoupRune 仓库和管理你的项目版本。
98+
99+
### Windows
100+
访问 [https://git-scm.com/downloads](https://git-scm.com/downloads) 下载安装包。
101+
102+
### Linux
103+
```bash
104+
sudo apt-get install git
105+
```
106+
107+
### macOS
108+
```bash
109+
brew install git
110+
# 或者使用 Xcode Command Line Tools
111+
xcode-select --install
112+
```
113+
114+
**检查安装:**
115+
```bash
116+
git --version
117+
```
118+
119+
## 💻 Step 3: 选择代码编辑器(推荐)
120+
121+
虽然用记事本也能编辑配置文件,但一个好的编辑器能让你事半功倍。
122+
123+
推荐的编辑器:
124+
125+
### 新手友好型
126+
- **[Visual Studio Code](https://code.visualstudio.com/)** — 功能强大,有丰富的插件
127+
- 推荐插件:`Even Better TOML`(用于编辑 RON 文件)
128+
- 推荐插件:`Rust Analyzer`(如果你打算写 Rust 脚本)
129+
130+
### 专业开发者
131+
- **[RustRover](https://www.jetbrains.com/rust/)** — JetBrains 出品的 Rust IDE
132+
- **[Neovim](https://neovim.io/)** — 如果你喜欢终端编辑器
133+
134+
```dialogue
135+
<path:/images/faces/toriel.png>
136+
* 选择你最熟悉的工具就好。
137+
* 就像有人喜欢木勺,有人喜欢铁勺一样。
138+
```
139+
140+
## 🍳 准备完成检查清单
141+
142+
在继续之前,请确认以下几点:
143+
144+
- [ ] Rust 已安装(`rustc --version` 能显示版本号)
145+
- [ ] Cargo 已安装(`cargo --version` 能显示版本号)
146+
- [ ] Git 已安装(`git --version` 能显示版本号)
147+
- [ ] (Linux)系统依赖库已安装
148+
- [ ] 代码编辑器已安装(推荐)
149+
150+
如果全部打勾,那你就准备好了!
151+
152+
## ⚠️ 常见问题
153+
154+
### "command not found: cargo"
155+
156+
这通常意味着 Rust 的路径没有被添加到环境变量中。
157+
158+
**解决方法:**
159+
```bash
160+
# Linux/macOS
161+
source $HOME/.cargo/env
162+
163+
# Windows (PowerShell)
164+
$env:PATH += ";$env:USERPROFILE\.cargo\bin"
165+
```
166+
167+
然后重启终端。
168+
169+
### Linux 编译时报错 "could not find system library"
170+
171+
确保安装了所有开发库:
172+
```bash
173+
sudo apt-get install -y \
174+
g++ \
175+
pkg-config \
176+
libx11-dev \
177+
libasound2-dev \
178+
libudev-dev \
179+
libwayland-dev \
180+
libxkbcommon-dev
181+
```
182+
183+
### Windows 上编译很慢
184+
185+
这是正常的!Rust 第一次编译会需要一些时间(10-30分钟)。后续的编译会快很多。
186+
187+
可以考虑:
188+
- 使用 `--release` 模式编译(更慢但运行快)
189+
- 升级到 SSD 硬盘
190+
- 增加虚拟内存
191+
192+
```dialogue
193+
<path:/images/faces/toriel.png>
194+
* 如果遇到其他问题,不要慌张...
195+
* 可以到我们的 Discord 社区寻求帮助。
196+
* 那里有很多热心的大厨会帮助你的。
197+
```
198+
199+
## 🎉 恭喜!
200+
201+
你已经准备好了所有的厨具!现在让我们真正点燃炉火吧。
202+
203+
---
204+
205+
**下一步:[第一次点火 →](0.3_quick_start.md)**

0 commit comments

Comments
 (0)