Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dev_build and dev_mode flags to SCons compilation instructions for desktop editor pages #10019

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
5 changes: 5 additions & 0 deletions contributing/development/compiling/compiling_for_linuxbsd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,11 @@ Start a terminal, go to the root dir of the engine source code and type:
``linuxbsd``. If you are looking to compile Godot 3.x, make sure to use the
`3.x branch of this documentation <https://docs.godotengine.org/en/3.6/development/compiling/compiling_for_x11.html>`__.

If you wish to add and use breakpoints while developing, add dev_build=yes
jonathansekela marked this conversation as resolved.
Show resolved Hide resolved
and dev_mode=yes to the command::
jonathansekela marked this conversation as resolved.
Show resolved Hide resolved

scons platform=linuxbsd arch=x86_64 dev_build=yes dev_mode=yes

If all goes well, the resulting binary executable will be placed in the
"bin" subdirectory. This executable file contains the whole engine and
runs without any dependencies. Executing it will bring up the Project
Expand Down
5 changes: 5 additions & 0 deletions contributing/development/compiling/compiling_for_macos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ To support both architectures in a single "Universal 2" binary, run the above tw

lipo -create bin/godot.macos.editor.x86_64 bin/godot.macos.editor.arm64 -output bin/godot.macos.editor.universal

If you wish to add and use breakpoints while developing, add dev_build=yes
jonathansekela marked this conversation as resolved.
Show resolved Hide resolved
and dev_mode=yes to the command::
jonathansekela marked this conversation as resolved.
Show resolved Hide resolved

scons platform=macos arch=x86_64 dev_build=yes dev_mode=yes

If all goes well, the resulting binary executable will be placed in the
``bin/`` subdirectory. This executable file contains the whole engine and
runs without any dependencies. Executing it will bring up the Project
Expand Down
7 changes: 7 additions & 0 deletions contributing/development/compiling/compiling_for_windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,13 @@ the engine source code (using ``cd``) and type:
.. note:: When compiling with multiple CPU threads, SCons may warn about
pywin32 being missing. You can safely ignore this warning.

If you wish to add and use breakpoints while developing, add dev_build=yes
jonathansekela marked this conversation as resolved.
Show resolved Hide resolved
and dev_mode=yes to the command:
jonathansekela marked this conversation as resolved.
Show resolved Hide resolved

.. code-block:: doscon

C:\godot> scons platform=windows dev_build=yes dev_mode=yes

If all goes well, the resulting binary executable will be placed in
``C:\godot\bin\`` with the name ``godot.windows.editor.x86_32.exe`` or
``godot.windows.editor.x86_64.exe``. By default, SCons will build a binary matching
Expand Down