mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
c03229cd9d
This also updates the index page, changes the first
sidebar section to be "About" without an extra level,
and renames "Tutorials" to "Manual"
(cherry picked from commit 0c100d9f14)
135 lines
5.9 KiB
ReStructuredText
135 lines
5.9 KiB
ReStructuredText
.. Keep this page short and sweet! We want users to read it to the end, so they
|
|
know where to find information, how to get help, and how to maximize chances
|
|
of getting answers.
|
|
|
|
.. _doc_learning_new_features:
|
|
|
|
Learning new features
|
|
=====================
|
|
|
|
Godot is a feature-rich game engine. There is a lot to learn about it. This page
|
|
explains how you can use the online manual, built-in code reference, and join
|
|
online communities to learn new features and techniques.
|
|
|
|
Making the most of this manual
|
|
------------------------------
|
|
|
|
What you are reading now is the user manual. It documents each of the engine's
|
|
concepts and available features. When learning a new topic, you can start by
|
|
browsing the corresponding section of this website. The left menu allows you to
|
|
explore broad topics while the search bar will help you find more specific
|
|
pages. If a page exists for a given theme, it will often link to more related
|
|
content.
|
|
|
|
.. image:: img/manual_search.png
|
|
|
|
The manual has a companion class reference that explains each Godot class's
|
|
available functions and properties when programming. While the manual covers
|
|
general features, concepts, and how to use the editor, the reference is all
|
|
about using Godot's scripting API (Application Programming Interface). You can
|
|
access it both online and offline. We recommend browsing the reference offline,
|
|
from within the Godot editor. To do so, go to Help -> Search or press
|
|
:kbd:`F1`.
|
|
|
|
.. image:: img/manual_class_reference_search.png
|
|
|
|
To browse it online, head to the manual's :ref:`Class Reference <doc_class_reference>`
|
|
section.
|
|
|
|
A class reference's page tells you:
|
|
|
|
1. Where the class exists in the inheritance hierarchy. You can click the top
|
|
links to jump to parent classes and see the properties and methods a type
|
|
inherits.
|
|
|
|
.. image:: img/manual_class_reference_inheritance.png
|
|
|
|
2. A summary of the class's role and use cases.
|
|
|
|
3. An explanation of the class's properties, methods, signals, enums, and
|
|
constants.
|
|
|
|
4. Links to manual pages further detailing the class.
|
|
|
|
.. note:: If the manual or class reference is missing or has insufficient
|
|
information, please open an Issue in the official `godot-docs
|
|
<https://github.com/godotengine/godot-docs/issues>`_ GitHub repository
|
|
to report it.
|
|
|
|
You can Ctrl-click any underlined text like the name of a class, property,
|
|
method, signal, or constant to jump to it.
|
|
|
|
Learning with the community
|
|
---------------------------
|
|
|
|
Godot has a growing community of users. If you're stuck on a problem or need
|
|
help to better understand how to achieve something, you can ask other users for
|
|
help on one of the many `active
|
|
communities <https://godotengine.org/community>`_.
|
|
|
|
The best place to ask for questions and find already answered ones is the
|
|
official `Questions & Answers <https://godotengine.org/qa/>`_ site. These
|
|
responses show up in search engine results and get saved, allowing other users
|
|
to benefit from discussions on the platform. Once you asked a question there,
|
|
you can share its link on other social platforms. Before asking a question, be
|
|
sure to look for existing answers that might solve your problem on this website
|
|
or using your preferred search engine.
|
|
|
|
Asking questions well and providing details will help others answer you faster
|
|
and better. When asking questions, we recommend including the following
|
|
information:
|
|
|
|
1. **Describe your goal**. You want to explain what you are trying to achieve
|
|
design-wise. If you are having trouble figuring out how to make a solution
|
|
work, there may be a different, easier solution that accomplishes the same
|
|
goal.
|
|
|
|
2. If there is an error involved, **share the exact error message**. You
|
|
can copy the exact error message in the editor's Debugger bottom panel by
|
|
clicking the Copy Error icon. Knowing what it says can help community members
|
|
better identify how you triggered the error.
|
|
|
|
3. If there is code involved, **share a code sample**. Other users won't be able
|
|
to help you fix a problem without seeing your code. Share the code as text
|
|
directly. To do so, you can copy and paste a short code snippet in a chat
|
|
box, or use a website like `Pastebin <https://pastebin.com/>`_ to share long
|
|
files.
|
|
|
|
4. **Share a screenshot** of your *Scene* dock along with your written code. Most of
|
|
the code you write affects nodes in your scenes. As a result, you should
|
|
think of those scenes as part of your source code.
|
|
|
|
.. image:: img/key_concepts_scene_tree.png
|
|
|
|
Also, please don't take a picture with your phone, the low quality and screen
|
|
reflections can make it hard to understand the image. Your operating system
|
|
should have a built-in tool to take screenshots with the :kbd:`PrtSc` (Print
|
|
Screen) key.
|
|
|
|
Alternatively, you can use a program like `ShareX <https://getsharex.com/>`_
|
|
on Windows or `FlameShot <https://flameshot.org/>`_ on Linux.
|
|
|
|
5. Sharing a video of your running game can also be really **useful to
|
|
troubleshoot your game**. You can use programs like `OBS Studio
|
|
<https://obsproject.com/>`_ and `Screen to GIF
|
|
<https://www.screentogif.com/>`_ to capture your screen.
|
|
|
|
You can then use a service like `streamable <https://streamable.com/>`_ or a
|
|
cloud provider to upload and share your videos for free.
|
|
|
|
6. If you're not using the stable version of Godot, please mention the version
|
|
you're using. The answer can be different as available features and the
|
|
interface evolve rapidly.
|
|
|
|
Following these guidelines will maximize your chances of getting the answer
|
|
you're looking for. They will save time both to you and the persons helping you.
|
|
|
|
Community tutorials
|
|
-------------------
|
|
|
|
This manual aims to provide a comprehensive reference of Godot's features. Aside
|
|
from the 2D and 3D getting started series, it does not contain tutorials to
|
|
implement specific game genres. If you're looking for a tutorial about creating
|
|
a role-playing game, a platformer, or other, please see
|
|
:ref:`doc_community_tutorials`, which lists content made by the Godot community.
|