https://github.com/godot-rust/gdnative-book
The user guide for godot-rust.
https://github.com/godot-rust/gdnative-book
Last synced: 6 months ago
JSON representation
The user guide for godot-rust.
- Host: GitHub
- URL: https://github.com/godot-rust/gdnative-book
- Owner: godot-rust
- License: mit
- Created: 2020-06-30T03:57:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-16T10:44:03.000Z (10 months ago)
- Last Synced: 2025-03-31T06:07:02.271Z (9 months ago)
- Language: CSS
- Homepage: https://godot-rust.github.io/book
- Size: 9.62 MB
- Stars: 63
- Watchers: 9
- Forks: 42
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# gdnative book
The gdnative book is a user guide for the [gdnative library][gdnative], the Rust bindings to Godot 3.
An online version of the book is available at [godot-rust.github.io/gdnative-book][book-web].
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:
```bash
$ cargo install mdbook mdbook-toc mdbook-admonish
$ mdbook build
```
To run a local server with automatic updates while editing the book, use:
```bash
$ 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.
[gdnative]: https://github.com/godot-rust/gdnative
[book-web]: https://godot-rust.github.io/gdnative-book
[gdext-book]: https://github.com/godot-rust/book
[mdBook]: https://github.com/rust-lang-nursery/mdBook
[mdbook-toc]: https://github.com/badboy/mdbook-toc
[mdbook-admonish]: https://github.com/tommilligan/mdbook-admonish
[Godot 3]: https://github.com/godot-rust/gdnative
[Godot 4]: https://github.com/godot-rust/gdext
[MIT license]: LICENSE.md