Files
Blitz3/README.md
Persson-dev 1df9f2c46d
All checks were successful
Linux arm64 / Build (push) Successful in 1m38s
add lfs instructions
2024-08-22 10:55:13 +02:00

42 lines
888 B
Markdown

# Blitz3
The best FPS you've ever seen !
## Install xmake
Install xmake from [here](https://xmake.io/#/guide/installation).
## Cloning
You need git lfs.
If cloning with ssh, you should `git config --global http.sslCAInfo ~/.ssh/id_rsa` first,
else lfs will fail to download the assets
## How to use
You must have [godot](https://godotengine.org/) in your path
```sh
# 1. build the project
xmake f -m debug && xmake
# 2. open the editor at least once
xmake run Editor
# 3. run the demo
xmake run
# 4. export the project, the executable will be under "publish" folder by default
xmake p
# 5. clean the build and publish
xmake clean
# 6. generate a class that inherits from godot class, like Sprite2D
# by default the generated files will save under "src" folder, you can change it by -d folder/under/src
xmake ext-class -n MySprite2D -b Sprite2D -s myexample1 -d sample
```