Acasă Explorează Ajutor
Autentificare
Godot
/
godot-docs
oglindă de https://github.com/godotengine/godot-docs.git
2
0
Bifurcare 0
Fisiere Probleme 0 Wiki

#godot #docs #howto

Arbore: e4268cf580
Ramuri Etichete
godot-docs
ZIP TAR.GZ
Kyle Starr e4268cf580 Update getting_started/step_by_step/scripting_player_input.rst 1 an în urmă
.github 1825a772e6 Bump actions/checkout from 3 to 4 1 an în urmă
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 an în urmă
_static 04020f1c08 Fix `/` keyboard shortcut to allow typing `/` within the search field 1 an în urmă
_styleguides 88970e5daa Add German style guide 1 an în urmă
_templates 0a01baec10 Fix epub-related failures (#8207) 1 an în urmă
_tools 643001f9b1 Merge pull request #8450 from Cerno-b/reorganise-about-headers 1 an în urmă
about d774910c3b Update introduction.rst 1 an în urmă
classes dce008340a classref: Sync with current master branch (13a0d6e) 1 an în urmă
community 5966ffdca4 Merge pull request #8364 from JohnSmith757/patch-1 1 an în urmă
contributing 43f0195ba1 Merge pull request #8657 from aaronfranke/template-target 1 an în urmă
getting_started e4268cf580 Update getting_started/step_by_step/scripting_player_input.rst 1 an în urmă
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 ani în urmă
tutorials d8f2ce6d6f Update spatial_shader.rst to mention godot use the same VIEW vector for both perspective and orthogonal cameras. 1 an în urmă
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 ani în urmă
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 ani în urmă
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 ani în urmă
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 ani în urmă
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 ani în urmă
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 2 ani în urmă
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 ani în urmă
Makefile 31204023b6 Makefile: use sphinx-build -M 2 ani în urmă
README.md 9d1dd80374 Build ePubs of the documentation for offline reading 2 ani în urmă
conf.py 04020f1c08 Fix `/` keyboard shortcut to allow typing `/` within the search field 1 an în urmă
index.rst bc2ff75da2 Reorganise "about" headers 1 an în urmă
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 ani în urmă
requirements.txt b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting 2 ani în urmă
robots.txt fd5f6f4909 Appease our great search engine overlords 5 ani în urmă

README.md

Godot Engine documentation

This repository contains the source files of Godot Engine's documentation, in reStructuredText markup language (reST).

They are meant to be parsed with the Sphinx documentation builder to build the HTML documentation on Godot's website.

Download for offline use

To browse the documentation offline, you can use the mirror of the documentation hosted on DevDocs. To enable offline browsing on DevDocs, you need to:

  • Click the three dots in the top-left corner, choose Preferences.
  • Enable the desired version of the Godot documentation by checking the box next to it in the sidebar.
  • Click the three dots in the top-left corner, choose Offline data.
  • Click the Install link next to the Godot documentation.

You can also download an HTML copy for offline reading (updated every Monday). Extract the ZIP archive then open the top-level index.html in a web browser.

For mobile devices or e-readers, you can also download an ePub copy for offline reading (updated every Monday). Extract the ZIP archive then open the GodotEngine.epub file in an e-book reader application.

Theming

The Godot documentation uses the default sphinx_rtd_theme with many customizations applied on top. It will automatically switch between the light and dark theme depending on your browser/OS' theming preference.

If you use Firefox and wish to use the dark theme regardless of your OS configuration, you can install the Dark Website Forcer add-on.

Contributing

All contributors are welcome to help on the Godot documentation.

To get started, head to the Contributing section of the online manual. There, you will find all the information you need to write and submit changes.

Here are some quick links to the areas you might be interested in:

  1. Contributing to the online manual
  2. Contributing to the class reference
  3. Content guidelines
  4. Writing guidelines
  5. Building the manual
  6. Translating the documentation

License

At the exception of the classes/ folder, all the content of this repository is licensed under the Creative Commons Attribution 3.0 Unported license (CC BY 3.0) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community". See LICENSE.txt for details.

The files in the classes/ folder are derived from Godot's main source repository and are distributed under the MIT license, with the same authors as above.