WebHost, Core: Developer-defined game option presets. #2143

ThePhar · 2023-09-03T05:23:05Z

What is this fixing or adding?

Adds a new attribute on WebWorld called options_presets which is a Dict[preset_name: str, Dict[option_name: str, custom_value: any]] that world developers can use to define special option presets for games displaying on the WebHost. The default values for any Option-derived option is also automatically added to a "Defaults" preset for easy resetting of option presets. (no more manual clearing local storage!)

This also adds a new drop down for presets that will automatically set the settings accordingly for the player on the website. See below gif for an example.

This PR also makes a couple tweaks to Player Name field to remove default value and display the placeholder value instead, allowing players to use "Player" as a name if they so desire. Also tweaks the description property in the outputted YAML to include preset name, if one was used.

For an example, check out the presets I created for rogue_legacy in the Presets.py file. You will also note that any options that are not manually listed in the preset dictionary will use the default value on the Option-derived option instead, so you don't have to manually add every individual option if they're staying as a default.

Things that still need to be done:

Add error handling for if a developer goofs and types an invalid option name or option value.
Probably a unit test to check the above!

How was this tested?

Ran WebHost and test.

If this makes graphical changes, please attach screenshots.

Example of a game with presets defined:

For games without custom presets defined:

agilbert1412 · 2023-09-03T05:55:09Z

WebHostLib/static/assets/player-settings.js

