Readd shared library module compilation docs#11820
Closed
dementive wants to merge 1 commit intogodotengine:masterfrom
Closed
Readd shared library module compilation docs#11820dementive wants to merge 1 commit intogodotengine:masterfrom
dementive wants to merge 1 commit intogodotengine:masterfrom
Conversation
AThousandShips
requested changes
Mar 5, 2026
| and as a shared library when passing ``summator_shared=yes``. | ||
|
|
||
| Finally, you can even speed up the build further by explicitly specifying your | ||
| shared module as target in the SCons command: |
Member
There was a problem hiding this comment.
Suggested change
| shared module as target in the SCons command: | |
| shared module as the target in the SCons command: |
| # Static compilation | ||
| module_env.add_source_files(env.modules_sources, sources) | ||
|
|
||
| Now by default ``scons`` command will build our module as part of Godot's binary |
Member
There was a problem hiding this comment.
Suggested change
| Now by default ``scons`` command will build our module as part of Godot's binary | |
| Now by default the ``scons`` command will build our module as part of Godot's binary |
| ./bin/godot* | ||
|
|
||
| .. note:: | ||
| You have to ``export`` the environment variable. Otherwise, |
Member
There was a problem hiding this comment.
Suggested change
| You have to ``export`` the environment variable. Otherwise, | |
| You have to ``export`` the environment variable. Otherwise, |
|
|
||
|
|
||
| On top of that, it would be nice to be able to select whether to compile our | ||
| module as shared library (for development) or as a part of the Godot binary |
Member
There was a problem hiding this comment.
Suggested change
| module as shared library (for development) or as a part of the Godot binary | |
| module as a shared library (for development) or as a part of the Godot binary |
|
|
||
| # LIBPATH and LIBS need to be set on the real "env" (not the clone) | ||
| # to link the specified libraries to the Godot executable. | ||
|
|
|
|
||
| env.Append(LIBPATH=['#bin']) | ||
|
|
||
| # SCons wants the name of the library with it custom suffixes |
Member
There was a problem hiding this comment.
Suggested change
| # SCons wants the name of the library with it custom suffixes | |
| # SCons wants the name of the library with its custom suffixes |
Calinou
added
enhancement
area:engine details
Calinou
reviewed
Mar 16, 2026
| # Don't inject Godot's dependencies into our shared library. | ||
| module_env['LIBS'] = [] | ||
|
|
||
| # Required for symbols from godot to link when rebuilding shared library. |
Member
There was a problem hiding this comment.
Suggested change
| # Required for symbols from godot to link when rebuilding shared library. | |
| # Required for symbols from Godot to link when rebuilding shared library. |
Calinou
reviewed
Mar 16, 2026
Comment on lines
+453
to
+458
|
|
||
|
|
||
| Once compiled, we should end up with a ``bin`` directory containing both the | ||
| ``godot*`` binary and our ``libsummator*.so``. However given the .so is not in | ||
| a standard directory (like ``/usr/lib``), we have to help our binary find it | ||
| during runtime with the ``LD_LIBRARY_PATH`` environment variable: |
Member
There was a problem hiding this comment.
Remove extraneous blank line:
Suggested change
| Once compiled, we should end up with a ``bin`` directory containing both the | |
| ``godot*`` binary and our ``libsummator*.so``. However given the .so is not in | |
| a standard directory (like ``/usr/lib``), we have to help our binary find it | |
| during runtime with the ``LD_LIBRARY_PATH`` environment variable: | |
| Once compiled, we should end up with a ``bin`` directory containing both the | |
| ``godot*`` binary and our ``libsummator*.so``. However given the .so is not in | |
| a standard directory (like ``/usr/lib``), we have to help our binary find it | |
| during runtime with the ``LD_LIBRARY_PATH`` environment variable: |
Calinou
reviewed
Mar 16, 2026
Comment on lines
+468
to
+470
|
|
||
|
|
||
| On top of that, it would be nice to be able to select whether to compile our |
Member
There was a problem hiding this comment.
Remove extraneous blank line:
Suggested change
| On top of that, it would be nice to be able to select whether to compile our | |
| On top of that, it would be nice to be able to select whether to compile our |
Calinou
reviewed
Mar 16, 2026
Member
Calinou
left a comment
Calinou
left a comment
There was a problem hiding this comment.
Should be good to merge after applying suggestions.
Contributor
|
Closing this due to the lack of a response to reviews for over a month. If the original author wishes to update this please do so and @ me to re-open this PR. If another maintainer wishes to salvage this PR with another one, or commit to the branch, feel free to. I personally am not doing so due to my limited C++ experience, I wouldn't be able to update or maintain this in the future. |
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
4 participants
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.
Adds back the shared library custom module compilation documentation that was removed in 160aa37 and adds the missing parts that were making it not work.
The original documentation was flawed because it was missing the
-rdynamicflag (see: https://stackoverflow.com/a/24016413) but with it compiling as a shared library works as expected. I have been using this for about a year and a half now and it has continued to work the same without any problems.For me this is a core part of my workflow as it brings my compile times down to 0.5-2 seconds depending on the file but without it compiles take around 8-10 seconds because of the time it takes to link the full binary for every build. Would be great to have this documentation back up because hopefully someone smarter than me will see it in the future and work out how to get this to work on Windows too if that is even possible.