diff --git a/docs/source/_static/button_colour_parameters.png b/docs/source/_static/button_colour_parameters.png new file mode 100644 index 00000000..38f63c2d Binary files /dev/null and b/docs/source/_static/button_colour_parameters.png differ diff --git a/docs/source/_static/drop_down_colour_parameters.png b/docs/source/_static/drop_down_colour_parameters.png new file mode 100644 index 00000000..dde5429b Binary files /dev/null and b/docs/source/_static/drop_down_colour_parameters.png differ diff --git a/docs/source/_static/horizontal_slider_colour_parameters.png b/docs/source/_static/horizontal_slider_colour_parameters.png new file mode 100644 index 00000000..b935010f Binary files /dev/null and b/docs/source/_static/horizontal_slider_colour_parameters.png differ diff --git a/docs/source/_static/label_colour_parameters.png b/docs/source/_static/label_colour_parameters.png new file mode 100644 index 00000000..6fbcdc46 Binary files /dev/null and b/docs/source/_static/label_colour_parameters.png differ diff --git a/docs/source/_static/screen_space_health_bar_colour_parameters.png b/docs/source/_static/screen_space_health_bar_colour_parameters.png new file mode 100644 index 00000000..614dd8f7 Binary files /dev/null and b/docs/source/_static/screen_space_health_bar_colour_parameters.png differ diff --git a/docs/source/_static/text_box_colour_parameters.png b/docs/source/_static/text_box_colour_parameters.png new file mode 100644 index 00000000..99a320ab Binary files /dev/null and b/docs/source/_static/text_box_colour_parameters.png differ diff --git a/docs/source/_static/text_entry_line_colour_parameters.png b/docs/source/_static/text_entry_line_colour_parameters.png new file mode 100644 index 00000000..3f76eff9 Binary files /dev/null and b/docs/source/_static/text_entry_line_colour_parameters.png differ diff --git a/docs/source/_static/vertical_scroll_bar_colour_parameters.png b/docs/source/_static/vertical_scroll_bar_colour_parameters.png new file mode 100644 index 00000000..2ce6fc68 Binary files /dev/null and b/docs/source/_static/vertical_scroll_bar_colour_parameters.png differ diff --git a/docs/source/_static/world_space_health_bar_colour_parameters.png b/docs/source/_static/world_space_health_bar_colour_parameters.png new file mode 100644 index 00000000..49c51aaa Binary files /dev/null and b/docs/source/_static/world_space_health_bar_colour_parameters.png differ diff --git a/docs/source/index.rst b/docs/source/index.rst index a179b04f..02a93a80 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -43,6 +43,7 @@ source, navigating to the project's directory (the one with setup.py in it) and .. code-block:: console python setup.py install + pip install . -U Source code on GitHub diff --git a/docs/source/theme_reference/theme_button.rst b/docs/source/theme_reference/theme_button.rst index e813dceb..40012f3c 100644 --- a/docs/source/theme_reference/theme_button.rst +++ b/docs/source/theme_reference/theme_button.rst @@ -15,6 +15,12 @@ The :class:`UIButton <.UIButton>` theming block id is 'button'. Colours ------- +.. figure:: ../_static/button_colour_parameters.png + + A diagram of which part of the element is themed by which colour parameter. This correspondence is the same for the + parameters named for the different button states e.g. the parameter 'hovered_bg' themes the same area as 'normal_bg' + when the button is in the hovered state. + :class:`UIButton <.UIButton>` makes use of these colour parameters in a 'colours' block. All of these colours can also be a colour gradient: diff --git a/docs/source/theme_reference/theme_drop_down_menu.rst b/docs/source/theme_reference/theme_drop_down_menu.rst index 3e9f09ba..8c9122e7 100644 --- a/docs/source/theme_reference/theme_drop_down_menu.rst +++ b/docs/source/theme_reference/theme_drop_down_menu.rst @@ -15,6 +15,12 @@ The :class:`UIDropDownMenu <.UIDropDownMenu>` theming block id is 'drop_down_men Colours ------- +.. figure:: ../_static/drop_down_colour_parameters.png + + A diagram of which part of the element is themed by which colour parameter. In the drop down menu it will only be + possible to see the 'dark_bg' themed regions when the buttons in the menu are themed to be transparent, or semi + transparent themselves. + :class:`UIDropDownMenu <.UIDropDownMenu>` makes use of these colour parameters in a 'colours' block. All of these colours can also be a colour gradient: diff --git a/docs/source/theme_reference/theme_horizontal_slider.rst b/docs/source/theme_reference/theme_horizontal_slider.rst index 31e25b5c..60229ab9 100644 --- a/docs/source/theme_reference/theme_horizontal_slider.rst +++ b/docs/source/theme_reference/theme_horizontal_slider.rst @@ -15,6 +15,11 @@ The :class:`UIHorizontalSlider <.UIHorizontalSlider>` theming block id is 'horiz Colours ------- +.. figure:: ../_static/horizontal_slider_colour_parameters.png + + A diagram of which part of the element is themed by which colour parameter. The slider's buttons are themed in a + separate block. + :class:`UIHorizontalSlider <.UIHorizontalSlider>` makes use of these colour parameters in a 'colours' block. All of these colours can also be a colour gradient: diff --git a/docs/source/theme_reference/theme_label.rst b/docs/source/theme_reference/theme_label.rst index bfcbd524..39e1903e 100644 --- a/docs/source/theme_reference/theme_label.rst +++ b/docs/source/theme_reference/theme_label.rst @@ -8,6 +8,11 @@ The :class:`UILabel <.UILabel>` theming block id is 'label'. Colours ------- +.. figure:: ../_static/label_colour_parameters.png + + A diagram of which part of the element is themed by which colour parameter. The text shadow **cannot** be themed + with a colour gradient. + :class:`UILabel <.UILabel>` makes use of these colour parameters in a 'colours' block. Most of these colours can also be a colour gradient: diff --git a/docs/source/theme_reference/theme_screen_space_health_bar.rst b/docs/source/theme_reference/theme_screen_space_health_bar.rst index 97c8e666..05358590 100644 --- a/docs/source/theme_reference/theme_screen_space_health_bar.rst +++ b/docs/source/theme_reference/theme_screen_space_health_bar.rst @@ -15,10 +15,14 @@ The :class:`UIScreenSpaceHealthBar <.UIScreenSpaceHealthBar>` theming block id i Colours ------- +.. figure:: ../_static/screen_space_health_bar_colour_parameters.png + + A diagram of which part of the element is themed by which colour parameter. The text shadow **cannot** be themed + with a colour gradient. + :class:`UIScreenSpaceHealthBar <.UIScreenSpaceHealthBar>` makes use of these colour parameters in a 'colours' block. Most of these colours can also be a colour gradient: - - "**normal_bg**" - The background colour/gradient of the health bar. - "**normal_text**" - The colour/gradient of the health bars's text. - "**text_shadow**" - The colour of the shadow behind the text (so it stands out better). - "**normal_border**" - The colour/gradient of the border around the health bar. @@ -67,7 +71,6 @@ Here is an example of a screen space health bar block in a JSON theme file using { "colours": { - "normal_bg": "#25292e", "normal_text": "#c5cbd8", "text_shadow": "#777777", "border": "#DDDDDD", diff --git a/docs/source/theme_reference/theme_text_box.rst b/docs/source/theme_reference/theme_text_box.rst index 0b4effb0..8ee1d250 100644 --- a/docs/source/theme_reference/theme_text_box.rst +++ b/docs/source/theme_reference/theme_text_box.rst @@ -15,6 +15,12 @@ The :class:`UITextBox <.UITextBox>` theming block id is 'text_box'. Colours ------- +.. figure:: ../_static/text_box_colour_parameters.png + + A diagram of which part of the element is themed by which colour parameter. This correspondence is the same for the + parameters named for the different link states e.g. the parameter 'link_hover' themes the same text as 'link_text' + when the link is in the hovered state. + :class:`UITextBox <.UITextBox>` makes use of these colour parameters in a 'colours' block. All of these colours can also be a colour gradient: diff --git a/docs/source/theme_reference/theme_text_entry_line.rst b/docs/source/theme_reference/theme_text_entry_line.rst index 8c94f460..d63b57cd 100644 --- a/docs/source/theme_reference/theme_text_entry_line.rst +++ b/docs/source/theme_reference/theme_text_entry_line.rst @@ -15,6 +15,10 @@ The :class:`UITextEntryLine <.UITextEntryLine>` theming block id is 'text_entry_ Colours ------- +.. figure:: ../_static/text_entry_line_colour_parameters.png + + A diagram of which part of the element is themed by which colour parameter. + :class:`UITextEntryLine <.UITextEntryLine>` makes use of these colour parameters in a 'colours' block. All of these colours can also be a colour gradient: diff --git a/docs/source/theme_reference/theme_vertical_scroll_bar.rst b/docs/source/theme_reference/theme_vertical_scroll_bar.rst index 34c39bfc..5ffcfb4e 100644 --- a/docs/source/theme_reference/theme_vertical_scroll_bar.rst +++ b/docs/source/theme_reference/theme_vertical_scroll_bar.rst @@ -15,6 +15,11 @@ The :class:`UIVerticalScrollBar <.UIVerticalScrollBar>` theming block id is 'ver Colours ------- +.. figure:: ../_static/vertical_scroll_bar_colour_parameters.png + + A diagram of which part of the element is themed by which colour parameter. The scroll bar's buttons are themed in a + separate block. + :class:`UIVerticalScrollBar <.UIVerticalScrollBar>` makes use of these colour parameters in a 'colours' block. All of these colours can also be a colour gradient: diff --git a/docs/source/theme_reference/theme_world_space_health_bar.rst b/docs/source/theme_reference/theme_world_space_health_bar.rst index b3005946..21a5dd4f 100644 --- a/docs/source/theme_reference/theme_world_space_health_bar.rst +++ b/docs/source/theme_reference/theme_world_space_health_bar.rst @@ -8,6 +8,10 @@ The :class:`UIWorldSpaceHealthBar <.UIWorldSpaceHealthBar>` theming block id is Colours ------- +.. figure:: ../_static/world_space_health_bar_colour_parameters.png + + A diagram of which part of the element is themed by which colour parameter. + :class:`UIWorldSpaceHealthBar <.UIWorldSpaceHealthBar>` makes use of these colour parameters in a 'colours' block: - "**normal_border**" - The colour/gradient of the health bar's border if it has one.