+  const preset = localStorage.getItem(`${gameName}-preset`);
+  switch (preset) {
+    case "__default":
+      settings["description"] = `Generated by https://archipelago.gg with the default preset.`;


This case does exactly the same thing as the default case, it's therefore not necessary

Negative, because it would output Generated by https://archipelago.gg with the __default preset. because it uses the value (not the display name).

And I don't want that :P

In that case, if __default and __custom include the leading underscores, would other presets also include it? Should it maybe get trimmed away here?

Other preset names shouldn't have the leading underscores.

nicholassaylor · 2023-09-04T03:12:19Z

Perhaps we can have "All Random" as one of the pre-fab presets for all games. That way, the dropdown isn't simply a reset button for games that don't have developer-provided presets.

el-u · 2023-09-04T17:25:00Z

Perhaps we can have "All Random" as one of the pre-fab presets for all games. That way, the dropdown isn't simply a reset button for games that don't have developer-provided presets.

Since "All Random" is a terrible idea for my world, I would actually prefer not having anything that could encourage people to do that.
One could probably just hide the whole dropdown for worlds without custom presets.

LegendaryLinux · 2023-09-11T21:27:14Z

I want to maintain player name not being allowed as "Player." It forces people to enter a name, and prevents name conflicts when people try to generate a game if multiple people forgot to put in a name.

nicholassaylor · 2023-09-12T03:02:11Z

I want to maintain player name not being allowed as "Player." It forces people to enter a name, and prevents name conflicts when people try to generate a game if multiple people forgot to put in a name.

Taking a look at the changes, it appears that "Player" is no longer the default value in the player-name field and instead has placeholder text. Assuming we make this field required, I think we can both allow the slot name to be "Player" and force names to be entered when generating YAMLs on the site.

LegendaryLinux · 2023-09-12T04:56:14Z

Eliminating the default value and requiring a value during validation is acceptable.

LegendaryLinux

We should hide the presets <select /> if only the default value exists. Other than that, this looks good and I'll approve.

ThePhar · 2023-11-13T01:56:13Z

I don't want to hide the presets because it allows an easy way to reset all settings BACK to default values. Hiding the box removes that functionality.

# Conflicts: # WebHostLib/options.py # WebHostLib/static/assets/player-options.js # WebHostLib/static/styles/player-options.css

ThePhar · 2023-11-13T04:48:20Z

As of this last commit, the options now look like this:

alwaysintreble · 2023-11-13T05:20:36Z

I don't like the use of meta here as meta options already have actual defined functionality

ThePhar · 2023-11-13T05:55:16Z

I don't like the use of meta here as meta options already have actual defined functionality

I'm open to alternative names.

Edit: I just removed it. New layout below:

el-u · 2023-11-13T11:36:44Z

WebHostLib/options.py

+                if option_value == "random":
+                    player_options["presetOptions"][preset_name][option_name] = option_value


If this codepath can only be reached if option_value is "random", just explicitly assign "random" here

option_value is "random". Why hardcode two strings, when one does the same thing?

WebHostLib/options.py

worlds/rogue_legacy/__init__.py

test/webhost/test_option_presets.py

WebHostLib/templates/player-options.html

WebHostLib/options.py

test/webhost/test_option_presets.py

WebHostLib/options.py

el-u · 2023-11-13T12:39:06Z

There's a bunch of option types (such as OptionList) for which trying to use them in a preset makes the WebHost fail to start.

ThePhar · 2023-11-13T13:43:41Z

There's a bunch of option types (such as OptionList) for which trying to use them in a preset makes the WebHost fail to start.

OptionList, OptionSet, OptionDict, and FreeText are not supported. As listed in the docs.

ThePhar · 2023-11-13T13:44:17Z

I suppose I could explicitly check for those in the test to ensure they're not used.

LegendaryLinux

Looks good to me. I sign off on the HTML / JS / CSS. Nice work, Phar.

test/webhost/test_option_presets.py

el-u · 2023-11-15T00:25:21Z

test/webhost/test_option_presets.py

+                                )
+                            else:
+                                self.assertTrue(
+                                    option.name_lookup[option.value] == option_value,


This could check that option.value is in option.name_lookup first (or just use get) instead of failing with KeyError

el-u · 2023-11-15T00:26:09Z

test/webhost/test_option_presets.py

+                with self.subTest(game=game_name, preset=preset_name):
+                    for option_name, option_value in preset.items():
+                        try:
+                            option = world_type.options_dataclass.type_hints[option_name].from_any(option_value)


Should we call verify on the option here?

verify needs additional setup that I didn't think was necessary for this test.

el-u · 2023-11-15T00:39:01Z

I have a bunch of options that don't work properly with this, but they are all custom classes and are caught by the test, so I guess it's fine.

ArchipelagoMW#1820 added the game name to template export, but when ArchipelagoMW#2143 began overriding the description in Javascript to name the preset it removed the game name. Also while I was here I figured we might as well not hardcode https://archipelago.gg, since it can be useful to know if a YAML was generated by some other Web Host (for example http://archipelago.gg:24242 if coming from the beta site)

…2143)

ThePhar added 2 commits September 3, 2023 00:15

WebHost: Developer-defined game option presets.

093d66b

Tweak name

3bfc902

ThePhar added is: enhancement Issues requesting new features or pull requests implementing new features. affects: webhost Issues/PRs that touch webhost and may need additional validation. labels Sep 3, 2023

ThePhar added 2 commits September 3, 2023 00:29

Optimize imports

657e415

Fix possible gen issue

0393c4c

agilbert1412 approved these changes Sep 3, 2023

View reviewed changes

LegendaryLinux self-assigned this Sep 12, 2023

LegendaryLinux requested changes Sep 12, 2023

View reviewed changes

ThePhar changed the title ~~WebHost: Developer-defined game option presets.~~ WebHost, Core: Developer-defined game option presets. Nov 13, 2023

ThePhar added the affects: core Issues/PRs that touch core and may need additional validation. label Nov 13, 2023

ThePhar added 4 commits November 12, 2023 20:10

Merge branch 'main' into game_option_presets

80a8510

# Conflicts: # WebHostLib/options.py # WebHostLib/static/assets/player-options.js # WebHostLib/static/styles/player-options.css

Layout improvements

c1e6abd

Fix number in ranges not updating on reload/preset.

085d8b6

Add validation and clean up of some presets for RL.

