Virtualx Game Engine. Forked from Godot 3.6
Find a file
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
.github SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
core SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
doc Merge pull request #66290 from 4d49/physics2d-area-methods 2022-09-25 17:08:55 +02:00
drivers SCons: Cleanup DEBUG, _DEBUG and NDEBUG defines 2022-09-23 15:21:26 +02:00
editor SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
main Fix project manager not working in self-contained mode 2022-09-24 13:15:11 -05:00
misc SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
modules SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
platform SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
scene Merge pull request #61336 from KoBeWi/where_are_you_going 2022-09-26 15:51:22 +02:00
servers Style: Cleanup header guards for consistency 2022-09-26 13:51:17 +02:00
tests Add more tests for Vector* types 2022-09-25 22:58:58 -05:00
thirdparty Merge pull request #66004 from bruvzg/hb52 2022-09-18 00:43:49 +02:00
.clang-format Style: Workaround clang-format 14 bug with Inline oneliner functions 2022-08-03 12:20:23 +02:00
.clang-tidy Style: Partially apply clang-tidy's cppcoreguidelines-pro-type-member-init 2022-05-02 16:28:25 +02:00
.editorconfig Add a simple C# .editorconfig 2021-07-23 17:04:53 -04:00
.git-blame-ignore-revs Add Git blame ignore revisions file (used by GitHub's blame view) 2022-03-24 21:50:47 +01:00
.gitattributes File: Re-add support to skip CR (\r) in File::get_as_text 2022-08-01 00:40:35 +02:00
.gitignore Add ability to extend the set of Git pre-commit hooks 2022-08-30 13:34:10 +02:00
.lgtm.yml
.mailmap Update AUTHORS and DONORS list 2022-07-25 16:27:42 +02:00
AUTHORS.md Update AUTHORS and DONORS list 2022-07-25 16:27:42 +02:00
CHANGELOG.md Implement Physical Light Units as an optional setting. 2022-08-31 12:14:46 -07:00
CONTRIBUTING.md Unify bits, arch, and android_arch into env["arch"] 2022-08-25 11:19:20 +02:00
COPYRIGHT.txt etcpak: Update to upstream release 1.0 (June 4, 2022) 2022-06-10 12:36:45 +02:00
DONORS.md Update AUTHORS and DONORS list 2022-07-25 16:27:42 +02:00
gles3_builders.py ci: add basic test pipeline for shader builders 2022-08-19 20:32:13 +09:00
glsl_builders.py ci: add basic test pipeline for shader builders 2022-08-19 20:32:13 +09:00
icon.png Remove two very slightly displaced duplicate vertices on Gobot's face 2020-12-11 07:05:54 +01:00
icon.svg Remove two very slightly displaced duplicate vertices on Gobot's face 2020-12-11 07:05:54 +01:00
icon_outlined.png Add an outlined version of logo.png and icon.png and put it in README.md 2020-12-14 06:42:51 +01:00
icon_outlined.svg Add an outlined version of logo.png and icon.png and put it in README.md 2020-12-14 06:42:51 +01:00
LICENSE.txt Update copyright statements to 2022 2022-01-03 21:27:34 +01:00
logo.png Remove two very slightly displaced duplicate vertices on Gobot's face 2020-12-11 07:05:54 +01:00
logo.svg Remove two very slightly displaced duplicate vertices on Gobot's face 2020-12-11 07:05:54 +01:00
LOGO_LICENSE.md Relicense Godot logo from CC-BY-3.0 to CC-BY-4.0 2020-12-03 14:30:06 +01:00
logo_outlined.png Add an outlined version of logo.png and icon.png and put it in README.md 2020-12-14 06:42:51 +01:00
logo_outlined.svg Add an outlined version of logo.png and icon.png and put it in README.md 2020-12-14 06:42:51 +01:00
methods.py SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
platform_methods.py Unify bits, arch, and android_arch into env["arch"] 2022-08-25 11:19:20 +02:00
README.md [Web] Rename JavaScript platform to Web. 2022-08-29 11:52:00 +02:00
SConstruct SCons: Unify tools/target build type configuration 2022-09-26 16:31:46 +02:00
version.py Bump version to 4.0-beta \o/ 2022-09-15 01:47:27 +02:00

Godot Engine

Godot Engine logo

2D and 3D cross-platform game engine

Godot Engine is a feature-packed, cross-platform game engine to create 2D and 3D games from a unified interface. It provides a comprehensive set of common tools, so that users can focus on making games without having to reinvent the wheel. Games can be exported with one click to a number of platforms, including the major desktop platforms (Linux, macOS, Windows), mobile platforms (Android, iOS), as well as Web-based platforms and consoles.

Free, open source and community-driven

Godot is completely free and open source under the very permissive MIT license. No strings attached, no royalties, nothing. The users' games are theirs, down to the last line of engine code. Godot's development is fully independent and community-driven, empowering users to help shape their engine to match their expectations. It is supported by the Software Freedom Conservancy not-for-profit.

Before being open sourced in February 2014, Godot had been developed by Juan Linietsky and Ariel Manzur (both still maintaining the project) for several years as an in-house engine, used to publish several work-for-hire titles.

Screenshot of a 3D scene in the Godot Engine editor

Getting the engine

Binary downloads

Official binaries for the Godot editor and the export templates can be found on the homepage.

Compiling from source

See the official docs for compilation instructions for every supported platform.

Community and contributing

Godot is not only an engine but an ever-growing community of users and engine developers. The main community channels are listed on the homepage.

The best way to get in touch with the core engine developers is to join the Godot Contributors Chat.

To get started contributing to the project, see the contributing guide.

Documentation and demos

The official documentation is hosted on ReadTheDocs. It is maintained by the Godot community in its own GitHub repository.

The class reference is also accessible from the Godot editor.

We also maintain official demos in their own GitHub repository as well as a list of awesome Godot community resources.

There are also a number of other learning resources provided by the community, such as text and video tutorials, demos, etc. Consult the community channels for more information.

Code Triagers Badge Translate on Weblate Total alerts on LGTM TODOs