Update gdextension_cpp_example.rst - #12333
Open
mmmmmmmmmmmmmmmmmmmdonuts-sys wants to merge 9 commits into
Open
Conversation
The previous documentation appeared to be out of date with regards to the setup which had recommended getting godot-cpp -b 4.x which are no longer available since 4.6 and beyond. Further, I feel we need to add build instructions for the godot-cpp module since without building it, none of the includes used afterwards are present and can be confusing to someone starting out why sprite2d.hpp is not available. Finally, I think most people using an IDE requires compile_commands.json to be present for their LSPs to work (for example I'm using clangd, and autocomplete wouldn't work until it generated) so I added a section to generate it. This hopefully will provide a more fluid intro without having to use reddit or forum posts to patch it together.
AThousandShips
requested changes
Sep 2, 2026
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The previous documentation appeared to be out of date with regards to the setup which had recommended getting godot-cpp -b 4.x which are no longer available since 4.6 and beyond. Further, I feel we need to add build instructions for the godot-cpp module since without building it, none of the includes used afterwards are present and can be confusing to someone starting out why sprite2d.hpp is not available. Finally, I think most people using an IDE requires compile_commands.json to be present for their LSPs to work (for example I'm using clangd, and autocomplete wouldn't work until it generated) so I added a section to generate it. This hopefully will provide a more fluid intro without having to use reddit or forum posts to patch it together.