Virtualx Game Engine. Forked from Godot 3.6
Find a file
Rémi Verschelde 0cdcf1154f
Allow dehardcoding documentation branch and URL in docs links
This makes it possible to change the branch of the documentation that
URLs are pointing to without having to modify all class reference
files.

In the XML class reference, the `$DOCS_URL` placeholder should be used,
and will be replaced automatically in the editor and when generating
the RST class reference.

The documentation branch string is set in `version.py`.

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
(cherry picked from commit 5341e6010e)
2021-11-15 17:22:47 +01:00
.github CI: Update black to 21.10b0 2021-11-03 14:53:05 +01:00
core Allow dehardcoding documentation branch and URL in docs links 2021-11-15 17:22:47 +01:00
doc Allow dehardcoding documentation branch and URL in docs links 2021-11-15 17:22:47 +01:00
drivers Use application name for pulseaudio device 2021-11-15 17:22:47 +01:00
editor Allow dehardcoding documentation branch and URL in docs links 2021-11-15 17:22:47 +01:00
main Merge pull request #54911 from akien-mga/3.x-modules-check-enabled 2021-11-12 14:49:39 +01:00
misc Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
modules Show built-in script names in the debugger 2021-11-15 17:22:47 +01:00
platform Windows: Enable /bigobj to increase max size for obj files 2021-11-15 17:22:47 +01:00
scene fix hardcoded raycast distance with viewport object picking 2021-11-15 16:31:25 +01:00
servers Removed incorrect autocompletion of matrixes in shader 2021-11-15 16:30:00 +01:00
thirdparty Implement async shader compilation plus caching for GL ES 3 2021-11-09 12:19:12 +01:00
.clang-format clang-format: Enable BreakBeforeTernaryOperators 2021-10-28 14:50:33 +02:00
.clang-tidy Style: Enforce braces around if blocks and loops 2021-05-05 15:02:01 +02:00
.editorconfig [3.x] Add a simple C# .editorconfig 2021-07-24 16:27:57 -04:00
.gitattributes Upgrade Android Gradle to version 7.2 2021-10-15 12:51:43 +02:00
.gitignore gitignore: Ignore Kate swap files 2021-02-02 13:02:45 +01:00
.mailmap Update AUTHORS and DONORS list 2021-11-03 16:16:10 +01:00
AUTHORS.md Update my name on author file 2021-11-03 21:31:11 +01:00
CHANGELOG.md Bump version to 3.4-stable \o/ 2021-11-05 01:06:19 +01:00
compat.py SCons: Fix python2 compatibility after #37198 and #37248 2020-06-11 20:15:48 +02:00
CONTRIBUTING.md Link to Godot Contributors Chat instead of IRC 2021-03-07 22:51:06 +01:00
COPYRIGHT.txt Merge pull request #48967 from akien-mga/3.x-embree-3.13.0 2021-05-24 17:03:04 +02:00
DONORS.md Sync controller mappings DB with SDL2 community repo 2021-11-03 21:32:53 +01:00
gles_builders.py Implement async shader compilation plus caching for GL ES 3 2021-11-09 12:19:12 +01:00
icon.png Remove two very slightly displaced duplicate vertices on Gobot's face 2020-12-29 13:54:08 +01:00
icon.svg Remove two very slightly displaced duplicate vertices on Gobot's face 2020-12-29 13:54:08 +01:00
icon_outlined.png Add an outlined version of logo.png and icon.png and put it in README.md 2021-09-21 17:14:58 +02:00
icon_outlined.svg Add an outlined version of logo.png and icon.png and put it in README.md 2021-09-21 17:14:58 +02:00
LICENSE.txt Update copyright statements to 2021 2021-01-13 16:17:06 +01:00
logo.png Remove two very slightly displaced duplicate vertices on Gobot's face 2020-12-29 13:54:08 +01:00
logo.svg Remove two very slightly displaced duplicate vertices on Gobot's face 2020-12-29 13:54:08 +01:00
LOGO_LICENSE.md Relicense Godot logo from CC-BY-3.0 to CC-BY-4.0 2020-12-09 11:22:04 +01:00
logo_outlined.png Add an outlined version of logo.png and icon.png and put it in README.md 2021-09-21 17:14:58 +02:00
logo_outlined.svg Add an outlined version of logo.png and icon.png and put it in README.md 2021-09-21 17:14:58 +02:00
methods.py Allow dehardcoding documentation branch and URL in docs links 2021-11-15 17:22:47 +01:00
platform_methods.py SCons: Format buildsystem files with psf/black 2020-06-10 15:30:52 +02:00
README.md README updates and improvements, link license page 2021-11-15 17:22:46 +01:00
SConstruct SCons: Set DEBUG_ENABLED and DEV_ENABLED in SConstruct 2021-10-15 12:54:16 +02:00
version.py Allow dehardcoding documentation branch and URL in docs links 2021-11-15 17:22:47 +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 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 (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 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 ReadTheDocs. 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.

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