#Godot rust install#
#Godot rust mod#

Now that you've created the library, you can go into the newly created folder and see the config file.

#Godot rust mod#

Custom mods can be added to the file through godot-rust-helper mod as shown here (coming soon). Any modifications to the file will result in the modules not functioning properly or they will be overwritten when a module is created/destroyed. Note: The src/lib.rs file is completely managed by godot-rust-helper and should not be modified. The extensions are a new and growing feature so stay tuned to see what gets added to them and check out the documention in the extensions repository to see if and how you can use it in your modules.Ĭreating a default library for Windows only builds: $ godot-rust-helper new breakout_modules ~/Documents/projects/breakoutĬreating an library for Windows, Linux, and OSX builds: $ godot-rust-helper new breakout-modules ~/Documents/projects/breakout windows,linux,osx -extensions If this flag is passed the extensions dependency will be added to the library.By default if no targets are passed then just -targets=windows will be set. For example if you are targeting Windows and OSX, you need to have have cargo set to build a dll and a dylib file and you would pass -targets=windows,osx as the targets. -targets Native modules in Godot can target multiple platforms and godot-rust-helper needs to know ahead of time what platforms you plan to target your modules for with the available options currently being: windows, linux, and osx.path_to_godot_project This is the path to the root directory of the Godot project that the modules will belong to.Also keep in mind that the library is created using cargo new so you should abide by the cargo project naming standards. The name of the library is recommended to be the same or similar in name to your game. library_name The name of the library that will contain your Rust modules.Let's go over the arguments and options in detail with some examples. To create the project's library, navigate to where you would like to store the modules (outside of your Godot project directory) and use the new command: $ godot-rust-helper new The library itself is a cargo library and it holds all of the modules used in your game.

#Godot rust install#

Since godot-rust-helper is a CLI tool that is meant to be used whenever you want, you should install it globally like so: $ npm install -g godot-rust-helper Step 1: Creating the Project's Libraryįor each game you create in Godot you will have to create a new library. If you are looking for 1.x and below, you can find it here. Note: This is the documentation for the new 2.x version of godot-rust-helper.