godot-rust / gdnative-book

The user guide for godot-rust.

gdnative book

The gdnative book is a user guide for the gdnative library, the Rust bindings to Godot 3.

An online version of the book is available at godot-rust.github.io/gdnative-book. For the gdext book (Godot 4), check out gdext-book.

The book is built with mdBook and the plugins mdbook-toc and mdbook-admonish. To install them and build the book locally, you can run:

$ cargo install mdbook mdbook-toc mdbook-admonish
$ mdbook build

To run a local server with automatic updates while editing the book, use:

$ mdbook serve --open

Contributing

This repository is for documentation only. Please open pull requests targeting the libraries themselves in the main repos for the Godot 3 and Godot 4 bindings.

For contributions, see the contributing guidelines under CONTRIBUTING.md in the above-mentioned repositories.

License

Any contribution intentionally submitted for inclusion in the work by you shall be licensed under the MIT license, without any additional terms or conditions.