From 34a9b81459b7cfa4960a97cbdb6e494a45cafb4d Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Tue, 21 May 2024 20:14:28 -0500 Subject: [PATCH 1/6] Docs: Fix incorrect assertion in option group docs and add detail on customizing the forced groups. --- docs/options api.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/options api.md b/docs/options api.md index 798e97781a85..ae0147dac9d2 100644 --- a/docs/options api.md +++ b/docs/options api.md @@ -86,17 +86,27 @@ class ExampleWorld(World): ``` ### Option Groups -Options may be categorized into groups for display on the WebHost. Option groups are displayed alphabetically on the -player-options and weighted-options pages. Options without a group name are categorized into a generic "Game Options" -group. +Options may be categorized into groups for display on the WebHost. Option groups are displayed in the order as specified +by your world on the player-options and weighted-options pages. + +Options without a group name are categorized into a generic "Game Options" group, which is always the first group. If +every option for your world is in a group, this group will be removed. There is also an "Items & Locations Options" +group, which is automatically created using certain specified`item_and_loc_options`. These specified options cannot be +removed from this group. + +Both the "Game Options" and "Item & Location Options" groups can be overridden by creating your own groups with +those names, and specify specific options to add to them. The "Item & Location Options" group can also be moved to a +different position in the group ordering, but "Game Options" will always be first, regardless of where it is in your +list. ```python from worlds.AutoWorld import WebWorld from Options import OptionGroup +from . import Options class MyWorldWeb(WebWorld): option_groups = [ - OptionGroup('Color Options', [ + OptionGroup("Color Options", [ Options.ColorblindMode, Options.FlashReduction, Options.UIColors, From adaac9f7e50d3803cec375495ae0df955817680a Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Tue, 21 May 2024 20:34:33 -0500 Subject: [PATCH 2/6] add docs for the visibility attribute --- docs/options api.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/options api.md b/docs/options api.md index ae0147dac9d2..b473eda640ae 100644 --- a/docs/options api.md +++ b/docs/options api.md @@ -87,7 +87,9 @@ class ExampleWorld(World): ### Option Groups Options may be categorized into groups for display on the WebHost. Option groups are displayed in the order as specified -by your world on the player-options and weighted-options pages. +by your world on the player-options and weighted-options pages. In the generated template files, there will be a comment +with the group name at the beginning of each group of options. The `start_collapsed` only affects how the groups appear +on the WebHost, with the grouping being collapsed when this is `True`. Options without a group name are categorized into a generic "Game Options" group, which is always the first group. If every option for your world is in a group, this group will be removed. There is also an "Items & Locations Options" @@ -95,9 +97,9 @@ group, which is automatically created using certain specified`item_and_loc_optio removed from this group. Both the "Game Options" and "Item & Location Options" groups can be overridden by creating your own groups with -those names, and specify specific options to add to them. The "Item & Location Options" group can also be moved to a -different position in the group ordering, but "Game Options" will always be first, regardless of where it is in your -list. +those names, and specify specific options to add to them, as well as change the visibility. The "Item & Location +Options" group can also be moved to a different position in the group ordering, but "Game Options" will always be first, +regardless of where it is in your list. ```python from worlds.AutoWorld import WebWorld From 075abbbee471044f6054783c3fee85ebc9fbd503 Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Tue, 21 May 2024 20:42:10 -0500 Subject: [PATCH 3/6] typos --- docs/options api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/options api.md b/docs/options api.md index b473eda640ae..4abfecd99e34 100644 --- a/docs/options api.md +++ b/docs/options api.md @@ -92,8 +92,8 @@ with the group name at the beginning of each group of options. The `start_collap on the WebHost, with the grouping being collapsed when this is `True`. Options without a group name are categorized into a generic "Game Options" group, which is always the first group. If -every option for your world is in a group, this group will be removed. There is also an "Items & Locations Options" -group, which is automatically created using certain specified`item_and_loc_options`. These specified options cannot be +every option for your world is in a group, this group will be removed. There is also an "Items & Location Options" +group, which is automatically created using certain specified `item_and_loc_options`. These specified options cannot be removed from this group. Both the "Game Options" and "Item & Location Options" groups can be overridden by creating your own groups with From b78841c08988aacb978be85521889b580c517599 Mon Sep 17 00:00:00 2001 From: alwaysintreble Date: Tue, 21 May 2024 20:46:55 -0500 Subject: [PATCH 4/6] review comments --- docs/options api.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/options api.md b/docs/options api.md index 4abfecd99e34..666003d7e801 100644 --- a/docs/options api.md +++ b/docs/options api.md @@ -88,8 +88,8 @@ class ExampleWorld(World): ### Option Groups Options may be categorized into groups for display on the WebHost. Option groups are displayed in the order as specified by your world on the player-options and weighted-options pages. In the generated template files, there will be a comment -with the group name at the beginning of each group of options. The `start_collapsed` only affects how the groups appear -on the WebHost, with the grouping being collapsed when this is `True`. +with the group name at the beginning of each group of options. The `start_collapsed` Boolean only affects how the groups +appear on the WebHost, with the grouping being collapsed when this is `True`. Options without a group name are categorized into a generic "Game Options" group, which is always the first group. If every option for your world is in a group, this group will be removed. There is also an "Items & Location Options" @@ -97,9 +97,9 @@ group, which is automatically created using certain specified `item_and_loc_opti removed from this group. Both the "Game Options" and "Item & Location Options" groups can be overridden by creating your own groups with -those names, and specify specific options to add to them, as well as change the visibility. The "Item & Location -Options" group can also be moved to a different position in the group ordering, but "Game Options" will always be first, -regardless of where it is in your list. +those names, allowing specifying options to add to them, as well as change whether they start collapsed. The "Item & +Location Options" group can also be moved to a different position in the group ordering, but "Game Options" will always +be first, regardless of where it is in your list. ```python from worlds.AutoWorld import WebWorld From 7126044ec07098a8221e7e46655ae0e69e794be8 Mon Sep 17 00:00:00 2001 From: Aaron Wagener Date: Tue, 21 May 2024 20:48:22 -0500 Subject: [PATCH 5/6] missed one Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> --- docs/options api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/options api.md b/docs/options api.md index 666003d7e801..fe517f5178f2 100644 --- a/docs/options api.md +++ b/docs/options api.md @@ -86,7 +86,7 @@ class ExampleWorld(World): ``` ### Option Groups -Options may be categorized into groups for display on the WebHost. Option groups are displayed in the order as specified +Options may be categorized into groups for display on the WebHost. Option groups are displayed in the order specified by your world on the player-options and weighted-options pages. In the generated template files, there will be a comment with the group name at the beginning of each group of options. The `start_collapsed` Boolean only affects how the groups appear on the WebHost, with the grouping being collapsed when this is `True`. From abbd4e50d11fb9f0606bed55bf9b38b698df9791 Mon Sep 17 00:00:00 2001 From: Aaron Wagener Date: Tue, 21 May 2024 20:57:20 -0500 Subject: [PATCH 6/6] better wording Co-authored-by: Exempt-Medic <60412657+Exempt-Medic@users.noreply.github.com> --- docs/options api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/options api.md b/docs/options api.md index fe517f5178f2..aedd5d76aaa7 100644 --- a/docs/options api.md +++ b/docs/options api.md @@ -97,7 +97,7 @@ group, which is automatically created using certain specified `item_and_loc_opti removed from this group. Both the "Game Options" and "Item & Location Options" groups can be overridden by creating your own groups with -those names, allowing specifying options to add to them, as well as change whether they start collapsed. The "Item & +those names, letting you add options to them and change whether they start collapsed. The "Item & Location Options" group can also be moved to a different position in the group ordering, but "Game Options" will always be first, regardless of where it is in your list.