Godot Engine – Multi-platform 2D and 3D game engine
Go to file
Rémi Verschelde db26871210 SCons: Add `production=yes` option to use production defaults
This is meant for users making custom builds to match the options used on
optimized, official builds.

This enables, on the platforms which support them:
- `use_static_cpp=yes` (portable binaries for Linux and Windows)
- `use_lto=yes` (link time optimizations - note: requires a lot of RAM!)
- `debug_symbols=no` (no debug symbols, smaller binaries)

Also abort when using MSVC with `production=yes`, as:
- It cannot optimize the GDScript VM like GCC or Clang do, leading to
  significant performance drops.
- Its LTO support is unreliable, at least used to trigger crashes last
  we tried it extensively.

All options can still be overridden if specified, and the `dev=yes` option
was changed to also support overrides.
2021-02-03 11:48:17 +01:00
.github CI: Update to clang-format 11 and apply ternary operator changes 2021-01-12 19:32:53 +01:00
core Merge pull request #45658 from RandomShaper/fix_frozen_peak 2021-02-03 10:05:34 +01:00
doc Merge pull request #45593 from lyuma/audio_effect_capture 2021-02-02 22:14:58 +01:00
drivers Always init `DEBUG_UTILS_MESSENGER_CREATE_INFO` structure if `DEBUG_UTILS` functions are used. Add temporary variables to fix potential use-after-free. 2021-02-02 11:27:47 +02:00
editor Merge pull request #45669 from MrMinimal/master 2021-02-02 23:40:58 +01:00
main Main: Load translations and remaps before scene types 2021-02-02 15:17:49 +01:00
misc Merge pull request #45141 from Calinou/clang-format-hook-check-version 2021-01-26 15:26:46 +01:00
modules C conformance: Include stdbool.h to define `bool` 2021-02-02 18:11:00 +01:00
platform SCons: Add `production=yes` option to use production defaults 2021-02-03 11:48:17 +01:00
scene Add check for sun in PhysicalSky 2021-02-02 23:06:42 -08:00
servers Merge pull request #45658 from RandomShaper/fix_frozen_peak 2021-02-03 10:05:34 +01:00
tests Merge pull request #45315 from RandomShaper/modernize_thread 2021-01-31 15:24:56 +01:00
thirdparty Cleanup: Remove executable bit from files which don't need it 2021-01-19 23:36:42 +01:00
.clang-format Style: clang-format: Disable KeepEmptyLinesAtTheStartOfBlocks 2020-05-14 16:54:55 +02:00
.clang-tidy Style: Enforce braces around if blocks and loops 2020-05-14 21:57:34 +02:00
.editorconfig C#: Switch games to MSBuild Sdks and .NET Standard 2020-07-25 19:22:01 +02:00
.gitattributes Mark `*.tza` files as binary in `.gitattributes` for old Git versions 2020-05-12 09:49:19 +02:00
.gitignore gitignore: Ignore Kate swap files 2021-01-27 01:07:57 +03:00
.lgtm.yml Create a basic .lgtm.yml file. 2020-09-03 14:49:14 +01:00
.mailmap Update AUTHORS and DONORS list 2021-02-02 12:38:27 +01:00
AUTHORS.md Update AUTHORS and DONORS list 2021-02-02 12:38:27 +01:00
CHANGELOG.md Mention compatibility-breaking Camera2D offset change in the changelog 2020-09-15 15:56:36 +02:00
CONTRIBUTING.md Recommend minimal reproduction projects written in GDScript instead of C# 2021-01-12 20:15:36 +01:00
COPYRIGHT.txt Update PolyPartition / Triangulator library 2021-01-12 13:46:16 -05:00
DONORS.md Update AUTHORS and DONORS list 2021-02-02 12:38:27 +01:00
LICENSE.txt Update copyright statements to 2021 2021-01-01 20:19:21 +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
README.md Remove GitHub actions badge. 2020-09-01 23:07:35 +05:30
SConstruct SCons: Add `production=yes` option to use production defaults 2021-02-03 11:48:17 +01:00
glsl_builders.py RenderingServer reorganization 2020-12-04 18:39:46 -03: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
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
methods.py Don't handle BaseException in build scripts 2020-12-12 10:05:42 +00:00
platform_methods.py Merge python EnvironmentError, IOError and WindowsError into OSError. 2020-09-02 15:58:07 +01:00
version.py Update copyright statements to 2021 2021-01-01 20:19:21 +01:00

README.md

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 in 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 (HTML5) 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 Godot Engine

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.

To get in touch with the engine developers, the best way is to join the #godotengine-devel IRC channel on Freenode.

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.

The official demos are maintained in their own GitHub repository as well.

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