Core, Webhost, Docs: Replace all usages of player settings #3067

nicholassaylor · 2024-03-31T22:17:38Z

What is this fixing or adding?

Replaces the remaining usages of player settings with player options
- Made sure to avoid replacing any instances of the settings API
- Most replacements are in docs that weren't changed in Docs: replacing "setting" to "option" in world docs #2622
- No instances of /player-options remain
Changes Generate.py to reference player options, changing the --samesettings argument to --sameoptions
Removed backwards compatability for player-settings link
- /player-settings links should no longer auto-redirect to /player-options page

How was this tested?

Searched for all instances of "settings" or "player-settings" and replaced any that did not refer to the Settings API
Looked at rendered markdown
Ran Generate.py with --sameoptions argument and got expected output
- Would appreciate if another person could test argument change to make sure that I did everything correct (first time touching core)

Exempt-Medic · 2024-03-31T23:39:38Z

There's also a line in here you'll want to change: https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/archipidle/docs/guide_en.md
Specifically "setting page above"

nicholassaylor · 2024-04-01T00:05:54Z

There's also a line in here you'll want to change: https://github.com/ArchipelagoMW/Archipelago/blob/main/worlds/archipidle/docs/guide_en.md Specifically "setting page above"

Thank you, it took me a few reads to see where it was

Exempt-Medic · 2024-04-01T00:53:20Z

You can probably also update these:

https://github.com/ArchipelagoMW/Archipelago/blob/main/WebHostLib/misc.py#L40-L43
https://github.com/ArchipelagoMW/Archipelago/blob/main/WebHostLib/misc.py#L52-L55
Hmm, actually, looking at instances of weighted-settings that one probably can't be changed yet

nicholassaylor · 2024-04-01T01:38:40Z

You can probably also update these:

* https://github.com/ArchipelagoMW/Archipelago/blob/main/WebHostLib/misc.py#L40-L43

* https://github.com/ArchipelagoMW/Archipelago/blob/main/WebHostLib/misc.py#L52-L55
  Hmm, actually, looking at instances of `weighted-settings` that one probably can't be changed yet

Ahh, I didn't notice that there was specific backwards compat with weighted right now. I'll look into and see what I can find out. This PR can be marked as waiting on: author for now until I figure out the WebHost-specific changes I would need

Exempt-Medic · 2024-04-01T01:43:17Z

Ahh, I didn't notice that there was specific backwards compat with weighted right now. I'll look into and see what I can find out. This PR can be marked as waiting on: author for now until I figure out the WebHost-specific changes I would need

I think it'd be fine if this PR just did everything for player-settings. The weighted page should probably be left for later anyway

nicholassaylor · 2024-04-01T02:51:30Z

I think it'd be fine if this PR just did everything for player-settings. The weighted page should probably be left for later anyway

I suppose that works, especially with the revamped options pages in the works.

ScipioWright · 2024-04-02T13:39:15Z

I see newlines were added in several of these.
I know for option descriptions, newlines are taken into account and, in some cases, make it look weird on the website.
Did you check to make sure that doesn't happen with these pages too?

nicholassaylor · 2024-04-02T14:31:03Z

I can double check, all of those newline were added in by PyCharm automatically

alwaysintreble · 2024-04-02T16:34:25Z

unsure if it's in scope for this PR but there are some remaining f strings in Generate.py that still reference player settings

LegendaryLinux · 2024-04-02T17:52:50Z

Thus far this does not conflict with the option-gruops PR, so it has my approval pending any further changes.

…ameoptions

nicholassaylor · 2024-04-04T23:33:46Z

unsure if it's in scope for this PR but there are some remaining f strings in Generate.py that still reference player settings

I did my best to address the Generate.py f strings and arguments. I think I caught everything in there

I see newlines were added in several of these. I know for option descriptions, newlines are taken into account and, in some cases, make it look weird on the website. Did you check to make sure that doesn't happen with these pages too?

I reverted all of the changes that were just newlines put in automatically. None of the files should have different newline behaviors.

… the newlines

Exempt-Medic · 2024-04-05T13:05:43Z

Not really sure what your Discord name is, if anything, but I opened a PR on your fork with two suggested changes

Exempt-Medic

Two small things that stuck out. Everything else looks good

worlds/archipidle/docs/guide_fr.md

Exempt-Medic · 2024-04-05T13:13:35Z

worlds/minecraft/docs/minecraft_sv.md

