Commit Graph

111 Commits

Author SHA1 Message Date
tetrapod00
09156f2ee9 Add UPDATE comments to perishable information 2024-11-17 13:50:42 -08:00
Hugo Locurcio
8af700e841 Fix incorrect notice about XDG paths working on all platforms in Data paths (#10009)
* Fix incorrect notice about XDG paths working on all platforms in Data paths

They are only effective on Linux/*BSD. (For reference, in most other apps,
it's rare for XDG environment variables to have an effect on other platforms.)

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2024-10-04 03:26:32 +02:00
Max Hilbrunner
be73f38b3f Merge pull request #9908 from Calinou/file-paths-string-methods
Document file path String methods in File paths in Godot projects
2024-10-04 03:17:40 +02:00
Hugo Locurcio
802f5b49c2 Fix outdated get_data() JSON method usage in Saving games
Direct member access is now used in Godot 4.
2024-09-16 23:30:13 +02:00
Hugo Locurcio
da9e6ea5c3 Document file path String methods in File paths in Godot projects 2024-09-05 02:28:35 +02:00
Shawn Hardern
e09439a4e0 Add missing C# code examples to documentation
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2024-08-27 11:14:49 +01:00
Shawn Hardern
93fa10d590 Add C# examples to Background loading
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2024-08-23 18:28:49 +01:00
A Thousand Ships
bd6cc665a7 Fix incorrect uses of a/an 2024-03-29 15:14:27 +01:00
skyace65
a7b87b50c0 Rename save game variable for clarity 2024-03-05 19:14:08 -05:00
Hugo Locurcio
95fb178429 Add support for user-provided comments with Giscus
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.
2024-01-11 17:51:53 +01:00
Ryan Eisenbarth
0378ba1b56 Minor text change from i to node
Keeps document consistent throughout
2023-12-11 09:13:21 -07:00
Steven Le Boëdec
1828e5ad90 Fix typo in background_loading.rst 2023-11-24 11:46:49 +09:00
Max Hilbrunner
51db4d1715 Merge pull request #8441 from Calinou/runtime-file-loading-saving-mipmaps
Document generating mipmaps in Runtime file loading and saving
2023-11-10 22:26:30 +01:00
Yuri Sizov
cd92be066d Update references to private class methods across the docs 2023-11-10 16:06:36 +01:00
Hugo Locurcio
051b6f33c6 Document generating mipmaps in Runtime file loading and saving
This is often needed when displaying loaded images on a 3D surface.
2023-11-10 10:59:31 +01:00
Hugo Locurcio
04da2fb746 Document glTF base path in Runtime file loading and saving 2023-11-09 12:54:44 +01:00
Hugo Locurcio
83b532da66 Document support for importing KTX images in Importing images
- Link to Run-time file loading and saving page where relevant.
2023-11-08 14:40:18 +01:00
Hugo Locurcio
8e264e61e8 Add class name in classref links in Run-time file loading and saving
This is more consistent with the rest of the documentation.
2023-11-08 00:46:34 +01:00
Hugo Locurcio
3ebfc56843 Add a page on runtime file loading and saving
This accompanies a new demo project.
2023-10-31 09:43:50 +01:00
Max Hilbrunner
2383ef6aba Further work on background loading tutorial 2023-05-18 09:35:35 +02:00
KittenDeveloper
6e15d35a20 Update background_loading.rst
Update tutorials/io/background_loading.rst

Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>

Update background_loading.rst

fix a warning about underlines
2023-05-17 11:56:43 +02:00
Max Hilbrunner
80a92f4071 Merge pull request #6626 from RedMser/patch-3 2023-05-06 15:00:09 +02:00
Hugo Locurcio
3dfbfbf381 Add links to demo projects where relevant (#6874)
* Add links to demo projects where relevant

- Warn about poor compute shader support on mobile GPUs (due to driver bugs).
- Update control gallery image for 4.0.
- Fix typo in Internationalizing games.

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2023-03-09 06:09:56 +01:00
Yuri Sizov
d524544e07 Improve naming and organization of some manual articles
HTML5/Web moved to their own subfolder
Global Illumination moved to their own subfolder
UI, IO, Inputs sections titles adjusted
2D, 3D tutorials grouped to improve navigation
2023-02-26 22:50:18 +01:00
Yuri Sizov
978a13bb0a Mark potentially outdated pages with a WIP warning 2023-02-26 14:21:15 +01:00
Raul Santos
b319da3f07 Update some C# examples for 4.0 (#6693)
* Update some C# examples

- Rename members that have been renamed in Godot's C# API for 4.0.
- Change `delta` parameter type to `double`.
- Ensure parameters match base declaration.
- Other minor code fixes.

---------

Co-authored-by: Paul Joannon <437025+paulloz@users.noreply.github.com>
2023-02-04 17:03:03 +01:00
Eddie (Xiao Di) Li
5c80189d97 Update Saving games documentation for Godot 4.0 (#6371) 2023-02-01 16:25:47 +01:00
RedMser
9952aeec0b Document binary variant decoding/encoding helper 2023-01-17 18:57:18 +01:00
Hugo Locurcio
509804650e Update all instances of instance() to instantiate() 2022-11-29 16:59:09 +01:00
Max Hilbrunner
6c13f5ba58 More Godot 4 renames and fixes (#6317)
* Move ImmediateGeometry -> ImmediateMesh

* More Godot 3 -> Godot 4 renames
2022-10-15 23:12:48 +02:00
Max Hilbrunner
198393eec7 More Godot 4 rename fixes (#6315)
* Spatial -> 3D, Transform, Quaternion

* File -> FileAccess

* Camera -> Camera3D

* Update references to MeshInstance and MultiMeshInstance

* ImmediateGeometry -> ImmediateMesh, misc renames
2022-10-15 20:54:47 +02:00
Jeferson 'Shin' Leite Borges
f036086dc4 Update description on the IO to use the JSON class (#6120)
* Update description on the IO to use the JSON class

* Apply suggestions from code review

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2022-10-11 09:24:26 +02:00
Rémi Verschelde
00beb9f6f5 Data paths: Fix editor paths and improve docs on custom user dir 2022-09-08 15:14:54 +02:00
Telmo "Trooper
d24f12558f Add exit condition to prevent thread from hanging in resource_queue.gd (#5833)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2022-05-23 15:01:27 +02:00
Hugo Locurcio
6a510d5556 Improve File paths in Godot projects documentation
- Fix missing word in the beginning of the page.
- Add separate table for exported project data location.
- Fix editor table mentioning `app_userdata`, as it's only relevant
  for project data.
- Remove mention of consoles as Godot currently doesn't officially
  support consoles.
- Mention that self-contained mode isn't supported for use by projects
  yet.
2022-05-06 18:09:10 +02:00
Markus Sauermann
1e6a033a8f Update tutorials: VisualServer to RenderingServer 2022-02-09 20:20:13 +01:00
Hugo Locurcio
fefe84fb23 Apply suggestions from code review 2021-12-24 19:06:29 +01:00
Hugo Locurcio
0956d0e993 Apply suggestions from code review 2021-12-24 19:05:28 +01:00
skyace65
2b7d5fec92 Fix and expand user data path information 2021-12-23 19:33:25 -05:00
zacryol
6645e09b35 State the implementation of HTML5 export for user:// path in Data Paths (#5418) 2021-11-29 02:10:56 +01:00
Aaron Franke
5c7f653347 Optimize PNG and SVG images using oxipng and svgcleaner (#5254) 2021-09-14 17:50:17 +02:00
Aaron Franke
4060179184 Remove trailing space characters (#5251) 2021-09-13 14:52:39 +02:00
Max Hilbrunner
33867029bb Merge pull request #4976 from levilindsey/master
Update the binary serialization API doc to accurately describe how Ob…
2021-08-10 12:22:35 +02:00
Max Hilbrunner
ccf9c7c67e JSON vs binary serialization improvements 2021-08-09 16:18:26 +02:00
Max Hilbrunner
7fa80b37ba Merge pull request #4977 from levilindsey/saving-games
Update the saving games doc to describe tradeoffs of JSON vs binary s…
2021-08-09 15:54:44 +02:00
Marcin Sędłak-Jakubowski
bd19917ea0 Draft: Remove "simple", "simply", "easy", and "just" from the docs (#4496)
* Various style edits

* Edit out "simple" when possible

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Clay John <claynjohn@gmail.com>
2021-07-11 14:38:53 +02:00
Levi Lindsey
6050ba3bdc Update the binary serialization API doc to accurately describe how Objects are encoded. 2021-06-16 09:35:52 -07:00
Levi Lindsey
09afb8a241 Update the saving games doc to describe tradeoffs of JSON vs binary serialization. 2021-06-14 15:28:36 -07:00
Rémi Verschelde
044b6a74f8 Cleanup uses of double spaces between words or after punctuation 2021-06-07 10:44:02 +02:00
Martin
3471030a1f Use same file name when explaining how to address it 2021-05-15 12:13:32 +02:00