From c2ea3ae6cf6ef8ca37a817c51a14f265ec3318e7 Mon Sep 17 00:00:00 2001 From: Elias Pozewaunig <64259275+elpozewaunig@users.noreply.github.com> Date: Fri, 17 Jan 2025 22:26:14 +0100 Subject: [PATCH] Documented $GODOT_SPLASH_CLASSES placeholder for custom HTML5 shells --- tutorials/platform/web/customizing_html5_shell.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/tutorials/platform/web/customizing_html5_shell.rst b/tutorials/platform/web/customizing_html5_shell.rst index 8cc954b57..06104e472 100644 --- a/tutorials/platform/web/customizing_html5_shell.rst +++ b/tutorials/platform/web/customizing_html5_shell.rst @@ -83,6 +83,20 @@ The following optional placeholders will enable some extra features in your cust :ref:`BG Color ` setting in **Project Settings > Application > Boot Splash**, converted to a hex color code. +- ``$GODOT_SPLASH_CLASSES``: + This placeholder provides a string of setting names and their values, which affect the splash screen. + This string is meant to be used as a set of CSS class names, which allows styling the splash image + based on the splash project settings. + The following settings from **Project Settings > Application > Boot Splash** are provided, + represented by the class names shown below depending on the setting's boolean value: + + - :ref:`Show Image `: + ``show-image--true``, ``show-image--false`` + - :ref:`Fullsize `: + ``fullsize--true``, ``fullsize--false`` + - :ref:`Use Filter `: + ``use-filter--true``, ``use-filter--false`` + When the custom page is ready, it can be selected in the export options under the *Html / Custom Html Shell* section.