Repository files navigation

Website |Book |API Docs |Discord |Mastodon |Twitter |Sponsor

gdext is a library to integrate the Rust language with Godot 4.

Godot is an open-source game engine, focusing on a productive and batteries-included 2D and 3D experience.
ItsGDExtension API allows integrating third-party languages and libraries.

Rust bindings for Godot 3 (GDNative API) are available ingdnative.

The Rust binding is an alternative to GDScript, with a focus on type safety, scalability and performance.

The primary goal of gdext is to provide apragmatic Rust API for game developers.

Recurring workflows should be simple and require minimal boilerplate. APIs are designed to be safe and idiomatic Rust wherever possible.Due to interacting with Godot as a C++ engine, we sometimes follow unconventional approaches to provide a good user experience.

The gdext library has evolved a lot during 2023 and 2024 and is now in a usable state for smaller projects.However, there are still certain things to keep in mind.

Features: Most Godot APIs have been mapped at this point. The current focus lies on a more natural Rust experience and enable more designpatterns that come in handy for day-to-day game development. See#24 for an up-to-date feature overview.

At the moment, there is experimental support forWasm,Android andiOS, but documentation and tooling is still lacking. Contributions are very welcome!

Bugs: Most undefined behavior related to the FFI layer has been ironed out, but there may still be occasional safety issues. Apart from that,new additions to the library are typically not feature-complete from the start, but become more robust with feedback and testing over time.To counter bugs, we have an elaborate CI suite including clippy, unit tests, engine integration tests and memory sanitizers. Even hot-reload is tested!

To dive into Rust development with gdext, check outthe godot-rust book. The book is still under construction,but already covers aHello World setup as well as several more in-depth chapters.

To consult the API reference, have a look at the onlineAPI Docs.

Furthermore, we provide some practical examples and small games in thedemo-projects repository.

If you need help, join ourDiscord server and ask in the#help channel!

We use theMozilla Public License 2.0. MPL tries to find a balance between permissive (MIT, Apache, Zlib) and copyleft licenses (GPL, LGPL).

The license provides a lot of freedom: you can use the library commercially and keep your own code closed-source,i.e. game development is not restricted. The main condition is that if you change gdextitself, you need to makethose changes available (and only those, no surrounding code).

Contributions are very welcome! If you want to help out, seeContributing.md for some pointers on getting started.