Skip to content

Conversation

@GreenCrowDev
Copy link

Since https://docs.godotengine.org/en/stable/contributing/development/core_and_modules/binding_to_external_libraries.html exists for C++ modules, it could be a good idea to have a manual about how to setup external libraries with GDExtension.

I think it's important to explain the most common issues a user can encounter when trying to bind external libraries, such as compiler errors, and how to fix them.

Godot Engine is probably one of the best platforms to develop on top for beginners and intermediates that want to grow as open source contributors and developers.

I open this draft so that I can gather suggestions while I try to write this section during my current trial and error.

The worst stumbling blocks right have been linking and godotengine/godot-cpp#1469 godotengine/godot-cpp#1319 godotengine/godot-cpp#957

@@ -0,0 +1,4 @@
.. _gdextension_binding_to_external_libraries:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. _gdextension_binding_to_external_libraries:
.. _doc_gdextension_binding_to_external_libraries:

I know this is nowhere near review but FYI we prefix the doc anchors like this

@skyace65
Copy link
Contributor

skyace65 commented Feb 5, 2025

@GreenCrowDev is this PR something you're still working on or plan to work on?

@tetrapod00
Copy link
Contributor

It looks like @paddy-exe already has plans to write a similar page as mentioned in #10570 (review). Since this is in such an early state, I think I'd recommend closing to avoid duplicating work.

@GreenCrowDev
Copy link
Author

I'm too busy right now, sorry.
We can close this as you mentioned someone is doing a similar contribution!

@tetrapod00 tetrapod00 closed this Feb 5, 2025
@tetrapod00
Copy link
Contributor

Closed per the above comments. Thanks nonetheless, it is a good idea to document this.

In the future, if you only have an overall outline for a new page or addition, it might be better to make an issue first so that the work can be picked up by other contributors later

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants