stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
10,904 Commits 21 Branches 0 Tags
36455d91faed2f6ca93699d5eb9bd61d1f8e8be8
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Hugo Locurcio 36455d91fa Update C# basics for Godot 4.5 2025-10-07 17:37:36 +02:00
Hugo Locurcio e69b689540 Add JavaScript-based redirects to supplement Read the Docs redirects 
Read the Docs redirects don't reliably apply when there is a
large amount of redirects defined. While this JavaScript-based
solution is not as seamless, it has no limit on how many redirects
can be defined.
 2025-10-03 00:51:16 +02:00
Hugo Locurcio a0501c8738 Document exporting/compiling for the iOS simulator not currently being supported 
Once the issue is resolved, it could support Compatibility but not
Forward+/Mobile due to these renderers requiring a feature the iOS
simulator doesn't support (image cube arrays).
 2025-09-27 00:58:17 +02:00
Hugo Locurcio 3406f57f23 Document automatic formatting with clang-format in Shaders style guide 2025-09-19 17:00:32 +02:00
Hugo Locurcio 4d0ac0d1e4 Document Resource.duplicate(true) behavior change in Upgrading to Godot 4.5 
This also adds a missing comma in various upgrade guides.
 2025-09-18 16:45:25 +02:00
Hugo Locurcio c15a3515cd Fix license text using syntax highlighting in Complying with licenses 
This is a plain text block, so it shouldn't use syntax highlighting.
 2025-09-18 01:15:36 +02:00
Hugo Locurcio f3fd393817 Document global scope methods in Static typing in GDScript 2025-09-18 00:43:48 +02:00
Hugo Locurcio 7d28b535d5 Mention new warnings for ProjectSettings.add_property_info() in Upgrading to Godot 4.5 
The behavior is the same as before, but it now prints a warning
whereas it previously ignored the `usage` key silently.
 2025-09-17 18:51:12 +02:00
Hugo Locurcio d8ec75b547 Document TileMapLayer physics chunking caveats in Upgrading to Godot 4.5 2025-09-16 16:23:15 +02:00
Hugo Locurcio 245bdd5e83 Add documentation on using the Engine compilation configuration editor 2025-09-15 09:38:43 +02:00
Hugo Locurcio 3b11c2f5ab Fix code block highlighting in Logging 
Some blocks were using syntax highlighting when they shouldn't.
 2025-09-14 22:46:50 +02:00
Hugo Locurcio 470f11211b Fix TypedArray source link in Core types 
- Link PackedArray to `variant.h`, as this is where its typedefs are located.
 2025-09-14 03:12:12 +02:00
Hugo Locurcio 160aa371c6 Remove outdated/broken shared library section in Custom modules in C++ 
- Replace Mono example with GridMap in the introduction, as Mono/.NET is
  not enabled by default in non-C# builds.
- Recommend GDExtension in the beginning, as it's more suited for most
  use cases that involve C++ as of September 2025.
 2025-09-14 03:11:55 +02:00
Hugo Locurcio fe23e577a5 Document applying updates on MSVC in Compiling for Windows 
This is sometimes required to fix compilation errors.
 2025-09-14 02:56:49 +02:00
Hugo Locurcio 7b98025f2e Add logging documentation 
This also covers how to create custom loggers.

- Remove notice on Windows 10 requirement for `print_rich()` in Output panel,
  since Godot requires Windows 10 as of 4.5.
 2025-09-14 02:51:27 +02:00
Hugo Locurcio 52a8e988c6 Document baking lightmaps on Android in Using Lightmap global illumination 
This is supported since 4.5.
 2025-09-11 16:35:26 +02:00
Hugo Locurcio 57a1b319b0 Mention Default Theme Scale project setting in Multiple Resolutions 
- Update advice on hiDPI support for 4.4 and later.
 2025-09-11 01:36:57 +02:00
Hugo Locurcio a0d4ac92ee Add a Troubleshooting section to Exporting for the Web 
This describes how to unregister the service worker, which is useful
to avoid caching issues, especially when using one-click deploy.
 2025-09-10 23:53:47 +02:00
Hugo Locurcio 373d1641ca Add a reminder on how to group nodes in the editor in Creating the enemy 2025-09-09 23:52:50 +02:00
Hugo Locurcio 9497fb3128 Update Troubleshooting physics issues for Godot 4.5 
- Mention Jolt Physics in cases where it improves stability and performance.
- Mention TileMapLayer physics chunking.
 2025-09-01 23:45:59 +02:00
Hugo Locurcio 0b0625ca9d Update Controllers, gamepads and joysticks for SDL 3 
- Mention SDL 3 is now used for input on desktop platforms.
- Mention that mobile/web platforms may have less reliable controller
  support as they don't use SDL yet, but it's planned.
 2025-09-01 19:13:47 +02:00
Hugo Locurcio 967f758b9c Update instructions for resolution scaling in Multiple resolutions 
The previously described approach was tailored for Godot 3.x, back
when built-in 3D resolution scaling support didn't exist.

Now that resolution scaling works in all rendering methods, it's better
to use it instead.
 2025-08-30 23:38:19 +02:00
Hugo Locurcio 0b03cc70ed Clarify assignment operator in typed array/dictionary documentation 2025-08-26 18:45:48 +02:00
Hugo Locurcio 2f26289f47 Link to Pseudolocalization page in Internationalizing games 2025-08-25 17:21:35 +02:00
Hugo Locurcio 0fc73a7c0d Document REGION_RECT canvas shader built-in 
This was added in 4.5 to better accomodate Sprite2D with regions enabled.
 2025-08-22 18:18:33 +02:00
Hugo Locurcio 1e4a2584c7 Document Blender-specific 3D scene import options in Import configuration 2025-08-20 15:20:43 +02:00
Hugo Locurcio d334ecb11b Add documentation on shader baking 2025-08-18 19:22:43 +02:00
Hugo Locurcio a99353f7e5 Move Renderers page at the top of the Rendering section 
This page is usually meant to be read first to give an overview,
while other pages are on more specific subjects.

- Rename to "Overview of renderers" to be more descriptive.
 2025-08-18 16:30:56 +02:00
Hugo Locurcio f086648f3b Add pages on exporting and compiling for visionOS 
Since the instructions are basically identical to iOS, this links
to the respective iOS exporting/compiling pages (with a reminder
that visionOS support is still limited for now).
 2025-08-14 19:46:36 +02:00
Hugo Locurcio 5d8fb8d3f5 Add a section on baking lightmaps in Using GridMaps 2025-08-08 17:32:14 +02:00
Hugo Locurcio 72095a3e31 Fix incorrect [ul bullet=...] description in BBCode in RichTextLabel 
- Mention `[br]` behavior when used in a list item.
 2025-08-05 16:56:15 +02:00
Hugo Locurcio 0ca1e47f08 Fix compute shader heightmap demo link in Using compute shaders 2025-08-04 18:26:44 +02:00
Hugo Locurcio a5897077f0 Fix incorrect Intel IGP minimum requirement in System requirements 
Intel Broadwell IGPs can run Forward+/Mobile on Linux thanks
to Mesa drivers, but the Windows driver has never supported
Vulkan nor Direct3D 12 with a sufficient feature level
(and shader model).

This increases the listed requirement to use Forward+/Mobile
to Skylake (released in 2015).
 2025-08-01 00:33:32 +02:00
Hugo Locurcio 3dcb29a37e Add feature tags that can be added on export depending on export options 
`shader_baker` and `dedicated_server` are applied to exported projects
only.
 2025-07-31 16:45:55 +02:00
Hugo Locurcio 4ee80de918 Remove deprecated Intel GPA from General optimization tips 
Intel's Graphics Performance Analyzer has been deprecated and
no longer receives support. Microsoft's PIX can generally supersede
it nowadays, although it's exclusive to Direct3D 12.

This also adds links to more tools like Xcode and Special K
(the latter of which works with Direct3D 12 at least in Godot).
 2025-07-30 00:09:28 +02:00
Hugo Locurcio 8ea49b45ec Apply suggestions from code review 2025-07-28 23:25:26 +02:00
Hugo Locurcio de6b22cefc Document SSE4.2 instruction set in System requirements 
- Remove notice about Vulkan support on Windows versions older
  than 10, as Windows 10 is the minimum version for Godot 4.5
  onwards.
 2025-07-20 10:19:03 -04:00
Hugo Locurcio 38a423354b Update URL to ThorVG unsupported SVG features in Importing images 2025-07-18 00:50:01 +02:00
Hugo Locurcio 8d87843f8b Move C++ container type information from C++ usage guidelines to Core types 
- List recommended types at the top.
- Link references directly in the table.
- Remove References headings in the rest of the page.
- Update Core types for Godot 4.5.
  - Remove OAHashMap as it's no longer present in 4.5.
 2025-07-16 17:07:29 +02:00
Hugo LocurcioandA Thousand Ships b7a07ad5a4 Apply suggestions from code review 
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
 2025-07-10 15:41:55 +02:00
Hugo Locurcio a82ed18d3d Add FoldableContainer to the Control node gallery page 2025-07-08 01:08:02 +02:00
Hugo Locurcio 7ba0a7cf0e Apply suggestions from code review 2025-07-07 20:47:19 +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 ab7c43c899 Clarify rules around which scripts require @tool in Running code in the editor 
- Mention that static methods work, but not static variables.
- Emphasize the use of version control due to the lack of undo/redo.
 2025-04-22 14:47:20 +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