ftw

A CLI tool to manage your godot-rust project!

Table of contents

General Information

This is a tool to help you manage your game project by providing commands to (1) create a project, (2) create a class, (3) create a singleton class, (4) build the library, (5) run your project (and more to come in the future!). Its like rails but for game development :wink:

Setup

It leverages tools like cargo-generate and godot (obviously!) to make it all work!

shell $ cargo install cargo-generate $ cargo install ftw

Usage

ftw new <project-name> [template]

Creates a new project directory

shell $ ftw new my-awesome-game # this creates a new project using the default template $ ftw new my-awesome-game default # same as above $ ftw new my-awesome-game /path/to/custom/template # creates a new project using a custom template

Note: The custom template should have same structure as the default template

ftw class <class-name> [node-type]

Creates a class

shell $ ftw class MyHero # creates a class called `MyHero` that is deriving from `Node` as default $ ftw class MyHero Area2D # creates a class that derives from `Area2D`

Note: This creates the following files rust/src/my_hero.rs, godot/scenes/MyHero.tscn and godot/native/MyHero.gdns then adds the class inside rust/src/lib.rs

ftw singleton <class-name>

Creates a singleton class for autoloading

shell $ ftw singleton MySingleton # creates a class called `MySingleton` that derives from `Node`

Note: This creates the following rust/src/my_singleton.rs and godot/native/MySingleton.gdns then adds the class inside rust/src/lib.rs

ftw build [target] [build-type]

Builds the library for a particular target

shell $ ftw build # builds the library for your current platform as target using `debug` as default $ ftw build linux-x86_64 # builds the library for the `linux-x86_64` platform using `debug` as default $ ftw build linux-x86_64 debug # same as above $ ftw build linux-x86_64 release # builds the library for the `linux-x86_64` platform using `release`

[target] can be one of the following

ftw export [target] [build-type]

Exports the game for a particular target

shell $ ftw export # exports the game for your current platform as target using `debug` as default $ ftw export linux-x86_64 # exports the game for the `linux-x86_64` platform using `debug` as default $ ftw export linux-x86_64 debug # same as above $ ftw export linux-x86_64 release # exports the game for the `linux-x86_64` platform using `release`

ftw run

Builds the library using debug then runs your game

shell $ ftw run # enjoy! 😆

Contact

Michael Angelo Calimlim <macalimlim@gmail.com>