Godot Engine – Multi-platform 2D and 3D game engine
Go to file
Riteo 7e0f7d3abd Add Wayland support
Not everything is yet implemented, either for Godot or personal
limitations (I don't have all hardware in the world). A brief list of
the most important issues follows:

- Single-window only: the `DisplayServer` API doesn't expose enough
information for properly creating XDG shell windows.

- Very dumb rendering loop: this is very complicated, just know that
the low consumption mode is forced to 2000 Hz and some clever hacks are
in place to overcome a specific Wayland limitation. This will be
improved to the extent possible both downstream and upstream.

- Features to implement yet: IME, touch input, native file dialog,
drawing tablet (commented out due to a refactor), screen recording.

- Mouse passthrough can't be implement through a poly API, we need a
rect-based one.

- The cursor doesn't yet support fractional scaling.

- Auto scale is rounded up when using fractional scaling as we don't
have a per-window scale query API (basically we need
`DisplayServer::window_get_scale`).

- Building with `x11=no wayland=yes opengl=yes openxr=yes` fails.

This also adds a new project property and editor setting for selecting the
default DisplayServer to start, to allow this backend to start first in
exported projects (X11 is still the default for now). The editor setting
always overrides the project setting.

Special thanks to Drew Devault, toger5, Sebastian Krzyszkowiak, Leandro
Benedet Garcia, Subhransu, Yury Zhuravlev and Mara Huldra.
2024-01-30 16:44:47 +01:00
.github Add Wayland support 2024-01-30 16:44:47 +01:00
core Merge pull request #86845 from RandomShaper/no_load_regress 2024-01-29 21:33:00 +01:00
doc Add Wayland support 2024-01-30 16:44:47 +01:00
drivers Add Wayland support 2024-01-30 16:44:47 +01:00
editor Add Wayland support 2024-01-30 16:44:47 +01:00
main Add Wayland support 2024-01-30 16:44:47 +01:00
misc [TextServer / Font] Add support for customizable baseline offset. 2024-01-28 13:26:49 +02:00
modules Add Wayland support 2024-01-30 16:44:47 +01:00
platform Add Wayland support 2024-01-30 16:44:47 +01:00
scene Merge pull request #87701 from KoBeWi/extratreestial_tweens 2024-01-29 21:34:13 +01:00
servers Free dummy renderer objects 2024-01-29 19:28:29 +01:00
tests Add InputEventKey.location to tell left from right 2024-01-26 14:42:28 +01:00
thirdparty Add Wayland support 2024-01-30 16:44:47 +01: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 GDScript: Fix some lambda bugs 2023-09-14 14:22:23 +03:00
.git-blame-ignore-revs Header format commits to .git-blame-ignore-revs 2023-07-18 09:28:56 -05:00
.gitattributes File: Re-add support to skip CR (`\r`) in `File::get_as_text` 2022-08-01 00:40:35 +02:00
.gitignore SCons: Update mypy 2023-12-11 15:59:06 -06:00
.mailmap Update AUTHORS list 2023-11-16 17:39:44 +01:00
AUTHORS.md Update AUTHORS list 2023-11-16 17:39:44 +01:00
CHANGELOG.md Add changelog for Godot 4.2 2023-11-29 18:08:07 +01:00
CONTRIBUTING.md Cleanup various repository documentation files 2023-10-10 13:58:13 +02:00
COPYRIGHT.txt Add Wayland support 2024-01-30 16:44:47 +01:00
DONORS.md Update DONORS list with Dev Fund 2023-11-21 15:26:20 +01:00
LICENSE.txt One Copyright Update to rule them all 2023-01-05 13:25:55 +01:00
LOGO_LICENSE.txt Cleanup various repository documentation files 2023-10-10 13:58:13 +02:00
README.md Cleanup various repository documentation files 2023-10-10 13:58:13 +02:00
SConstruct Add THREADS_ENABLED macro in order to compile Godot to run on the main thread 2024-01-17 13:58:29 -05:00
gles3_builders.py SCons: Update mypy 2023-12-11 15:59:06 -06:00
glsl_builders.py SCons: Update mypy 2023-12-11 15:59:06 -06:00
icon.png Remove two very slightly displaced duplicate vertices on Gobot's face 2020-12-11 07:05:54 +01:00
icon.svg Standardize and Optimize blue robot SVG 2023-06-12 18:12:40 +02: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 Standardize and Optimize blue robot SVG 2023-06-12 18:12:40 +02:00
logo.png Remove two very slightly displaced duplicate vertices on Gobot's face 2020-12-11 07:05:54 +01:00
logo.svg Standardize and Optimize blue robot SVG 2023-06-12 18:12:40 +02:00
logo_outlined.png Convert the logo's text outlines into paths 2023-04-07 17:51:56 +02:00
logo_outlined.svg Standardize and Optimize blue robot SVG 2023-06-12 18:12:40 +02:00
methods.py Remove now unused `year` member from `version.py` 2024-01-25 15:08:34 +01:00
platform_methods.py SCons: Move platform logo/run icon to `export` folder 2023-06-20 13:16:37 +02:00
scu_builders.py Move 3D scene import classes to their own folder 2024-01-04 11:02:49 -06:00
version.py Remove now unused `year` member from `version.py` 2024-01-25 15:08:34 +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 Godot Foundation 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 Godot website.

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. This document also includes guidelines for reporting bugs.

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