introduction.rst 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. :allow_comments: False
  2. .. _doc_about_intro:
  3. Introduction
  4. ============
  5. .. tabs::
  6. .. code-tab:: gdscript
  7. func _ready():
  8. print("Hello world!")
  9. .. code-tab:: csharp
  10. public override void _Ready()
  11. {
  12. GD.Print("Hello world!");
  13. }
  14. Welcome to the official documentation of **Godot Engine**, the free and open source
  15. community-driven 2D and 3D game engine! Behind this mouthful, you will find a
  16. powerful yet user-friendly tool that you can use to develop any kind of game,
  17. for any platform and with no usage restriction whatsoever.
  18. This page gives a broad overview of the engine and of this documentation,
  19. so that you know where to start if you are a beginner or
  20. where to look if you need information on a specific feature.
  21. Before you start
  22. ----------------
  23. The :ref:`Tutorials and resources <doc_community_tutorials>` page lists
  24. video tutorials contributed by the community. If you prefer video to text,
  25. consider checking them out. Otherwise, :ref:`Getting Started <doc_getting_started_intro>`
  26. is a great starting point.
  27. In case you have trouble with one of the tutorials or your project,
  28. you can find help on the various `Community channels <https://godotengine.org/community/>`_,
  29. especially the Godot `Discord <https://discord.gg/godotengine>`_ community and
  30. `Forum <https://forum.godotengine.org/>`_.
  31. About Godot Engine
  32. ------------------
  33. A game engine is a complex tool and difficult to present in a few words.
  34. Here's a quick synopsis, which you are free to reuse
  35. if you need a quick write-up about Godot Engine:
  36. Godot Engine is a feature-packed, cross-platform game engine to create 2D
  37. and 3D games from a unified interface. It provides a comprehensive set of
  38. common tools, so that users can focus on making games without having to
  39. reinvent the wheel. Games can be exported with one click to a number of
  40. platforms, including the major desktop platforms (Linux, macOS, Windows),
  41. mobile platforms (Android, iOS), as well as Web-based platforms and consoles.
  42. Godot is completely free and open source under the :ref:`permissive MIT
  43. license <doc_complying_with_licenses>`. No strings attached, no royalties,
  44. nothing. Users' games are theirs, down to the last line of engine code.
  45. Godot's development is fully independent and community-driven, empowering
  46. users to help shape their engine to match their expectations.
  47. It is supported by the `Godot Foundation <https://godot.foundation/>`_
  48. not-for-profit.
  49. Organization of the documentation
  50. ---------------------------------
  51. This documentation is organized into several sections:
  52. - **About** contains this introduction as well as
  53. information about the engine, its history, its licensing, authors, etc. It
  54. also contains the :ref:`doc_faq`.
  55. - **Getting Started** contains all necessary information on using the
  56. engine to make games. It starts with the :ref:`Step by step
  57. <toc-learn-step_by_step>` tutorial which should be the entry point for all
  58. new users. **This is the best place to start if you're new!**
  59. - The **Manual** can be read or referenced as needed,
  60. in any order. It contains feature-specific tutorials and documentation.
  61. - **Contributing** gives information related to contributing to
  62. Godot, whether to the core engine, documentation, demos or other parts.
  63. It describes how to report bugs, how contributor workflows are organized, etc.
  64. It also contains sections intended for advanced users and contributors,
  65. with information on compiling the engine, contributing to the editor,
  66. or developing C++ modules.
  67. - **Community** is dedicated to the life of Godot's community and contains a list of
  68. recommended third-party tutorials and materials outside of this documentation.
  69. It also provides details on the Asset Library. It also used to list Godot
  70. communities, which are now listed on the `Godot website <https://godotengine.org/community/>`_.
  71. - Finally, the **Class reference** documents the full Godot API,
  72. also available directly within the engine's script editor.
  73. You can find information on all classes, functions, signals and so on here.
  74. In addition to this documentation, you may also want to take a look at the
  75. various `Godot demo projects <https://github.com/godotengine/godot-demo-projects>`_.
  76. About this documentation
  77. ------------------------
  78. Members of the Godot Engine community continuously write, correct, edit, and
  79. improve this documentation. We are always looking for more help. You can also
  80. contribute by opening Github issues or translating the documentation into your language.
  81. If you are interested in helping, see :ref:`Ways to contribute <doc_ways_to_contribute>`
  82. and :ref:`Writing documentation <doc_contributing_writing_documentation>`,
  83. or get in touch with the `Documentation team <https://godotengine.org/teams/#documentation>`_
  84. on `Godot Contributors Chat <https://chat.godotengine.org/>`_.
  85. All documentation content is licensed under the permissive Creative Commons Attribution 3.0
  86. (`CC BY 3.0 <https://creativecommons.org/licenses/by/3.0/>`_) license,
  87. with attribution to "*Juan Linietsky, Ariel Manzur, and the Godot Engine community*"
  88. unless otherwise noted.
  89. *Have fun reading and making games with Godot Engine!*