Explain how to open the project in the Godot editor and how to build binaries

Closes #4.
This commit is contained in:
blinry 2020-11-10 23:40:16 +01:00
parent 898f276eba
commit 5311e1d469
2 changed files with 8 additions and 4 deletions

View file

@ -4,16 +4,16 @@ all: linux macos windows
linux:
mkdir -p build/$(name)-linux
\godot --export "Linux" "build/$(name)-linux/$(name)"
godot --export "Linux" "build/$(name)-linux/$(name)"
cd build/$(name)-linux && zip -r ../$(name)-linux.zip .
macos:
mkdir -p build
\godot --export "Mac OS" "build/$(name)-macos.zip"
godot --export "Mac OS" "build/$(name)-macos.zip"
windows: dependencies/windows/git/
mkdir -p build/$(name)-windows
\godot --export "Windows" "build/$(name)-windows/$(name).exe"
godot --export "Windows" "build/$(name)-windows/$(name).exe"
cp -r --parents dependencies/windows/git/ build/$(name)-windows/
cd build/$(name)-windows && zip -r ../$(name)-windows.zip .

View file

@ -71,10 +71,14 @@ A level can consist of multiple repositories. To have more than one, you can use
At this stage, we're still exploring ourselves which kind of levels would be fun! So feel free to try new things: basic introductions with a little story? Really hard puzzles? Levels where you have to find information? Levels where you need to fix a problem? Levels with three remotes?
## Contributing code
## Contribute code!
To open the game in the [Godot editor](https://godotengine.org), run `godot project.godot`. You can then run the game using *F5*.
Feel free to make improvements to the code and send pull requests! There is one exception: because merge conflicts in Godot's scene files tends to be hard to resolve, before working on an existing *\*.tscn* file, please get in touch with us.
To build your own binaries, you'll need Godot's [export templates](https://docs.godotengine.org/en/stable/getting_started/workflow/export/exporting_projects.html), and `zip`, `wget`, and `7z`. Then, run `make`. On Debian/Ubuntu, the Godot binary is called `godot3`, you might need to adjust the paths in the Makefile.
## Code of Conduct
We have a [Code of Conduct](CODE_OF_CONDUCT.md) in place that applies to all project contributions, including issues and pull requests.