Commit Graph
100 Commits
Author SHA1 Message Date
Hugo Locurcio a82ed18d3d Add FoldableContainer to the Control node gallery page 2025-07-08 01:08:02 +02:00
Hugo Locurcio 1584d94bed Document unsupported custom feature tags in EditorExportPlugin in Feature tags 2025-07-04 17:02:20 +02:00
Hugo Locurcio 9981feea66 Update ICU break iterator instructions in Internationalizing games 2025-07-04 01:56:52 +02:00
Hugo Locurcio 8fdfc1ab1f Fix incorrect notice about multithreading in Introduction to the buildsystem
- Use `-j12` in the example line to reflect the most popular
  CPU core topology in Steam hardware survey as of writing
  (6 cores/12 threads).
2025-07-03 23:37:48 +02:00
Hugo Locurcio 1fbfaf5509 Document Flameshot being cross-platform in Learning new features 2025-06-25 17:43:07 +02:00
Hugo Locurcio 79e306b892 Update section about using system libraries in Compiling for Linux/*BSD
- Mention how to use system SDL library now that SDL 3 is used
  for gamepad support.
2025-06-25 02:12:18 +02:00
Hugo Locurcio 1e6df92f02 Update Optimizing for size for Godot 4.5 (#10968)
- Document disabling physics engines (and 2D/3D physics altogether).
- Mention disabling 2D navigation separately from 3D.
- Improve LTO minimum RAM notice and remove reference to Godot 3.x.
- Update list of modules that can be disabled in a minimal 2D game.
- Update list of nodes that are disabled with `disable_advanced_gui=yes`.
2025-06-06 17:44:57 +02:00
Hugo Locurcio 8a6ad4c926 Replace uses of shorthand codeblock syntax to avoid issues with localization
Previously, many paragraphs in the documentation used `::` at the end of a line
as a replacement for a single colon (and `::` on the following line).
Due to this, the `::` was part of the extracted string for localization.
Weblate also showed a warning about the trailing `::`, as it's not
normally expected to be there.

This change requires translators to revalidate all modified strings.
However, considering many of those have broken code blocks due to translators
replacing `::` with `:`, it can be a good idea.

This also adds documentation writing guidelines for code blocks and admonitions.
This commit does not modify existing admonitions in any way (as this would
lead to a much larger diff, and require more localizable text to be revalidated
by translators).
2025-05-30 02:02:30 +02:00
Hugo Locurcio 4b45552885 Document physics interpolation and shader compilation in Fixing jitter and stutter 2025-05-28 01:19:11 +02:00
Hugo Locurcio 67bfad87f3 Mention changing the application icon in Exporting for Windows 2025-05-26 00:10:10 +02:00
Hugo Locurcio b38edbfb1a Link to Resolution scaling documentation in Multiple resolutions
These two concepts are often used together in 3D games.
2025-05-21 20:55:53 +02:00
Hugo Locurcio bd6c45b173 Mention Canvas Resize Policy in Exporting for the Web 2025-05-21 19:50:14 +02:00
Hugo Locurcio db2bc419a3 Document abstract classes in GDScript 2025-05-14 01:31:02 +02:00
Hugo Locurcio 0dcc22ffec Document [hint] tag quote support in BBCode in RichTextLabel 2025-05-13 18:13:27 +02:00
Hugo Locurcio 71d70864b5 Use bitshift and binary OR operator in to set layers in Physics introduction 2025-05-13 00:17:05 +02:00
Hugo Locurcio c82da08457 Add a table listing STL datatypes and their Godot equivalents in C++ usage guidelines
This is more comprehensive than the previous advice.
2025-04-28 22:10:41 +02:00
Hugo Locurcio c3a22b4364 Add a Troubleshooting section to Exporting packs, patches and mods
- Mention that the pack must be loaded early enough to have an effect.
- Mention load order being important.
- Mention ZIP format throughout the page, as it can be used in the same
  way as PCK files.
- Link to Run-time resource loading and saving tutorial as an alternative.
2025-04-28 19:31:15 +02:00
Hugo Locurcio 2bfc2f04cf Hide user notes on 404 page
This switches to `404.rst` instead of an embedded 404 page in `conf.py`,
so we can specify page metadata.
2025-04-28 19:04:58 +02:00
Hugo Locurcio 6c3cef80b3 Document typed dictionaries in GDScript 2025-04-26 18:33:00 +02:00
Hugo Locurcio 9401baf5bc Document loading FBX scenes in Run-time file loading and saving 2025-04-22 19:57:44 +02:00
Hugo Locurcio c737b30d5d Mention the lack of debugger support in Running code in the editor 2025-04-22 14:38:51 +02:00
Hugo Locurcio 72834c31a3 Fix typo in C# example in Running code in the editor 2025-04-22 14:14:59 +02:00
Hugo Locurcio d7fe6c2d01 Fix Sublime Text arguments in Using an external editor
- Mention automatic Exec Flags setting in 4.5.
2025-04-16 00:09:06 +02:00
Hugo Locurcio dc7843fee9 Remove outdated reference to fog transmission in Environment and post-processing
This was a 3.x feature that wasn't reimplemented in 4.x.
2025-04-15 23:39:40 +02:00
Hugo Locurcio 6eae590bee Document reading project settings with overrides taken into account in Feature tags 2025-04-11 10:13:31 -04:00
Hugo Locurcio f2110357a2 Apply suggestions from code review 2025-04-10 01:08:00 +02:00
Hugo Locurcio 93963ab701 Document support for 2D per-instance uniforms in Shading language (#10749)
* Document support for 2D per-instance uniforms in Shading language
2025-04-05 13:22:18 -04:00
Hugo Locurcio a26b51f306 Fix outdated notice about reflection probes not being supported in Compatibility 2025-04-03 01:07:05 +02:00
Hugo Locurcio 949cf045f0 Document @export_tool_button icon parameter in GDScript exports 2025-04-01 01:41:40 +02:00
Hugo Locurcio c4c6d356cc Link to class reference for each platform that can be exported to
Each page provides a list of all export options for the given platform,
which can be searched through using Ctrl + F. While this information
is also available in the editor by hovering export option names, it can't
be quickly searched through.
2025-03-31 22:17:41 +02:00
Hugo Locurcio d43055095c Document file logging in Data paths 2025-03-28 19:48:52 +01:00
Hugo Locurcio 5bf9ef3aa6 CI: Check URLs on schedule only to reduce false positives
Links occasionally fail due to network issues or other transient problems.
This should not cause pull requests to fail checks.

The check is now performed weekly at a random-looking time on Fridays
(when server load isn't too high).
2025-03-28 15:43:32 +01:00
Hugo Locurcio f03720228a Fix typo in Release policy 2025-03-24 21:48:54 +01:00
Hugo Locurcio 46471a19bf Document fgcolor and bgcolor highlight padding in BBCode in RichTextLabel 2025-03-17 19:55:40 +01:00
Hugo Locurcio 2c08d1aec8 Update 2D batching notice in Internal rendering architecture for Godot 4.4 2025-03-13 22:42:42 +01:00
Hugo Locurcio 146182c1f2 Clarify the behavior of MeshInstance3D automatic instancing 2025-03-13 22:39:38 +01:00
Hugo Locurcio 7419a4eb48 Link to C# external editor documentation in Visual Studio and VS Code Configuring an IDE 2025-03-12 23:11:59 +01:00
Hugo Locurcio 974dd5a29a Document Glow Upscale Mode project setting in Environment and post-processing 2025-03-03 20:57:08 +01:00
Hugo Locurcio ce697e05d1 Tweak GDScript code style to match style guide in The Compositor
- Use recommended multiline string syntax to ensure correct
  syntax highlighting.
2025-02-28 02:02:21 +01:00
Hugo Locurcio 721603d902 Merge pull request #10714 from Calinou/custom-postprocessing-update-anchors
Update instructions on setting Full Rect anchor in Custom post-processing
2025-02-26 21:34:14 -05:00
Hugo Locurcio 2d96a058c1 Document comma-separated values not supporting spaces between values in BBCode in RichTextLabel 2025-02-24 20:26:08 +01:00
Hugo Locurcio aec34d67ad Mention renderer limitations in Resolution scaling 2025-02-22 21:18:03 +01:00
Hugo Locurcio 51a597f7b6 GitHub Actions: Check URLs using lychee
This makes it possible to be aware of dead links and replace
them with other resources (such as archived versions) as
soon as possible.
2025-02-17 15:56:09 +01:00
Hugo Locurcio 8d9085ae7c Add guidelines on inline comments in GDScript style guide (#9433)
* Add guidelines on inline comments in GDScript style guide
2025-02-15 23:03:26 -05:00
Hugo Locurcio 35fce7fcf6 Remove unneeded dependencies from Fedora installation in Compiling for Linux/*BSD
Only a few packages are actually needed, as most libraries used by Godot
are either embedded or `dlopen()`'d at runtime.
2025-02-14 19:20:24 +01:00
Hugo Locurcio 8ee0e4fc22 Fix meaning of target=template_debug in Introduction to the buildsystem
This also mentions that available CLI arguments differ depending on
the build target.
2025-02-08 18:46:41 +01:00
Hugo Locurcio 039f8d7a19 Add a troubleshooting section to Compiling for macOS/iOS 2025-02-08 16:56:24 +01:00
Hugo Locurcio 7d34e4e42e Clarify difference between Godot's scene instancing and hardware instancing
- Link to tutorial about instancing scenes by code in Creating instances
  (and link the other way around too).
2025-02-05 11:23:25 +01:00
Hugo Locurcio cbdec4e72e Point mapping contributions to Godot in Controllers, gamepads and joysticks
GameControllerDB's upstream does not accept contributions from Godot
since it does not use SDL. Users can still create custom mappings,
but they should be submitted to Godot's controller database instead
of the SDL one.

This also adds a reference to `godotcontrollerdb.txt` which was missing
in the first place. This file is used as a complement to `gamecontrollerdb.txt`.
2025-01-29 21:57:40 +01:00
Hugo Locurcio ff84bad138 Reword warning about slow thread creation in Using multiple threads 2025-01-29 10:19:22 +01:00
Hugo Locurcio e43dd0821c Update list of spatial shader render modes for Godot 4.3
This also improves the documentation for existing render modes.
2025-01-25 18:42:57 +01:00
Hugo Locurcio c1c1bbeaf4 Add optimization tips for mobile in Exporting to HTML5 2025-01-24 03:21:19 +01:00
Hugo Locurcio 36c5f34c81 Document automatic ICO generation in Changing application icon for Windows
- Remove outdated notice about known issue.
2025-01-18 14:36:05 +01:00
Hugo Locurcio 265397c5fc Add @icon ordering to the GDScript style guide 2025-01-13 17:25:42 +01:00
Hugo Locurcio 2a9935fd44 Clarify the meaning of instancing diagram arrows in Creating instances 2025-01-08 17:58:35 +01:00
Hugo Locurcio bf1c389189 Document only direct child nodes accounting for CollisionShape2D/3D
Indirect children are currently ignored.
2025-01-08 17:48:48 +01:00
Hugo Locurcio 28a7a0bb76 Document shadowmasks in Using LightmapGI 2025-01-07 17:11:00 +01:00
Hugo Locurcio 4f70dc1ebd Mention the expected file name for the player scene in Your first 2D game 2025-01-04 00:00:32 +01:00
Hugo Locurcio a58b91ad0e Document Metal support in Internal rendering architecture 2025-01-03 18:53:17 +01:00
Hugo Locurcio f1d751b4a9 Mention Vulkan and Direct3D 12 SDK install scripts in Compiling for macOS/Windows 2025-01-03 18:50:26 +01:00
Hugo Locurcio 806a4fccfd Add a page on the Output bottom panel 2024-12-07 08:40:44 +01:00
Hugo Locurcio 0d8944df0b Mention that GIFs should be avoided in Docs image guidelines 2024-12-07 08:35:09 +01:00
Hugo Locurcio 59d97a7331 Remove instructions on setting up Pyston for faster development
This is done for several reasons:

- Recent CPython versions such as 3.13 have mostly caught up
  with Pyston in terms of performance. If the trend continues,
  CPython may supersede Pyston's performance in the long term.
  This is especially the case if the experimental JIT is
  eventually able to run Godot's SCons setup.
- Pyston is not maintained anymore (its last release was in 2022),
  and the last Python version it can run is 3.8. Python 3.8 is now
  end-of-life. Godot's SCons setup (as well as SCons itself) will
  eventually require Python versions newer than 3.8.
2024-11-29 02:05:45 +01:00
Hugo Locurcio a23d9145c1 Fix outdated reference to godot.tools.html in Compiling for the Web
It's `godot.editor.html` since Godot 4.0.
2024-11-29 02:03:36 +01:00
Hugo Locurcio f10432656c Document focus StyleBox caveats in Introduction to GUI skinning 2024-11-23 18:31:16 +01:00
Hugo LocurcioandMax Hilbrunner e402984a8a Document rand_weighted() in Random number generation (#10283)
* Document `rand_weighted()` in Random number generation

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2024-11-18 20:20:10 +01:00
338c19ca9d Document converting CSG nodes to MeshInstance3D and related lightmapping workflow (#10229)
* Document converting CSG nodes to MeshInstance3D and related lightmapping workflow

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2024-11-17 11:15:16 +01:00
703d0cdba2 Improve grammar and writing in Pipeline compilations page (#10257)
* Improve grammar and writing in Pipeline compilations page

- Mention example of off-screen rendering using ColorRect to hide
  the root viewport's 3D rendering or a SubViewport node.
- Split into more paragraphs to improve readability.
- Link to class reference pages when relevant.
- Wrap source file to 80 characters like other pages.

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: tetrapod <145553014+tetrapod00@users.noreply.github.com>
2024-11-15 16:05:02 +01:00
Hugo Locurcio 2d9aeb9740 Update Random number generation for Godot 4.2+ (#9822)
- Document `Array.pick_random()` as a shorthand.
- Use global scope random methods as they are all available in global scope now.
- Remove calls to `randomize()` that are not needed for code samples
  to be functional, as the engine now calls `randomize()` on startup
  once automatically.
2024-11-13 13:59:04 +01:00
Hugo LocurcioandShawn Hardern 4c3020b775 Document @export_custom and additional range hints in GDScript exports
This also adds a hint suffix example to C# exports.

Co-authored-by: Shawn Hardern <126725649+ShawnHardern@users.noreply.github.com>
2024-11-11 17:22:44 +01:00
Hugo Locurcio bebd5b86c4 Add color constants reference to BBCode in RichTextLabel
This reference is already present in the Color class reference,
but this embeds it directly in the page to save users a click.
2024-11-11 16:27:14 +01:00
Hugo Locurcio 40d16134a5 Document exporting as progressive web app in Exporting for the web
- Document no-threads web export and its limitations.
- Document sample-based audio playback and its limitations.
- Mention that threading issues can be worked around by exporting
  as a progressive web app.
2024-11-08 23:30:41 +01:00
Hugo Locurcio c9ec2428bc Tweak SSRL performance cost in 3D antialiasing comparison table
The screen-space roughness limiter's performance cost is very low
compared to other antialiasing methods (typically in the same
ballpark as FXAA).
2024-11-07 16:58:50 +01:00
Hugo Locurcio 8d21f6f7ec Fix link to Windows platform port in Custom platform ports
- Fix link to Linux Vulkan context code.
- Add references to Direct3D 12.
2024-11-05 08:20:03 +01:00
Hugo Locurcio e954194991 Apply suggestion from Spring arm camera pull request 2024-11-04 20:11:48 +01:00
Hugo Locurcio 47eda9fe60 Mention a way to get development snapshots' source code in Getting the source 2024-11-03 23:39:39 +01:00
Hugo Locurcio 4679999c4d Tweak constant example in Shading language to avoid referring to reserved PI 2024-10-29 15:15:43 +01:00
Hugo Locurcio 0d3ccb1f6f Mention callback argument count in The JavaScript bridge singleton 2024-10-29 15:06:53 +01:00
Hugo Locurcio 748775370a Use negative index for get_child() in Singletons (Autoload) 2024-10-27 22:24:28 +01:00
Hugo Locurcio a35d441cd7 Update URL to Microsoft codesigning guide in Exporting for Windows 2024-10-22 16:55:29 +02:00
Hugo Locurcio cbf61b3f02 Document Variant not being nullable 2024-10-17 15:28:24 +02:00
Hugo Locurcio 594a1d6cbc Mention documentation comments in GDScript basics 2024-10-17 15:12:35 +02:00
Hugo Locurcio b364717251 Tweak animation file names to be less confusing in Creating the player scene
It's more verbose, but it's easier to understand and doesn't rely on
the reader knowing how to interpret the `[1/2]` part.
2024-10-17 15:11:19 +02:00
Hugo Locurcio 30eebc4bb7 Document filename requirements in C# global classes
- Flesh out the introduction.
2024-10-17 10:45:46 +02:00
Hugo Locurcio 346af99154 Document physics spiral of death performance issue in Troubleshooting physics issues 2024-10-16 22:45:16 +02:00
Hugo Locurcio 4ab397cd5e Document generate_bundle=yes SCons option in Compiling for macOS and iOS
- Reorder instructions to mention ARM64 builds first in macOS,
  as this is the primary architecture in use now (with all new Macs
  since 2023 being sold with Apple Silicon only). The `lipo` command still
  works as before, as it infers the architecture from the input files.
- Remove the manual bundle generation steps to make the page shorter
  (similar to Compiling for Android).
- Remove references to the master branch (this was only relevant when
  4.0 was still in development).
2024-10-16 17:51:52 +02:00
Hugo Locurcio a878406e8d Clarify restrictions on nested array types in Static typing in GDScript 2024-10-16 16:23:32 +02:00
Hugo Locurcio 1bc440b2db Update Default editor shortcuts for Godot 4.3+ 2024-10-05 01:47:20 +02:00
Hugo Locurcio 36bb7e5ac5 Document expression evaluator in Debugger panel 2024-10-05 00:35:05 +02:00
Hugo LocurcioandMax Hilbrunner 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
Hugo Locurcio a9a2cd1a20 Tweak note about making Physics Material unique in Creating instances 2024-10-02 16:39:21 +02:00
Hugo Locurcio fd241c74cb Clarify "authority" in High-level multiplayer 2024-09-30 22:01:18 +02:00
Hugo Locurcio 960125f576 Fix Code order section saying it's the first section in GDScript style guide
It's not the first section of the page anymore.
2024-09-23 23:58:39 +02:00
Hugo Locurcio 7a13592c9c Link to Exporting projects in Finishing up page of Your first 2D game
After finishing your first game, you may want to share it for others
to try it out without needing to install Godot.
2024-09-19 01:44:06 +02:00
Hugo Locurcio 89508cdc98 Fix outdated reference to register_class function in GDExtension C++ example
This was replaced by the `GDREGISTER_CLASS` macro in Godot 4.0.
2024-09-19 01:33:41 +02:00
Hugo Locurcio be34108636 Document profiler autostart functionality 2024-09-16 23:33:41 +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 3acbf06937 Fix animation name in Your first 2D game 2024-09-15 17:56:30 +02:00
Hugo Locurcio 93261ab5d7 Harmonize Bash command syntax for easier line selection and copy-pasting
- Remove prompt or `$` sign which makes triple-click based selection
  more difficult and time-consuming.
- Use `platform` instead of `p` alias in all SCons examples.
2024-09-15 16:27:34 +02:00
Hugo Locurcio 8f320d5e54 Fix incorrect statement in node_type being case-insensitive in Creating script templates
On case-sensitive filesystems, the case must match the actual node name,
so the folder will most likely need to use uppercase characters in its name
(e.g. `MeshInstance3D`).
2024-09-15 16:00:05 +02:00