WebHost: unify references to options #2037
Conversation
ThePhar
added
is: documentation
|
On the third image it shows "download a options file." This should be, "download an options file". Since this draft is about language, might as well make sure the grammar is correct. |
|
Semantically there is a difference between a setting and an option. A setting has both a name and a set of options. I also don't want to change the title of the pages away from "Player Settings" and "Weighted Settings." In your first image, the only inconsistency is the header "Game Options", which should be changed to "Game Settings." The rest is correct as written. |
So, semantically, I agree. I should've more clearly outlined the goal/reasoning in the original post so that's on me. Previously, in the API we've been kind of using settings and options interchangeably, but as of 827444f this is no longer the case. We now have a clear cut line in the actual Archipelago API on wh at an "option" and a "setting" are, used to define 2 separate interactions, where an option is a player submitted choice for their world, and a setting is the host configured choices for the multiworld, and the local settings used to configure their Archipelago installation (ROM paths etc). Primary goal of this PR is to unify these terms so that any references to options are called options, and references to settings are settings. I'm open to compromise if you still believe it, but context is important here. |
There was a problem hiding this comment.
The change to use consistent language is very welcome from a my point of view. When people talk about "player options" it should be clear that the game's option api will be used. When people talk about "game settings" it should be clear that we talk about the game's settings api/host.yaml.
"Player settings" is unclear in that regard.
# Conflicts: # WebHostLib/static/styles/player-options.css
# Conflicts: # WebHostLib/misc.py # WebHostLib/static/assets/player-options.js
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
# Conflicts: # WebHostLib/static/assets/weighted-options.js
|
Hm, we use |
|
I did |
|
I think the decision we reached a while ago was to change all touched strings from |
The request for the JSON file that provides the setting data was missed during the rename in ArchipelagoMW#2037, so prior to this the weighted settings page wasn't rendering at all.
The request for the JSON file that provides the setting data was missed during the rename in #2037, so prior to this the weighted settings page wasn't rendering at all.
* Factor out a common function for building lists * Expose name groups through the weighted-settings UI * Fix weighted-settings page The request for the JSON file that provides the setting data was missed during the rename in #2037, so prior to this the weighted settings page wasn't rendering at all.
* WebHost: unify references to options * it was just an extra s the whole time... * grammar * redirect from old pages * redirect stuff correctly * use url_for * use " for modified strings * remove redirect cache * player_settings * update site map
The request for the JSON file that provides the setting data was missed during the rename in ArchipelagoMW#2037, so prior to this the weighted settings page wasn't rendering at all.
…lagoMW#2327) * Factor out a common function for building lists * Expose name groups through the weighted-settings UI * Fix weighted-settings page The request for the JSON file that provides the setting data was missed during the rename in ArchipelagoMW#2037, so prior to this the weighted settings page wasn't rendering at all.
* WebHost: unify references to options * it was just an extra s the whole time... * grammar * redirect from old pages * redirect stuff correctly * use url_for * use " for modified strings * remove redirect cache * player_settings * update site map
The request for the JSON file that provides the setting data was missed during the rename in ArchipelagoMW#2037, so prior to this the weighted settings page wasn't rendering at all.
…lagoMW#2327) * Factor out a common function for building lists * Expose name groups through the weighted-settings UI * Fix weighted-settings page The request for the JSON file that provides the setting data was missed during the rename in ArchipelagoMW#2037, so prior to this the weighted settings page wasn't rendering at all.
What is this fixing or adding?
Unify references to options in the webhost as options, instead of using options and settings interchangeably.
How was this tested?
Running webhost and viewing the changes. Weighted options page is currently broken so putting in draft for now.
If this makes graphical changes, please attach screenshots.