README.md

June 4, 2025 · View on GitHub

Godot4 Rust VsCode Extension

Godot4-Rust

This extension aims to add a smoother experience using Rust with Godot

Features

Nice side panel showing your project's scenes

Add OnReady as simple as in Godot

Easy quick Derive new rust GodotClass from existing Godot Scene

Full project kickstart in one command

Lint your code and search for invalid node path/missing scene

Switch Godot Node by you Rust GodoClass

Create .gdextension file

Less boilerplate and speed up your worflow

Important

First you need to configure the linked Godot Project Use dedicated command to set it (Ctrl+Maj+P => Godot4-Rust: Set Godot Project)

Scene's Panel

Your scenes are shown with the following format:

godot base scene: Godot Icon, Scene pathe, (Rootnode), base type
rust godotclass based scene: ferris icon, Scene path, (RootNode name), GodotClass name -> baseclass

Changing godotclass rust module in editor will revel it in panel.

actions

via Right mouse click, context menu:

on Root Nodes

Easy quick Derive new rust GodotClass from existing Godot Scene
Switch Godot Node by you Rust GodoClass

on child Nodes

Add OnReady as simple as in Godot

https://github.com/user-attachments/assets/414b2b24-9177-4bed-8c98-b75a78f8f88f

Add `OnReady` as simple as in Godot

command: godot4-rust.insertOnReady

Adds fields automagically with correct Type and name. Struct must be init

insert on ready

https://github.com/user-attachments/assets/4a9904bf-6ff1-4570-8b82-b015ea439fd4

Derive new rust module from existing Godot Scene

command: Godot4-Rust: Create a new GodotClass from Godot Scene

by right clicking the panel or just run the command Create new godot class from scen
Select and existing Godot Scene from you project
You can choose to create a new rust module or use the active one (will add mod mymodule if needed)
Pick Godot Methods and OnReady you want to add
here you are !!!
There is in option to choose to automaticaly switch the type in godot scene.

https://github.com/user-attachments/assets/af8f9d93-9528-4980-8b57-63ca8d41cbf7

Less boiler plate and speed up workflow

Kickstart a new project

command: Start new godot rust project.

select project.godot file, crate name and path
you get:
- New rust project
- configured Cargo.toml for last version of godot-rust
- workspace settings: godot project and rust analyzer check command updated
- lib.rs with ExtensionLibrary

Rust Analyzer Check Command updated

command: Godot4-Rust: Use 'build' as Rust Analyzer check command

Set worksapce settings so RA, uses build instead of check as check command. So your project is always compiled. Same parameters are given, only check is replaced by build

Code Linter

An error will be raised in panel if a godoclass or child scene is missing.

missing node

An error will be shown in code if node path doesn't exists for onready fields.

lint-error

Create .gdextension in your Godot Project

command: godot4-rust.createGdextension

First: Be sure to have run Set Godot Project command
Second: Run command Godot4-Rust: Create a the .gdextension file in your project, and that's it.

By default compatibility minimum is set following the value of your godot.project file.

gdextension

Switch Godot class by Rust godot class

command: godot4-rust.replaceBaseClass

In place modify your scene, to use godot class in active editor.

Extension Settings

This extension contributes the following settings:

godot4-rust.godotProjectFilePath: REQUIRED: selected the .godot project file. Use dedicated command to set it (Ctrl+Maj+P => Godot4-Rust: set Godot Project). It sets workspace only.
godot4-rust.autoReplaceInTscn: Auto replace Root Godot Node by Rust Godoclass after a new godotclass is generated. Default: false
godot4-rust.changeRustAnalyzerCheckCommandToBuild: Make Rust Analyzer use 'build' instead of 'check' as check command to autobuild extension. True enables it for every new project. Default: true
godot4-rust.nbWorkersToParseTscn: Fixed Number of workers to parse tscn files. Should not be set in most cases". Default: undefined
godot4-rust.newGodotClassDefaultVisibility:New Godot-class default visibility. Possible values: ", "pub", "pub(crate)", "pub(super)". Default: "pub"
godot4-rust.newGodotClassAutoInsertMod:How to insert (or not) mod in lib.rs or mod.rs (needs Rust-Analyzer) when adding new godot class", Possible values: "", "mod", "pub mod", "pub(crate) mod". Default": "mod"