Home

godot-rust-template

Create games with Godot game engine using the Rust programming language!

General Information

• this template bootstraps your Godot project using Rust as your primary language for development.

Setup

• make sure you have cargo-generate installed.
• install Godot

On Linux

• The binary godot should be visible on $PATH, if not then depending how you installed Godot (by using your distro's package manager or downloaded godot from the main website), symlink it in the /usr/local/bin folder. For example...

$ sudo ln -s /path/to/where/its/installed/Godot /usr/local/bin/godot

On MacOS X

• Install Xcode via the App Store

$ sudo xcode-select --switch /Applications/Xcode.app
$ brew install coreutils

• Put /usr/local/opt/coreutils/libexec/gnubin at the top of /etc/paths file
• The binary godot should be visible on $PATH, if not then depending how you installed Godot (by using brew or downloaded godot from the main website), symlink it in the /usr/local/bin folder. For example...

$ sudo ln -s /usr/local/Caskroom/godot/3.2.3/Godot.app/Contents/MacOS/Godot /usr/local/bin/godot

On Windows

• To follow...

Usage

• run this commands on your terminal

$ cargo generate --git https://github.com/godot-rust/godot-rust-template --name my-awesome-game
$ cd my-awesome-game
$ make run

• enjoy!

Please take note that it also generates a export_presets.cfg file for you, you might want to put that on .gitignore if you are planning to put confidential data in it...

Building and Exporting

These commands allows you to build the library and export it to a game.

for Linux

$ make build-i686-unknown-linux-gnu-debug
$ make export-i686-unknown-linux-gnu-debug

$ make build-i686-unknown-linux-gnu-release
$ make export-i686-unknown-linux-gnu-release

$ make build-x86_64-unknown-linux-gnu-debug
$ make export-x86_64-unknown-linux-gnu-debug

$ make build-x86_64-unknown-linux-gnu-release
$ make export-x86_64-unknown-linux-gnu-release

for Android

To be able to deploy the game to your phone or publish it to Google Play, keystore files must be created first.

$ make create-debug-keystore
$ make create-release-keystore

$ make build-aarch64-linux-android-debug
$ make export-aarch64-linux-android-debug

$ make build-aarch64-linux-android-release
$ make export-aarch64-linux-android-release

$ make build-armv7-linux-androideabi-debug
$ make export-armv7-linux-androideabi-debug

$ make build-armv7-linux-androideabi-release
$ make export-armv7-linux-androideabi-release

$ make build-i686-linux-android-debug
$ make export-i686-linux-android-debug

$ make build-i686-linux-android-release
$ make export-i686-linux-android-release

$ make build-x86_64-linux-android-debug
$ make export-x86_64-linux-android-debug

$ make build-x86_64-linux-android-release
$ make export-x86_64-linux-android-release

for MacOS

$ make build-x86_64-apple-darwin-debug
$ make export-x86_64-apple-darwin-debug

$ make build-x86_64-apple-darwin-release
$ make export-x86_64-apple-darwin-release

for iOS

to follow...

for Windows

to follow...

Contributing

PRs are welcome! 😄, please see the contribution guidelines

License

MIT License