mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
Improve About > Introduction
This commit is contained in:
Max Hilbrunner
@@ -6,105 +6,101 @@ Introduction
|
||||
::
|
||||
|
||||
func _ready():
|
||||
$Label.text = "Hello world!"
|
||||
print("Hello world!")
|
||||
|
||||
Welcome to the official documentation of Godot Engine, the free and open source
|
||||
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 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 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.
|
||||
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 or
|
||||
where to look if you need information on a specific feature.
|
||||
|
||||
Before you start
|
||||
----------------
|
||||
|
||||
The :ref:`Tutorials and resources <doc_community_tutorials>` page lists
|
||||
video tutorials contributed by the community. If you prefer video to text,
|
||||
those may be worth a look.
|
||||
consider checking them out. Otherwise, :ref:`Getting Started <sec-learn>`
|
||||
is a great starting point.
|
||||
|
||||
In case you have trouble with one of the tutorials or your project,
|
||||
you can find help on the various :ref:`Community channels <doc_community_channels>`,
|
||||
especially the Godot Discord community and Q&A.
|
||||
especially the Godot `Discord`_ community and
|
||||
`Q&A <https://godotengine.org/qa/>`_.
|
||||
|
||||
About Godot Engine
|
||||
------------------
|
||||
|
||||
A game engine is a complex tool, and it is therefore difficult to present Godot
|
||||
in a few words. Here's a quick synopsis, which you are free to reuse
|
||||
if you need a quick write-up 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 reuse
|
||||
if you need a quick write-up 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 users can focus on making games without having to
|
||||
reinvent the wheel. Games can be exported in one click to a number of
|
||||
platforms, including the major desktop platforms (Linux, macOS, Windows)
|
||||
as well as mobile (Android, iOS) and web-based (HTML5) platforms.
|
||||
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.
|
||||
|
||||
Godot is completely free and open source under the 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 `Godot
|
||||
Foundation <https://godot.foundation/>`_ not-for-profit.
|
||||
Godot is completely free and open source under the :ref:`permissive MIT
|
||||
license <doc_complying_with_licenses>`. 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 `Godot Foundation <https://godot.foundation/>`_
|
||||
not-for-profit.
|
||||
|
||||
For a more in-depth view of the engine, you are encouraged to read this
|
||||
documentation further, especially the :ref:`Getting Started <sec-learn>` series.
|
||||
|
||||
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 <https://www.sphinx-doc.org/en/stable/rest.html>`_ markup
|
||||
language and then compiled into a static website/offline document using the
|
||||
open source `Sphinx <https://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
|
||||
`source repository <https://github.com/godotengine/godot-docs>`_, or
|
||||
translating it into your language on `Hosted Weblate
|
||||
<https://hosted.weblate.org/projects/godot-engine/godot-docs/>`_.
|
||||
|
||||
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".
|
||||
|
||||
Organization of the documentation
|
||||
---------------------------------
|
||||
|
||||
This documentation is organized in several sections with an impressively
|
||||
unbalanced distribution of contents – but the way it is split up should be
|
||||
relatively intuitive:
|
||||
This documentation is organized into several sections:
|
||||
|
||||
- The **About** section contains this introduction as well as
|
||||
the information about the engine, its history, its licensing, authors, etc. It
|
||||
- **About** contains this introduction as well as
|
||||
information about the engine, its history, its licensing, authors, etc. It
|
||||
also contains the :ref:`doc_faq`.
|
||||
- The **Getting Started** section is the *raison d'être* of this
|
||||
documentation, as it contains all the necessary information on using the
|
||||
- **Getting Started** contains all 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
|
||||
new users.
|
||||
- The **Manual** section can be read as needed,
|
||||
new users. **This is the best place to start if you're new!**
|
||||
- The **Manual** can be read or referenced as needed,
|
||||
in any order. It contains feature-specific tutorials and documentation.
|
||||
- The **Contributing** section gives the information related to contributing to
|
||||
the engine development, e.g. how to report bugs, help with the documentation, etc.
|
||||
It also contains subsections intended for advanced users and contributors
|
||||
to the engine development, with the information on compiling the engine,
|
||||
contributing to the editor, or developing C++ modules.
|
||||
- The **Community** section is dedicated to the life of its community.
|
||||
It points to various community channels like Godot Contributors Chat and
|
||||
Discord and contains a list of recommended third-party tutorials outside
|
||||
of this documentation.
|
||||
- Finally, the **Class reference** is the documentation of the Godot API,
|
||||
which is also available directly within the engine's script editor. It is
|
||||
generated automatically from a file in the main source repository, therefore
|
||||
the generated files of the documentation are not meant to be modified. See
|
||||
:ref:`doc_updating_the_class_reference` for details.
|
||||
- **Contributing** gives information related to contributing to
|
||||
Godot, 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.
|
||||
It points to various community channels like the
|
||||
`Godot Contributors Chat <https://chat.godotengine.org/>`_ and
|
||||
`Discord`_ and contains a list of recommended third-party tutorials and
|
||||
materials outside of this documentation.
|
||||
- Finally, the **Class 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 the
|
||||
various `Godot demo projects <https://github.com/godotengine/godot-demo-projects>`_.
|
||||
|
||||
Have fun reading and making games with Godot Engine!
|
||||
About this documentation
|
||||
------------------------
|
||||
|
||||
Members of the Godot Engine community continuously write, correct, edit, and
|
||||
improve this documentation. We are always looking for more help. You can also
|
||||
contribute by opening Github issues or translating the documentation into your language.
|
||||
If you are interested in helping, see :ref:`Ways to contribute <doc_ways_to_contribute>`
|
||||
and :ref:`Writing documentation <doc_contributing_writing_documentation>`,
|
||||
or get in touch with the `Documentation team <https://godotengine.org/teams/#documentation>`_
|
||||
on `Godot Contributors Chat <https://chat.godotengine.org/>`_.
|
||||
|
||||
All documentation content is licensed 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*"
|
||||
unless otherwise noted.
|
||||
|
||||
*Have fun reading and making games with Godot Engine!*
|
||||
|
||||
.. _Discord: https://discord.gg/4JBkykG
|
||||
|
||||
Reference in New Issue
Block a user