Godot Engine – Multi-platform 2D and 3D game engine
Go to file
Hugo Locurcio 6eee52e49b
Improve the documentation related to overriding GUI theme items
Overriding theme items is a common point of confusion.
Hopefully, these code samples should clear things up.

(cherry picked from commit 2a8bbda2a7)
2020-08-31 15:29:43 +02:00
.github Remove community health files from this repository 2020-08-31 15:29:42 +02:00
core Revert "Check if global class file still exists before registering it" 2020-08-25 14:33:46 +02:00
doc Improve the documentation related to overriding GUI theme items 2020-08-31 15:29:43 +02:00
drivers GLES2 batching - Fix redundant transform synchronization in batches 2020-08-18 08:37:07 +01:00
editor Gives the theme editor a horizontal scrollbar 2020-08-31 15:29:41 +02:00
main Style: Sync other changes from new fix_style.sh and clang_format.sh 2020-07-24 10:39:18 +02:00
misc fix GDScript UTI 2020-08-21 02:28:18 +02:00
modules Cross-reference GDScript built-in rounding methods to ease discovery 2020-08-31 15:29:42 +02:00
platform Merge pull request #41504 from naithar/fix/analyzer-3.2 2020-08-25 18:37:02 +02:00
scene Make `AnimatedTexture.MAX_FRAMES` public 2020-08-31 15:29:43 +02:00
servers Check arrays before generating Polygon2D AABBs 2020-08-16 21:08:52 -07:00
thirdparty stb_vorbis: Update to upstream version 1.20 2020-07-24 10:31:57 +02:00
.clang-format clang-format: Add JavaImportGroups for Java code 2020-05-07 13:36:27 +02:00
.editorconfig 3.2 New csproj style with backport of Godot.NET.Sdk 2020-08-20 21:48:59 +02:00
.gitattributes Git: Explicitly list binary files as such to avoid EOL change 2019-05-25 10:43:48 +02:00
.gitignore gitignore: Ignore binutils linker temp stXXXXXX objects 2020-07-24 10:31:57 +02:00
.mailmap Update AUTHORS and DONORS list 2020-08-14 00:32:05 +02:00
AUTHORS.md Update AUTHORS and DONORS list 2020-08-14 00:32:05 +02:00
CHANGELOG.md Changelog: Mention 3.2 changes to TileMap features 2020-02-06 13:02:08 +01:00
CONTRIBUTING.md Document the requirement to update the class reference when contributing 2020-06-10 15:30:52 +02:00
COPYRIGHT.txt xatlas: Sync with upstream 470576d 2020-06-04 11:15:06 +02:00
DONORS.md Update AUTHORS and DONORS list 2020-08-14 00:32:05 +02:00
LICENSE.txt Update copyright statements to 2020 2020-01-01 11:16:22 +01:00
LOGO_LICENSE.md Improve documentation of thirdparty code snippets 2017-05-07 11:42:37 +02:00
README.md Improve the project README 2020-08-14 00:32:04 +02:00
SConstruct Alias the "linuxbsd" platform to "x11" for forward compatibility 2020-08-29 18:09:48 +02:00
compat.py SCons: Fix python2 compatibility after #37198 and #37248 2020-06-11 20:15:48 +02:00
gles_builders.py SCons: Format buildsystem files with psf/black 2020-06-10 15:30:52 +02:00
icon.png Optimize images losslessly using `oxipng -o6 --strip all --zopfli` 2018-06-28 19:17:41 +02:00
icon.svg Use new Godot icon consistently everywhere 2017-05-17 19:53:59 +02:00
logo.png Optimize images losslessly using `oxipng -o6 --strip all --zopfli` 2018-06-28 19:17:41 +02:00
logo.svg Style: Add missing newlines to SVGs 2020-07-24 10:39:18 +02:00
methods.py Fix emoji branch compilation error 2020-07-24 10:31:57 +02:00
platform_methods.py SCons: Format buildsystem files with psf/black 2020-06-10 15:30:52 +02:00
version.py Bump version to 3.2.3-rc 2020-07-24 14:10:13 +02: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.

Actions Build Status Code Triagers Badge Translate on Weblate Total alerts on LGTM TODOs