## 1. Project Overview & Quickstart (godotengine/godot) # Godot Engine ## 2D and 3D cross-platform game engine **[Godot Engine](https://godotengine.org) 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](https://godotengine.org/features), 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](https://godotengine.org/consoles). ## Free, open source and community-driven Godot is completely free and open source under the very permissive [MIT license](https://godotengine.org/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](https://godot.foundation/) not-for-profit. Before being open sourced in [February 2014](https://github.com/godotengine/godot/commit/0b806ee0fc9097fa7bda7ac0109191c9c5e0a1ac), Godot had been developed by [Juan Linietsky](https://github.com/reduz) and [Ariel Manzur](https://github.com/punto-) 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](https://godotengine.org/download). ### Compiling from source [See the official docs](https://docs.godotengine.org/en/latest/engine_details/development/compiling) 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](https://godotengine.org/community). The best way to get in touch with the core engine developers is to join the [Godot Contributors Chat](https://chat.godotengine.org). To get started contributing to the project, see the [contributing guide](CONTRIBUTING.md). This document also includes guidelines for reporting bugs. ## Documentation and demos The official documentation is hosted on [Read the Docs](https://docs.godotengine.org). It is maintained by the Godot community in its own [GitHub repository](https://github.com/godotengine/godot-docs). The [class reference](https://docs.godotengine.org/en/latest/classes/) is also accessible from the Godot editor. We also maintain official demos in their own [GitHub repository](https://github.com/godotengine/godot-demo-projects) as well as a list of [awesome Godot community resources](https://github.com/godotengine/awesome-godot). There are also a number of other [learning resources](https://docs.godotengine.org/en/latest/community/tutorials.html) provided by the community, such as text and video tutorials, demos, etc. Consult the [community channels](https://godotengine.org/community) for more information. [](https://www.codetriage.com/godotengine/godot) [](https://hosted.weblate.org/engage/godot-engine/?utm_source=widget) ## 2. Official Technical Reference & Guides (godotengine/godot-docs) # Godot Engine documentation This repository contains the source files of [Godot Engine](https://godotengine.org)'s documentation, in reStructuredText markup language (reST). They are meant to be parsed with the [Sphinx](https://www.sphinx-doc.org/) documentation builder to build the HTML documentation on [Godot's website](https://docs.godotengine.org). ## Download for offline use To browse the documentation offline, you can download an HTML copy (updated every Monday): [stable](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-stable.zip), [latest](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-master.zip), [3.6](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-html-3.6.zip). 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](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-stable.zip), [latest](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-master.zip), [3.6](https://nightly.link/godotengine/godot-docs/workflows/build_offline_docs/master/godot-docs-epub-3.6.zip). 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](_static/) 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](https://addons.mozilla.org/en-US/firefox/addon/dark-mode-website-switcher/) add-on. ## Contributing All contributors are welcome to help on the Godot documentation. To get started, head to the [Contributing documentation](https://contributing.godotengine.org/en/latest/organization/how_to_contribute.html). 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: 1. [Contributing to the online manual](https://contributing.godotengine.org/en/latest/documentation/manual/index.html) 2. [Contributing to the class reference](https://contributing.godotengine.org/en/latest/documentation/class_reference.html) 3. [Content guidelines](https://contributing.godotengine.org/en/latest/documentation/guidelines/content_guidelines.html) 4. [Writing guidelines](https://contributing.godotengine.org/en/latest/documentation/guidelines/docs_writing_guidelines.html) 5. [Building the manual](https://contributing.godotengine.org/en/latest/documentation/manual/building_the_manual.html) 6. [Translating the documentation](https://contributing.godotengine.org/en/latest/documentation/translation/index.html) ## 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](https://creativecommons.org/licenses/by/3.0/)) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community". See [LICENSE.txt](/LICENSE.txt) for details. The files in the `classes/` folder are derived from [Godot's main source repository](https://github.com/godotengine/godot) and are distributed under the MIT license, with the same authors as above.