2017-04-03 23:20:56 +02:00
|
|
|
|
.. _doc_about_intro:
|
|
|
|
|
|
|
|
|
|
Introduction
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
|
|
func _ready():
|
2017-09-14 04:05:12 +02:00
|
|
|
|
$Label.text = "Hello world!"
|
2017-04-03 23:20:56 +02:00
|
|
|
|
|
|
|
|
|
Welcome to the official documentation of Godot Engine, the free and open source
|
|
|
|
|
community-driven 2D and 3D game engine! Behind this mouthful, you will find a
|
|
|
|
|
powerful but user-friendly tool that you can use to develop any kind of game,
|
|
|
|
|
for any platform and with no usage restriction whatsoever.
|
|
|
|
|
|
|
|
|
|
This page aims at giving a broad presentation of the engine and of the contents
|
|
|
|
|
of this documentation, so that you know where to start if you are a beginner or
|
|
|
|
|
where to look if you need info on a specific feature.
|
|
|
|
|
|
|
|
|
|
About Godot Engine
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
A game engine is a complex tool, and it is therefore difficult to present Godot
|
|
|
|
|
in a few words. Here's however our PR presentation, which you are free to reuse
|
|
|
|
|
if you need a quick writeup about Godot 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 in one click to a number of
|
2017-12-15 23:46:56 +01:00
|
|
|
|
platforms, including the major desktop platforms (Linux, macOS, Windows)
|
2017-04-03 23:20:56 +02:00
|
|
|
|
as well as mobile (Android, iOS) and web-based (HTML5) platforms.
|
|
|
|
|
|
|
|
|
|
Godot is completely free and open source under the very permissive MIT
|
|
|
|
|
license. 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, empowering users to help shape their
|
|
|
|
|
engine to match their expectations. It is supported by the `Software
|
|
|
|
|
Freedom Conservancy <https://sfconservancy.org>`_ not-for-profit.
|
|
|
|
|
|
|
|
|
|
For a more in-depth view of the engine, you are encouraged to read this
|
|
|
|
|
documentation further, especially the :ref:`Step by step
|
|
|
|
|
<toc-learn-step_by_step>` tutorial.
|
|
|
|
|
|
|
|
|
|
About the documentation
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
This documentation is continuously written, corrected, edited and revamped by
|
|
|
|
|
members of the Godot Engine community. It is edited via text files in the
|
|
|
|
|
`reStructuredText <http://www.sphinx-doc.org/en/stable/rest.html>`_ markup
|
|
|
|
|
language and then compiled into a static website/offline document using the
|
|
|
|
|
open source `Sphinx <http://www.sphinx-doc.org>`_ and `ReadTheDocs
|
|
|
|
|
<https://readthedocs.org/>`_ tools.
|
|
|
|
|
|
|
|
|
|
.. note:: You can contribute to Godot's documentation by opening issue tickets
|
|
|
|
|
or sending patches via pull requests on its GitHub
|
2017-07-16 17:23:56 +02:00
|
|
|
|
`source repository <https://github.com/godotengine/godot-docs>`_.
|
2017-04-03 23:20:56 +02:00
|
|
|
|
|
|
|
|
|
All the contents are under the permissive Creative Commons Attribution 3.0
|
|
|
|
|
(`CC-BY 3.0 <https://creativecommons.org/licenses/by/3.0/>`_) license, with
|
|
|
|
|
attribution to "Juan Linietsky, Ariel Manzur and the Godot Engine community".
|
|
|
|
|
|
|
|
|
|
Organisation of the documentation
|
|
|
|
|
---------------------------------
|
|
|
|
|
|
|
|
|
|
This documentation is organised in five sections with an impressively
|
|
|
|
|
unbalanced distribution of contents – but the way it is split up should be
|
|
|
|
|
relatively intuitive:
|
|
|
|
|
|
|
|
|
|
- The :ref:`sec-general` section contains this introduction as well as
|
|
|
|
|
information about the engine, its history, its licensing, authors, etc. It
|
|
|
|
|
also contains the :ref:`doc_faq`.
|
|
|
|
|
- The :ref:`sec-learn` section is the the main *raison d'être* of this
|
|
|
|
|
documentation, as it contains all the necessary information on using the
|
|
|
|
|
engine to make games. It starts with the :ref:`Step by step
|
|
|
|
|
<toc-learn-step_by_step>` tutorial which should be the entry point for all
|
2018-01-26 00:21:36 +01:00
|
|
|
|
new users.
|
|
|
|
|
- The :ref:`sec-tutorials` section, on the other hand, can be read as needed,
|
|
|
|
|
in any order. It contains many feature-specific tutorials and documentations.
|
2017-04-03 23:20:56 +02:00
|
|
|
|
- The :ref:`sec-devel` section is intended for advanced users and contributors
|
|
|
|
|
to the engine development, with information on compiling the engine,
|
|
|
|
|
developing C++ modules or editor plugins.
|
|
|
|
|
- The :ref:`sec-community` gives information related to contributing to the
|
|
|
|
|
engine development and the life of its community, e.g. how to report bugs,
|
|
|
|
|
help with the documentation, etc. It's also the place for tutorials
|
|
|
|
|
contributed by community members before they are properly reviewed and
|
2018-01-26 00:21:36 +01:00
|
|
|
|
adapted to be integrated in the official list of the :ref:`sec-tutorials`
|
2017-04-03 23:20:56 +02:00
|
|
|
|
section.
|
|
|
|
|
- Finally, the :ref:`sec-class-ref` is the documentation of the Godot API,
|
|
|
|
|
which is also available directly within the script editor. It is generated
|
|
|
|
|
automatically from a file in the main repository, and the generated files
|
|
|
|
|
of the documentation are therefore not meant to be modified. See
|
|
|
|
|
:ref:`doc_updating_the_class_reference` for details.
|
|
|
|
|
|
|
|
|
|
Have fun reading and making games with Godot Engine!
|