godot/modules/multiplayer
Rémi Verschelde 39facb35a0 SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.

New `target` presets
====================

The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:

- `editor`: Replaces `tools=yes target=release_debug`.
  * Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
  * Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
  * Defines: `-O3`/`/O2`

New `dev_build` option
======================

The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:

- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
  enables generating debug symbols, does not define `NDEBUG` so `assert()`
  works in thirdparty libraries, adds a `.dev` suffix to the binary name.

Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.

Changed binary names
====================

The name of generated binaries and object files are changed too, to follow
this format:

`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`

For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`

Be sure to update your links/scripts/IDE config accordingly.

More flexible `optimize` and `debug_symbols` options
====================================================

The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:

`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-26 16:31:46 +02:00
..
doc_classes Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
editor Add per-scene UndoRedo 2022-08-22 18:05:10 +02:00
SCsub SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
config.py [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
multiplayer_spawner.cpp Change return type of `get_configuration_warnings` to `PackedStringArray` 2022-09-19 16:43:15 +01:00
multiplayer_spawner.h Change return type of `get_configuration_warnings` to `PackedStringArray` 2022-09-19 16:43:15 +01:00
multiplayer_synchronizer.cpp Change return type of `get_configuration_warnings` to `PackedStringArray` 2022-09-19 16:43:15 +01:00
multiplayer_synchronizer.h Change return type of `get_configuration_warnings` to `PackedStringArray` 2022-09-19 16:43:15 +01:00
register_types.cpp [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
register_types.h [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
scene_cache_interface.cpp fix 'Comparison result is always the same' warnings 2022-07-29 19:45:22 +02:00
scene_cache_interface.h [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
scene_multiplayer.cpp [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
scene_multiplayer.h [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
scene_replication_config.cpp [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
scene_replication_config.h [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
scene_replication_interface.cpp document multiplayer replication classes, small changes to multiplayer spawner 2022-07-30 21:38:19 -05:00
scene_replication_interface.h [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
scene_replication_state.cpp Rename CONNECT_ONESHOT TO CONNECT_ONE_SHOT 2022-09-06 19:00:33 +02:00
scene_replication_state.h [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
scene_rpc_interface.cpp [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00
scene_rpc_interface.h [Net] Modularize multiplayer, expose MultiplayerAPI to extensions. 2022-07-26 09:31:12 +02:00