CONTRIBUTING.md

Requirements

• Godot 4.2.2+
• Rust 1.27.0+

Tech stack

• Godot Engine
• Rapier
• godot-rust (Rust bindings for GDExtension)

Guidelines

• Follow semver when releasing new versions
• If functionality doesn't need to directly interact with Rapier and doesn't need to be optimized, prefer writing it in GDScript
• Any mutations to the Rapier pipeline need to be fed through the action queue in order to ensure determinism

Development quickstart

1. Open this project in Godot
2. Make edits as desired
3. Run cargo build in the /addons/godot-rapier-3d/rust directory
4. The extension should automatically reload when Godot is refocused

Bugs

Please raise an issue and provide reproducible steps or a minimal reproduction project, which is a small Godot project which reproduces the issue, with no unnecessary files included.