mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
95fb178429
This allows users to leave comments on pages that don't have `:allow_comments: False` somewhere in the page's source. Both manual and class reference pages can receive comments. Index pages cannot have comments, as discussion should occur on "leaf" pages. GitHub Discussions is used as a backend on the same repository. This means that Discussions *must* be enabled on godotengine/godot-docs before this commit is merged to `master`. Users can choose to use the "Custom" watch mode if they don't want to get notifications for discussion updates, but still get notifications for issue and pull request updates. User comments are intended to be used for the following purposes: - Add a clarification or correct something in the documentation, without having to open a pull request. Contributors are encouraged to take a look at discussions from time to time, and see if there's information worth incorporating in the pages themselves. Don't forget to reply to the comment when doing so :) - Mention a workaround for a common issue. - Link to useful third-party resources that are relevant to the current page, such as tutorials or add-ons. User comments should *not* be used for technical support. Other community platforms should be used for that. Page-to-discussion matching is done using the `pagename` Sphinx variable, which is independent of the Godot version and documentation language. Being independent of the Godot version allows keeping old comments when the Godot version changes, while also allowing users from `/stable` and `/4.1` to "see" each other in discussions. See https://giscus.app for more information.
109 lines
4.9 KiB
ReStructuredText
109 lines
4.9 KiB
ReStructuredText
:allow_comments: False
|
|
|
|
.. _doc_about_intro:
|
|
|
|
Introduction
|
|
============
|
|
|
|
::
|
|
|
|
func _ready():
|
|
print("Hello world!")
|
|
|
|
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 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,
|
|
consider checking them out. Otherwise, :ref:`Getting Started <doc_getting_started_intro>`
|
|
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
|
|
`Forum <https://forum.godotengine.org/>`_.
|
|
|
|
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 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 :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.
|
|
|
|
|
|
Organization of the documentation
|
|
---------------------------------
|
|
|
|
This documentation is organized into several sections:
|
|
|
|
- **About** contains this introduction as well as
|
|
information about the engine, its history, its licensing, authors, etc. It
|
|
also contains the :ref:`doc_faq`.
|
|
- **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. **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.
|
|
- **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>`_.
|
|
|
|
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
|