godot-rust

Godot Rust Tools

This repository contains tools for working with Rust and Godot.

Prerequisites

Required

• Node.js – Used to run the scripts
• Rust – Used to run cargo commands

Optional

• Godot – Used to run necessary commands for Godot projects
  • Godot needs to be in your path to run the godot command
• Git – Used to run necessary commands for Git projects
  • Git needs to be in your path to run the git command

Commands

These are the supported commands.

# To see the information about the commands:
npx godot-rust@latest help

# To see the information about a specific command (where <command> is the command you want help for):
npx godot-rust@latest <command> -h

New Rust Project

This will create a new rust project with the necessary files to work with Godot.

To create a new project, run the following command, it has interactive prompts to help you create your project.

npx godot-rust@latest new

Convert Existing Godot Project

This will convert an existing Godot project to a Godot Rust project.

Run the command in a folder that contains a project.godot file, it has interactive prompts to help you convert your project.

• Add Rust to the project
  • Adds a new rust folder to the project
• Restructure the project and add Rust (Backup your project before running a restructure)
  • Moves the existing project to a <my-project>/godot folder
  • Creates a new Rust project in <my-project>/rust

npx godot-rust@latest convert

Add Tools

This will allow you to add tools that are available in the database. This supports three types of tools:

• Crates – Rust libraries
• Godot Asset Libraries – Godot assets
• Github Releases – Libraries that are from Github releases page marked as latest

npx godot-rust@latest add

Remove Tools

This will allow you to remove tools from your project.
Note: Currently this only supports removing Rust crates.

npx godot-rust@latest remove
# or
npx godot-rust@latest rm