Godot Engine – Multi-platform 2D and 3D game engine
Go to file
Hugo Locurcio 922136b30d
Document that WebM videos don't support the alpha channel
(cherry picked from commit 1a616726cf)
2020-11-26 09:38:46 +01:00
.github [HTML5] Enforce JavaScript style with eslint. 2020-11-23 13:26:19 +01:00
core Merge pull request #43152 from Chaosus/color_autocompletion_3.2 2020-11-26 09:32:32 +01:00
doc doc: Warn about using Node internal processing 2020-11-26 09:38:45 +01:00
drivers doc: Warn about using Node internal processing 2020-11-26 09:38:45 +01:00
editor Bind the editor's Search Help function to F1 by default 2020-11-26 09:38:46 +01:00
main Fix CLI export when export_path is in preset. 2020-11-17 22:23:09 +01:00
misc Add missing javascript semi-colons. 2020-11-17 22:25:32 +01:00
modules Document that WebM videos don't support the alpha channel 2020-11-26 09:38:46 +01:00
platform Export: Reorder options for consistency across platforms 2020-11-26 09:38:46 +01:00
scene doc: Warn about using Node internal processing 2020-11-26 09:38:45 +01:00
servers Merge pull request #43554 from lawnjelly/refactor_pixel_snap 2020-11-16 18:24:10 +01:00
thirdparty nanosvg: Sync with upstream 3e403ec 2020-11-26 09:38:46 +01: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 Add a separate `nativeSrcsConfigs` module to handle Android Studio constraints for native code editor support. 2020-11-11 15:30:56 +01:00
.mailmap Update AUTHORS and DONORS list 2020-09-08 17:23:16 +02:00
AUTHORS.md Update AUTHORS and DONORS list 2020-10-28 15:09:17 +01:00
CHANGELOG.md Fix typos with codespell 2020-09-18 14:09:51 +02:00
CONTRIBUTING.md Document the requirement to update the class reference when contributing 2020-06-10 15:30:52 +02:00
COPYRIGHT.txt Rewrite FBX Importer to convert directly to Godot scene format 2020-10-30 15:59:19 +00:00
DONORS.md Update AUTHORS and DONORS list 2020-10-28 15:09:17 +01: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 SCons: Refactor and cleanup warnings definition 2020-10-19 16:09:59 +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 [3.2] Do not raise exception if iOS SDK is not installed. 2020-10-26 14:15:44 +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.4-beta 2020-09-18 08:28:18 +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