Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Daylily-Zeleen committed Jul 30, 2023
1 parent 6baa03c commit 2ad3f23
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 29 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# GUS - Godot Universal Serializer 2.1.5 - Godot的通用序列化器 - V2.1.5(Godot 4.1 stable)
# GUS - Godot Universal Serializer 2.1.6 - Godot的通用序列化器 - V2.1.6(Godot 4.1 stable)

![Image text](icon.png)

Expand All @@ -25,10 +25,6 @@ Support all data types except `Object`, `RID`, `Callable` and `Signal` in Godot
1. `Array` and `Dictionary` should not contain `Object`, `RID`, `Callable` and `Signal`.



# TODO:
1. Handle endian.

# How to compile:
1. Follow [offical tutorial](https://docs.godotengine.org/zh_CN/stable/development/compiling/index.html) to set up you develop enviroment.
2. Clone this repository (with submodule).
Expand Down Expand Up @@ -58,10 +54,15 @@ Support all data types except `Object`, `RID`, `Callable` and `Signal` in Godot
python build.py -h
```

Specially, if you not specify the argument `target`, this tool will build both `target=template_debug` and `target=template_release`.
**Specially**:
- If you not specify the argument `target`, this tool will build both `target=template_debug` and `target=template_release`.
- If you add argument `dev_build`, this tool will copy and rename the built shared libraries to `dist` folder with replacing `.dev.` to `.` (in order to avoid edit `gus2.gdextension`).

5. Now, you can get the addon which be located at `dist`.

5. Now, you can get the addon which be located at `\demo\addons\com.daylily_zeleen.godot_universal_serializer\`, or get the packed addon at `bin\com.daylily_zeleen.godot_universal_serializer.zip`.
(Notice: if your use `scons` instead of `python build_tool`, you can only get dynamic library at `bin` folder.)
**Notice**:
- If your use `scons` instead of `python build_tool`, you can only get dynamic library at `bin` folder.
- If build for `macos`, its binaries will generate at `dist` directly.

# Benchmark 2.1.5:
```
Expand Down
42 changes: 21 additions & 21 deletions README_zh_cn.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# GUS - Godot Universal Serializer 2.1.5 - Godot的通用序列化器 - V2.1.5(Godot 4.1 stable)
# GUS - Godot Universal Serializer 2.1.6 - Godot的通用序列化器 - V2.1.6(Godot 4.1 stable)

![Image text](icon.png)

Expand All @@ -26,11 +26,6 @@
1. `Array``Dictionary` 不能包含 `Object``RID``Callable`以及`Signal`



# TODO:
1. 处理大小端。


# 如何编译:
1. 根据[官方文档](https://docs.godotengine.org/zh_CN/stable/development/compiling/index.html)搭建你的编译环境。
2. 克隆这个仓库(以递归方式克隆,以包含子模块)。
Expand All @@ -45,21 +40,26 @@

- (推荐方式)在每次构建`GUS`时重复生成`godot-cpp`的绑定与构建其库,直接跳该步骤,在下个步骤的命令中添加参数`generate_bindings=yes build_library=yes`来显式要求该操作,或忽略这些参数以默认方式工作。
别担心,只要编译条件没有变化,重复生成与构建不会占用您太多时间。
4. 编译`GUS`与编译`godot-cpp`有一点小区别(当然你也可以继续使用`scons`命令进行构建),为了执行一些后处理,我使用一个简单的工具脚本进行编译:
导航到根目录,运行以下命令
```
python build.py
```

你可以像在编译`godot-cpp`一样对改命令添加其他参数。
你可以使用以下命令来查看更多参数详情:
```
python build.py -h
```

特别的,如果你没有明确`taget`参数,该脚本工具会同时编译`target=template_debug`和 `target=template_release`两种版本。
5. 现在,你可以在`\demo\addons\com.daylily_zeleen.godot_universal_serializer`获得该插件,或在`bin\com.daylily_zeleen.godot_universal_serializer.zip`获得打包好的插件。
(注意:如果你使用`scons`命令进行编译,你只能在`bin`文件夹下得到编译好的动态库。
4. 编译`GUS`与编译`godot-cpp`有一点小区别(当然你也可以继续使用`scons`命令进行构建),为了执行一些后处理,我使用一个简单的工具脚本进行编译:
导航到根目录,运行以下命令
```
python build.py
```

你可以像在编译`godot-cpp`一样对改命令添加其他参数。
你可以使用以下命令来查看更多参数详情:
```
python build.py -h
```

**特别的**:
- 如果你没有明确`taget`参数,该脚本工具会同时编译`target=template_debug`和 - target=template_release`两种版本。
- 如果添加了`dev_build=yes`参数,将在后处理复制二进制文件步骤中将该库文件名的``.dev.`替换为`.`供测试使用,避免修改`gus2.gdextension`文件。
5. 现在,你可以在`dist`获得该插件。

**注意**:
如果你使用`scons`命令进行编译,你只能在`bin`文件夹下得到编译好的动态库,如果为`macsos`构建,其二进制文件将直接于`dist`目录下生成。

# 基准测试 2.1.5:
```
null - value:<null>
Expand Down

0 comments on commit 2ad3f23

Please sign in to comment.