Skip to content

Commit

Permalink
docs:fix build guide
Browse files Browse the repository at this point in the history
  • Loading branch information
limuy2022 committed Jul 12, 2024
1 parent 5f4ba2c commit 81cb90c
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/build-guide-zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# 构建指南

| 依赖 |
| :---------------- |
| Godot 4.3 |
| Gettext |
| Protobuf Compiler |
| Rust Compiler |

关于Protobuf Compiler,我们首先会在本地查找是否存在protoc,如果存在可用的编译器,我们会直接采用,对于某些特殊需求,例如protoc版本过低等,我们也提供了自动编译protoc的选项,该选项默认关闭,可以通过`cargo build --package proto --features protobuf_feature`来启用捆绑的protoc,
注意,该选项可能使你的构建目录增大,构建时间增长若干倍,仍然建议提前安装好protoc

接下来,你可以运行`cd script && python build.py`来构建extension(Debug和Release)

最终,你可以启动godot编辑器来开发或导出游戏.
16 changes: 16 additions & 0 deletions docs/build-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Build Guide

| dependencies |
| :---------------- |
| Godot 4.3 |
| Gettext |
| Protobuf Compiler |
| Rust Compiler |

Regarding the Protobuf Compiler, we first check for the existence of a local protoc executable. If a usable compiler is found, it will be utilized directly. For certain special requirements, such as when the protoc version is too low, we also provide an option to
automatically compile a bundled protoc. This option is turned off by default and can be enabled by using `cargo build --package proto --features protobuf_feature`. Note that this option may significantly increase your build directory size and extend the build time by
several times. It is still recommended to install protoc in advance.

Then you can run `cd script && python build.py` to build the extension (both Debug and Release)

Finally,you can start godot editor and develop or export the game.
Empty file removed docs/development-guide-zh.md
Empty file.
Empty file removed docs/development-guide.md
Empty file.

0 comments on commit 81cb90c

Please sign in to comment.