Skip to content

Update gdextension_cpp_example.rst - #12333

Open
mmmmmmmmmmmmmmmmmmmdonuts-sys wants to merge 9 commits into
godotengine:masterfrom
mmmmmmmmmmmmmmmmmmmdonuts-sys:patch-1
Open

Update gdextension_cpp_example.rst#12333
mmmmmmmmmmmmmmmmmmmdonuts-sys wants to merge 9 commits into
godotengine:masterfrom
mmmmmmmmmmmmmmmmmmmdonuts-sys:patch-1

Conversation

@mmmmmmmmmmmmmmmmmmmdonuts-sys

Copy link
Copy Markdown

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.

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.
Comment thread tutorials/scripting/cpp/gdextension_cpp_example.rst
Comment thread tutorials/scripting/cpp/gdextension_cpp_example.rst Outdated
Comment thread tutorials/scripting/cpp/gdextension_cpp_example.rst
Comment thread tutorials/scripting/cpp/gdextension_cpp_example.rst Outdated
Comment thread tutorials/scripting/cpp/gdextension_cpp_example.rst Outdated
Comment thread tutorials/scripting/cpp/gdextension_cpp_example.rst
Comment thread tutorials/scripting/cpp/gdextension_cpp_example.rst Outdated
Comment thread tutorials/scripting/cpp/gdextension_cpp_example.rst Outdated
@Mickeon Mickeon added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation topic:gdextension labels 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:gdextension

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants