Skip to content

Commit 72fcb7b

Browse files
committed
Document relative paths in .gdextension files being supported
- Mention support for comments in `.gdextension` files. - List recommended import options for GDExtension icons.
1 parent eb758a0 commit 72fcb7b

File tree

1 file changed

+34
-16
lines changed

1 file changed

+34
-16
lines changed

tutorials/scripting/gdextension/gdextension_file.rst

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -50,21 +50,32 @@ Here is an example of what that can look like:
5050

5151
.. code-block:: none
5252
53+
; A comment line starts with a semicolon. This line is ignored by the engine.
5354
[libraries]
5455
55-
macos.debug = "res://bin/libgdexample.macos.template_debug.framework"
56-
macos.release = "res://bin/libgdexample.macos.template_release.framework"
57-
windows.debug.x86_32 = "res://bin/libgdexample.windows.template_debug.x86_32.dll"
58-
windows.release.x86_32 = "res://bin/libgdexample.windows.template_release.x86_32.dll"
59-
windows.debug.x86_64 = "res://bin/libgdexample.windows.template_debug.x86_64.dll"
60-
windows.release.x86_64 = "res://bin/libgdexample.windows.template_release.x86_64.dll"
61-
linux.debug.x86_64 = "res://bin/libgdexample.linux.template_debug.x86_64.so"
62-
linux.release.x86_64 = "res://bin/libgdexample.linux.template_release.x86_64.so"
63-
linux.debug.arm64 = "res://bin/libgdexample.linux.template_debug.arm64.so"
64-
linux.release.arm64 = "res://bin/libgdexample.linux.template_release.arm64.so"
65-
linux.debug.rv64 = "res://bin/libgdexample.linux.template_debug.rv64.so"
66-
linux.release.rv64 = "res://bin/libgdexample.linux.template_release.rv64.so"
67-
56+
macos.debug = "bin/libgdexample.macos.template_debug.framework" ; Inline comments are also allowed.
57+
macos.release = "bin/libgdexample.macos.template_release.framework"
58+
windows.debug.x86_32 = "bin/libgdexample.windows.template_debug.x86_32.dll"
59+
windows.release.x86_32 = "bin/libgdexample.windows.template_release.x86_32.dll"
60+
windows.debug.x86_64 = "bin/libgdexample.windows.template_debug.x86_64.dll"
61+
windows.release.x86_64 = "bin/libgdexample.windows.template_release.x86_64.dll"
62+
linux.debug.x86_64 = "bin/libgdexample.linux.template_debug.x86_64.so"
63+
linux.release.x86_64 = "bin/libgdexample.linux.template_release.x86_64.so"
64+
linux.debug.arm64 = "bin/libgdexample.linux.template_debug.arm64.so"
65+
linux.release.arm64 = "bin/libgdexample.linux.template_release.arm64.so"
66+
linux.debug.rv64 = "bin/libgdexample.linux.template_debug.rv64.so"
67+
linux.release.rv64 = "bin/libgdexample.linux.template_release.rv64.so"
68+
69+
Paths can be relative or absolute (starting with ``res://``). Relative paths are recommended,
70+
as they allow the extension to keep working if it's installed to a different folder than what's
71+
specified in the path.
72+
73+
.. tip::
74+
75+
While absolute ``res://`` paths are shown in the above example, relative paths
76+
like ``bin/libgdexample.linux.template_debug.x86_64.so`` are also allowed.
77+
Relative paths can be used to ensure the extension successfully loads
78+
regardless of which folder it was installed in.
6879

6980
Entries are matched in order, so if two sets of feature tags could match
7081
the same system, be sure to put the more specific ones first:
@@ -138,8 +149,8 @@ Architecture
138149
Icons section
139150
-------------
140151

141-
By default, Godot uses the Node icon in the scene dock for GDExtension nodes. A custom icon can be
142-
set by reference to its name and resource path of an SVG file.
152+
By default, Godot uses the Node icon in the scene dock for GDExtension nodes.
153+
A custom icon can be set by reference to its name and resource path of an SVG file.
143154

144155
For example:
145156

@@ -149,7 +160,14 @@ For example:
149160
150161
GDExample = "res://icons/gd_example.svg"
151162
152-
The path should point to a 16 by 16 pixel SVG image. Read the guide for :ref:`creating icons <doc_editor_icons>`
163+
The path should point to a 16×16 pixel SVG image, with two options enabled on the
164+
image in the Import dock:
165+
166+
- **Editor > Scale with Editor Scale**.
167+
- **Editor > Convert Colors with Editor Theme**.
168+
169+
Enabling both options ensures the icon behaves as closely as possible to
170+
the stock editor icons. Read the guide for :ref:`creating icons <doc_editor_icons>`
153171
for more information.
154172

155173
Dependencies section

0 commit comments

Comments
 (0)