Skip to content

Commit 1e31d21

Browse files
committed
Added web export splash color variable documentation
Additionally linked to project settings exposed as placeholder variables
1 parent e7d5ab3 commit 1e31d21

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

tutorials/platform/web/customizing_html5_shell.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,10 @@ The only required placeholders are:
6262
The following optional placeholders will enable some extra features in your custom HTML template.
6363

6464
- ``$GODOT_PROJECT_NAME``:
65-
The project name as defined in the Project Settings. It is a good idea to use it as a ``<title>``
66-
in your template.
65+
The project name as defined in the
66+
:ref:`Name <class_ProjectSettings_property_application/config/name>` setting
67+
in **Project Settings > Application > Config**.
68+
It is a good idea to use it as a ``<title>`` in your template.
6769

6870
- ``$GODOT_HEAD_INCLUDE``:
6971
A custom string to include in the HTML document just before the end of the ``<head>`` tag. It
@@ -72,7 +74,14 @@ The following optional placeholders will enable some extra features in your cust
7274
HTML ``head`` element from the Godot Editor, e.g. for different Web export presets.
7375

7476
- ``$GODOT_SPLASH``:
75-
Path to an image used as the boot splash as defined in the Project Settings.
77+
The path to the image used as the boot splash as defined in the
78+
:ref:`Image <class_ProjectSettings_property_application/boot_splash/image>` setting
79+
in **Project Settings > Application > Boot Splash**.
80+
81+
- ``$GODOT_SPLASH_COLOR``
82+
The splash screen background color as defined in the
83+
:ref:`BG Color <class_ProjectSettings_property_application/boot_splash/bg_color>` setting
84+
in **Project Settings > Application > Boot Splash**, converted to a hex color code.
7685

7786
When the custom page is ready, it can be selected in the export options under the *Html / Custom Html Shell*
7887
section.

0 commit comments

Comments
 (0)