fixed readmd
This commit is contained in:
parent
2753f02a6e
commit
f963b514e5
39
ReadMe.md
39
ReadMe.md
|
@ -1,3 +1,38 @@
|
|||
A tiny engine made with C and Lua for 1MGames
|
||||
为了1MGames创建的陪跑游戏。游戏采用主题**“无限”**。玩家扮演一个枪手,尽可能地杀光袭来的外星生物。
|
||||
|
||||
NOTE: **Under Windows, you must use MinGW to compile**
|
||||
# 下载
|
||||
|
||||
Github可以直接在Release界面找到Windows的可执行压缩包。
|
||||
Gitme可以在`版本发布`->`Git标签`下找到同样的压缩包。
|
||||
|
||||
# 编译
|
||||
|
||||
本仓库的本体是一个基于C和Lua的游戏框架(TinyHazelEngine),所以当你使用cmake编译后并不会得到游戏本身,而是得到这个游戏框架。
|
||||
|
||||
本仓库目前只能在Windows下编译成功(因为我懒得写音频处理,直接用了Windows的API):
|
||||
|
||||
拉取工程后首先拉取其子工程
|
||||
|
||||
```bash
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
然后使用cmake编译(**十分推荐使用MinGW编译,因为他编译出来的库名称是libhazel.dll和libhazel_core.dll,而MSVC和Clang是hazel.dll和hazel_core.dll,这意味着Lua会找不到对应的库(除非你重命名)**):
|
||||
|
||||
```bash
|
||||
cmake -S . -B build -G"MinGW Makefiles"
|
||||
```
|
||||
|
||||
然后安装到`install`文件夹:
|
||||
|
||||
```bash
|
||||
cmake --build build --target install
|
||||
```
|
||||
|
||||
游戏本体在`game`文件夹下,所以你需要将`install`文件夹内的所有`.dll`文件和`HazelRunner.exe`拷贝到`game`文件夹下。
|
||||
|
||||
然后双击`game/HazelRunner.exe`就可以打开游戏了。
|
||||
|
||||
# 体积过大
|
||||
|
||||
游戏最后的可执行文件和库是经过压缩的(先`strip`再`upx`),最后结果超出1M很正常。
|
Reference in New Issue