@@ -103,8 +103,6 @@ shuffle_structures:
  off: 0
 ```

-För mer detaljer om vad varje inställning gör, kolla standardinställningen `PlayerSettings.yaml` som kommer med


You removed this paragraph for some reason?

This paragraph references the PlayerSettings.yaml file that no longer exists as of #3062 . The document overall is very outdated, but I don't know any Swedish to update it.

Sounds good to me then!

One missed "setting", removing a fallback

Co-authored-by: Exempt-Medic <[email protected]>

Exempt-Medic

All the changes LGTM. Searched for other instances of "settings" in the options sense and didn't find any

…goMW#3067) * Replace all usages of player settings * Fixed line break error * Attempt to fix line break again * Finally figure out what Pycharm did to this file * Pycharm search failed me * Remove duplicate s * Update ArchipIdle * Revert random newline changes from Pycharm * Remove player settings from fstrings and rename --samesettings to --sameoptions * Finally get PyCharm to not auto-format my commits, randomly inserting the newlines * Removing player-settings * Missed one * Remove final line break error Co-authored-by: Exempt-Medic <[email protected]> --------- Co-authored-by: Exempt-Medic <[email protected]> Co-authored-by: Exempt-Medic <[email protected]>

nicholassaylor and others added 4 commits March 31, 2024 18:06

Replace all usages of player settings

dfdbfe8

Fixed line break error

67eb6c0

Attempt to fix line break again

acb6c0f

Finally figure out what Pycharm did to this file

2e0dfff

nicholassaylor requested a review from Berserker66 as a code owner March 31, 2024 22:17

github-actions bot added affects: core Issues/PRs that touch core and may need additional validation. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels Mar 31, 2024

Pycharm search failed me

b499759

nicholassaylor requested a review from LegendaryLinux as a code owner March 31, 2024 22:33

Remove duplicate s

8b20e84

Update ArchipIdle

f671533

Merge branch 'main' into docs-settings-cleanup

ae6132c

nicholassaylor added 2 commits April 4, 2024 19:20

Revert random newline changes from Pycharm

a33dcfa

Remove player settings from fstrings and rename --samesettings to --s…

feac0a4

…ameoptions

nicholassaylor changed the title ~~Docs: Replace all usages of player settings~~ Core, Docs: Replace all usages of player settings Apr 4, 2024

Merge branch 'main' into docs-settings-cleanup

20a82c5

nicholassaylor and others added 3 commits April 5, 2024 00:54

Finally get PyCharm to not auto-format my commits, randomly inserting…

414b9bb

… the newlines

Removing player-settings

64f57ea

Missed one

6f773ad

Exempt-Medic requested changes Apr 5, 2024

View reviewed changes

Merge pull request #2 from Exempt-Medic/patch-1

c6781fd

One missed "setting", removing a fallback

github-actions bot added the affects: webhost Issues/PRs that touch webhost and may need additional validation. label Apr 5, 2024

Remove final line break error

e9b7591

Co-authored-by: Exempt-Medic <[email protected]>

nicholassaylor changed the title ~~Core, Docs: Replace all usages of player settings~~ Core, Webhost, Docs: Replace all usages of player settings Apr 5, 2024

Exempt-Medic approved these changes Apr 5, 2024

View reviewed changes

LegendaryLinux approved these changes Apr 6, 2024

View reviewed changes

LegendaryLinux merged commit 569c37c into ArchipelagoMW:main Apr 6, 2024
15 checks passed

nicholassaylor deleted the docs-settings-cleanup branch April 7, 2024 00:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Core, Webhost, Docs: Replace all usages of player settings #3067

Core, Webhost, Docs: Replace all usages of player settings #3067

nicholassaylor commented Mar 31, 2024 •

edited

Loading

Exempt-Medic commented Mar 31, 2024 •

edited

Loading

nicholassaylor commented Apr 1, 2024

Exempt-Medic commented Apr 1, 2024 •

edited

Loading

nicholassaylor commented Apr 1, 2024

Exempt-Medic commented Apr 1, 2024

nicholassaylor commented Apr 1, 2024 •

edited

Loading

ScipioWright commented Apr 2, 2024

nicholassaylor commented Apr 2, 2024

alwaysintreble commented Apr 2, 2024

LegendaryLinux commented Apr 2, 2024

nicholassaylor commented Apr 4, 2024

Exempt-Medic commented Apr 5, 2024

Exempt-Medic left a comment

Exempt-Medic Apr 5, 2024

nicholassaylor Apr 5, 2024

Exempt-Medic Apr 5, 2024

Exempt-Medic left a comment

Core, Webhost, Docs: Replace all usages of player settings #3067

Core, Webhost, Docs: Replace all usages of player settings #3067

Conversation

nicholassaylor commented Mar 31, 2024 • edited Loading

What is this fixing or adding?

How was this tested?

Exempt-Medic commented Mar 31, 2024 • edited Loading

nicholassaylor commented Apr 1, 2024

Exempt-Medic commented Apr 1, 2024 • edited Loading

nicholassaylor commented Apr 1, 2024

Exempt-Medic commented Apr 1, 2024

nicholassaylor commented Apr 1, 2024 • edited Loading

ScipioWright commented Apr 2, 2024

nicholassaylor commented Apr 2, 2024

alwaysintreble commented Apr 2, 2024

LegendaryLinux commented Apr 2, 2024

nicholassaylor commented Apr 4, 2024

Exempt-Medic commented Apr 5, 2024

Exempt-Medic left a comment

Choose a reason for hiding this comment

Exempt-Medic Apr 5, 2024

Choose a reason for hiding this comment

nicholassaylor Apr 5, 2024

Choose a reason for hiding this comment

Exempt-Medic Apr 5, 2024

Choose a reason for hiding this comment

Exempt-Medic left a comment

Choose a reason for hiding this comment

nicholassaylor commented Mar 31, 2024 •

edited

Loading

Exempt-Medic commented Mar 31, 2024 •

edited

Loading

Exempt-Medic commented Apr 1, 2024 •

edited

Loading

nicholassaylor commented Apr 1, 2024 •

edited

Loading