Introduction
func_ready():print("Hello world!")
publicoverridevoid_Ready(){GD.Print("Hello world!");}
Welcome to the official documentation ofGodot Engine, the free and open sourcecommunity-driven 2D and 3D game engine! Behind this mouthful, you will find apowerful yet user-friendly tool that you can use to develop any kind of game,for any platform and with no usage restriction whatsoever.
This page gives a broad overview of the engine and of this documentation,so that you know where to start if you are a beginner orwhere to look if you need information on a specific feature.
Before you start
TheTutorials and resources page listsvideo tutorials contributed by the community. If you prefer video to text,consider checking them out. Otherwise,Getting Startedis a great starting point.
In case you have trouble with one of the tutorials or your project,you can find help on the variousCommunity channels,especially the GodotDiscord community andForum.
About Godot Engine
A game engine is a complex tool and difficult to present in a few words.Here's a quick synopsis, which you are free to reuseif you need a quick write-up about Godot Engine:
Godot Engine is a feature-packed, cross-platform game engine to create 2Dand 3D games from a unified interface. It provides a comprehensive set ofcommon tools, so that users can focus on making games without having toreinvent the wheel. Games can be exported with one click to a number ofplatforms, including the major desktop platforms (Linux, macOS, Windows),mobile platforms (Android, iOS), as well as Web-based platforms and consoles.
Godot is completely free and open source under thepermissive MITlicense. No strings attached, no royalties,nothing. Users' games are theirs, down to the last line of engine code.Godot's development is fully independent and community-driven, empoweringusers to help shape their engine to match their expectations.It is supported by theGodot Foundationnot-for-profit.
Organization of the documentation
This documentation is organized into several sections:
About contains this introduction as well asinformation about the engine, its history, its licensing, authors, etc. Italso contains theFrequently asked questions.
Getting Started contains all necessary information on using the engine tomake games. It starts with theIntroduction section whichshould be the entry point for all new users.This is the best place to startif you're new!
TheManual can be read or referenced as needed,in any order. It contains feature-specific tutorials and documentation.
Contributing gives information related to contributing toGodot, whether to the core engine, documentation, demos or other parts.It describes how to report bugs, how contributor workflows are organized, etc.It also contains sections intended for advanced users and contributors,with information on compiling the engine, contributing to the editor,or developing C++ modules.
Community is dedicated to the life of Godot's community and contains a list ofrecommended third-party tutorials and materials outside of this documentation.It also provides details on the Asset Library. It also used to list Godotcommunities, which are now listed on theGodot website.
Finally, theClass reference documents the full Godot API,also available directly within the engine's script editor.You can find information on all classes, functions, signals and so on here.
In addition to this documentation, you may also want to take a look at thevariousGodot demo projects.
About this documentation
Members of the Godot Engine community continuously write, correct, edit, andimprove this documentation. We are always looking for more help. You can alsocontribute by opening Github issues or translating the documentation into your language.If you are interested in helping, seeWays to contributeandWriting documentation,or get in touch with theDocumentation teamonGodot Contributors Chat.
All documentation content is licensed under the permissive Creative Commons Attribution 3.0(CC BY 3.0) license,with attribution to "Juan Linietsky, Ariel Manzur, and the Godot Engine community"unless otherwise noted.
Have fun reading and making games with Godot Engine!