Go to file
Fabio Alessandrelli 472482013e [HTML5] Add jsdoc2rst tool.
A template for `jsdoc` that generat the HTML5 public classref.

The script can be run via `npm run docs` to print to stdout.

You can dry run via `npm run docs -- --d dry-run` or write to file via
`npm run docs -- -d /path/to/file.rst`

Also update Makefile in `doc/` and add dry run test to CI.
2021-02-26 11:33:59 +01:00
.github [HTML5] Add jsdoc2rst tool. 2021-02-26 11:33:59 +01:00
core Merge pull request #45061 from razonixx/Add_warning_when_dir_is_inaccesible 2021-02-25 22:39:59 +01:00
doc [HTML5] Add jsdoc2rst tool. 2021-02-26 11:33:59 +01:00
drivers Omit some functions in alsa wrapper 2021-02-22 19:22:53 +01:00
editor Add outline to dragged guide text 2021-02-26 03:12:50 +03:00
main Remove GDScript bindings for OS.get/set_exit_code, SceneTree.quit(<exit_code>) should be used instead 2021-02-25 18:34:50 +01:00
misc Improve the editor HTML template 2021-02-24 22:50:49 +01:00
modules Merge pull request #46379 from ThakeeNathees/signal-idf-not-found-fix 2021-02-25 22:30:22 +01:00
platform [HTML5] Add jsdoc2rst tool. 2021-02-26 11:33:59 +01:00
scene Fix crash when loading a scene containing an uncreatable type 2021-02-25 23:58:30 +01:00
servers Update Inspector when changing AudioEffectChorus voice_count 2021-02-25 17:32:50 +01:00
tests Merge pull request #45914 from HenryWConklin/45841-xml-entities 2021-02-24 13:03:46 +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 Use space indentation for all YAML files in .editorconfig 2021-02-20 02:53:10 +01: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-10 16:11:18 +01:00
AUTHORS.md Update AUTHORS and DONORS list 2021-02-10 16:11:18 +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 Cylinder support in Godot Physics 3D 2021-02-10 10:00:53 -07:00
DONORS.md Update AUTHORS and DONORS list 2021-02-02 12:38:27 +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
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
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 SCons: Properly handle overriding default values to bool options 2021-02-24 10:23:00 +01:00
platform_methods.py Merge python EnvironmentError, IOError and WindowsError into OSError. 2020-09-02 15:58:07 +01:00
README.md Remove GitHub actions badge. 2020-09-01 23:07:35 +05:30
SConstruct SCons: Fix profile type. It is a string 2021-02-25 19:45:36 -03:00
version.py Update copyright statements to 2021 2021-01-01 20:19:21 +01: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 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