Godot Engine – Multi-platform 2D and 3D game engine
Go to file
Isaac Clerencia acdb1bdbd7 Clarify Thread documentation
The current documentation uses the term "running" for two different things.

In the description of get_id() it claims "it will return empty string if the thread is not running", but it actually will return the thread id until wait_to_finish is called.

In the description of is_alive() it claims "it will return true if the thread is running", but in this case it means "the provided function hasn't finished running yet".

Updated the functions documentation slighly to make this clear.

(cherry picked from commit 2a4f38d54f)
2023-03-13 14:41:26 +01:00
.github CI: Pin SCons to 4.4.0, the new 4.5.0 is broken 2023-03-06 10:08:43 +01:00
core Document `editor/naming/scene_name_casing` setting 2023-03-13 14:25:46 +01:00
doc Clarify Thread documentation 2023-03-13 14:41:26 +01:00
drivers Avoid copying CanvasTexture when updating proxy 2023-03-13 14:10:38 +01:00
editor Document `editor/naming/scene_name_casing` setting 2023-03-13 14:25:46 +01:00
main Prevent crashing on startup if project has scripted theme types 2023-03-13 14:18:32 +01:00
misc Bump version to 4.0.1-rc 2023-03-01 14:09:30 +01:00
modules Document GLTFNode and some of GLTFState 2023-03-13 14:40:30 +01:00
platform Fix null-pointer dereference on Android systems when using gl_compatibility renderer. 2023-03-13 14:22:45 +01:00
scene Fix RichTextLabel crash with out of bound exception 2023-03-13 14:13:36 +01:00
servers Avoid copying CanvasTexture when updating proxy 2023-03-13 14:10:38 +01:00
tests Core: Identity compare objects by id, not by pointers 2023-02-24 23:33:29 +02:00
thirdparty Remove CVTT upstream changes to packing unpacking of BC6H formats 2023-02-22 13:20:26 -08: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 GDScript `.editorconfig` rules 2023-01-10 12:25:35 -05: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 Fix .gitignore ignores part of the committed repo. 2023-02-17 13:48:16 +01:00
.lgtm.yml Create a basic .lgtm.yml file. 2020-09-03 14:49:14 +01:00
.mailmap Update AUTHORS and DONORS list 2023-02-24 14:46:21 +01:00
AUTHORS.md Update AUTHORS and DONORS list 2023-02-24 14:46:21 +01:00
CHANGELOG.md Fix "Convert Full Project" button not translated 2023-03-06 10:10:02 +01:00
CONTRIBUTING.md Update all outdated online documentation links 2023-01-14 19:38:00 +03:00
COPYRIGHT.txt meshoptimizer: Sync with upstream commit 4a287848f 2023-01-31 22:27:49 -08:00
DONORS.md Update AUTHORS and DONORS list 2023-02-24 14:46:21 +01:00
LICENSE.txt One Copyright Update to rule them all 2023-01-05 13:25:55 +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 Minor typo and docs URL fixes 2023-02-28 13:38:01 +01:00
SConstruct Merge pull request #73441 from akien-mga/linux-unbundling-fixes 2023-02-17 09:56:02 +01:00
gles3_builders.py Add GPUParticles to the OpenGL3 renderer. 2022-11-14 23:28:25 -08:00
glsl_builders.py ci: add Python static analysis check via mypy 2022-09-30 19:03:17 +07: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
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_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 Let VS solution name be overridden 2023-02-16 20:08:26 +01:00
platform_methods.py Unify bits, arch, and android_arch into env["arch"] 2022-08-25 11:19:20 +02:00
version.py Bump version to 4.0.1-rc 2023-03-01 14:09:30 +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 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 Read the Docs. 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 TODOs