1. Project Overview & Quickstart (godotengine/godot)
Godot Engine
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 for several years as an in-house
engine, used to publish several work-for-hire titles.
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.
2. Official Technical Reference & Guides (godotengine/godot-docs)
Godot Engine documentation
This repository contains the source files of Godot Engine's documentation, in reStructuredText markup language (reST).
They are meant to be parsed with the Sphinx documentation builder to build the HTML documentation on Godot's website.
Download for offline use
To browse the documentation offline, you can download an HTML copy (updated every Monday):
stable,
latest,
3.6. Extract
the ZIP archive then open the top-level index.html in a web browser.
For mobile devices or e-readers, you can also download an ePub copy (updated every Monday):
stable,
latest,
3.6. Extract
the ZIP archive then open the GodotEngine.epub file in an e-book reader application.
Theming
The Godot documentation uses the default sphinx_rtd_theme with many
customizations applied on top. It will automatically switch between
the light and dark theme depending on your browser/OS' theming preference.
If you use Firefox and wish to use the dark theme regardless of your OS
configuration, you can install the
Dark Website Forcer
add-on.
Contributing
All contributors are welcome to help on the Godot documentation.
To get started, head to the Contributing documentation. There, you will find all the information you need to write and submit changes.
Here are some quick links to the areas you might be interested in:
- Contributing to the online manual
- Contributing to the class reference
- Content guidelines
- Writing guidelines
- Building the manual
- Translating the documentation
License
With the exception of the classes/ folder, all the content of this repository is licensed under the Creative Commons Attribution 3.0 Unported license (CC BY 3.0) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community".
See LICENSE.txt for details.
The files in the classes/ folder are derived from Godot's main source repository and are distributed under the MIT license, with the same authors as above.