bcee9a8

Add documentation.

23cf8de

ThePhar marked this pull request as ready for review November 13, 2023 05:00

Revert accidental change.

a34a27b

el-u reviewed Nov 13, 2023

View reviewed changes

ThePhar added 2 commits November 13, 2023 09:12

Additional edge cases, variable name changes, and some tweaks to UI.

d2fbd89

Small style tweak to line up meta options with game options.

36f6745

LegendaryLinux approved these changes Nov 14, 2023

View reviewed changes

el-u reviewed Nov 15, 2023

View reviewed changes

ThePhar added 3 commits November 14, 2023 23:10

"optimize" an assert

6b8e537

More tweaks to tests

3714af0

Doc tweak.

c731a50

ThePhar merged commit 79ad546 into ArchipelagoMW:main Nov 16, 2023
12 checks passed

ThePhar deleted the game_option_presets branch November 16, 2023 10:37

el-u added a commit to el-u/Archipelago that referenced this pull request Nov 16, 2023

ArchipelagoMW#2143: switch from SpecialRange to NamedRange

de0fed3

el-u mentioned this pull request Nov 16, 2023

Core: Introduce new Option class NamedRange #2330

Merged

agilbert1412 mentioned this pull request Nov 16, 2023

Stardew Valley: Add Options presets #2470

Merged

remyjette mentioned this pull request Jan 9, 2024

WebHost: Restore game name in description, don't hardcode archipelago.gg #2692

Closed

Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024

WebHost, Core: Developer-defined game option presets. (ArchipelagoMW#…

1259bcc

…2143)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WebHost, Core: Developer-defined game option presets. #2143

WebHost, Core: Developer-defined game option presets. #2143

ThePhar commented Sep 3, 2023 •

edited

agilbert1412 Sep 3, 2023

ThePhar Sep 3, 2023

ThePhar Sep 3, 2023

agilbert1412 Sep 3, 2023

ThePhar Nov 13, 2023

nicholassaylor commented Sep 4, 2023

el-u commented Sep 4, 2023

LegendaryLinux commented Sep 11, 2023

nicholassaylor commented Sep 12, 2023

LegendaryLinux commented Sep 12, 2023

LegendaryLinux left a comment

ThePhar commented Nov 13, 2023

ThePhar commented Nov 13, 2023

alwaysintreble commented Nov 13, 2023

ThePhar commented Nov 13, 2023 •

edited

el-u Nov 13, 2023

ThePhar Nov 13, 2023

el-u commented Nov 13, 2023

ThePhar commented Nov 13, 2023

ThePhar commented Nov 13, 2023

LegendaryLinux left a comment

el-u Nov 15, 2023

el-u Nov 15, 2023

ThePhar Nov 16, 2023

el-u commented Nov 15, 2023

		if option_value == "random":
		player_options["presetOptions"][preset_name][option_name] = option_value

WebHost, Core: Developer-defined game option presets. #2143

WebHost, Core: Developer-defined game option presets. #2143

Conversation

ThePhar commented Sep 3, 2023 • edited

What is this fixing or adding?

How was this tested?

If this makes graphical changes, please attach screenshots.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicholassaylor commented Sep 4, 2023

el-u commented Sep 4, 2023

LegendaryLinux commented Sep 11, 2023

nicholassaylor commented Sep 12, 2023

LegendaryLinux commented Sep 12, 2023

LegendaryLinux left a comment

Choose a reason for hiding this comment

ThePhar commented Nov 13, 2023

ThePhar commented Nov 13, 2023

alwaysintreble commented Nov 13, 2023

ThePhar commented Nov 13, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

el-u commented Nov 13, 2023

ThePhar commented Nov 13, 2023

ThePhar commented Nov 13, 2023

LegendaryLinux left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

el-u commented Nov 15, 2023

ThePhar commented Sep 3, 2023 •

edited

ThePhar commented Nov 13, 2023 •

edited