Core: Deprecate Utils.get_options by July 31st, 2025

[NewSoupVi]

The deprecation of Utils.get_options is long overdue.

Worlds can take the easy route and just switch to settings.get_settings(), but in a lot of cases, there may also be a more proper way to use the new settings API.
There is MyWorld.settings (or self.settings from inside a world instance), and also settings can be accessed via .setting_name now, rather than ["setting_name"]
https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/settings%20api.md

Proper migration to this API is encouraged to avoid another round of deprecation in the future.

Either way, worlds who still call Utils.get_options must switch over one way or another.

From a quick "find usages" in PyCharm, these are the worlds using it:

• DKC3 - DKC3 & SMW: Stop Using Utils.get_options #5341
• FF1
• LADX - LADX: Stop using Utils.get_options #4818
• Minecraft - Minecraft: Stop using Utils.get_options #4879
• MMBN3
• OoT
• Pokemon RB
• Super Mario World - DKC3 & SMW: Stop Using Utils.get_options #5341
• Super Metroid - [SM, SMZ3] get options deprecation #5257
• SMZ3 - [SM, SMZ3] get options deprecation #5257
• Secret of Evermore
• Wargroove
• Zelda 1 - The Legend of Zelda: v2 Improvements #4832

Additionally, there are some worlds/places that do Utils.get_settings(), which only works because Utils imports settings.get_settings(). These kinds of transitive imports are very much discouraged, so let's get rid of them here too.

• Adventure
• Alttp - ALTTP/SNIC/BHC: Stop using Utils.get_settings() #5239
• BizHawk Client - ALTTP/SNIC/BHC: Stop using Utils.get_settings() #5239
• Factorio
• Multiserver - MultiServer: import get_settings from the correct module #4914
• SNIClient - ALTTP/SNIC/BHC: Stop using Utils.get_settings() #5239

I would ask these maintainers of these worlds to open the appropriate PRs by July 31st.

[NewSoupVi]

@PoryGone (I noticed lx isn't a maintainer for SMW btw, idk if that's correct, feel free to ignore I just noticed it)
@threeandthreee
@digiholic
@Alchav
@lordlou
@black-sliver
@FlySniper
@t3hf1gm3nt

FF1, Minecraft (kind of) and OoT are unmaintained, so that responsibility lies with core, although help is appreciated of course. :)

[FlySniper]

Wargroove already has a PR to fix this here: https://github.com/ArchipelagoMW/Archipelago/pull/4764/files#diff-4d91617fe518a776ef29cfee1785d1ed26e99d9d424d3d9bbb926fd9484408b9R140

[qwint]

add to the list Adventure, BizHawk Client, Multiserver, SNIClient, factorio, and alttp because they use Utils.get_settings() which only exists because Utils.get_options needs to import settings.get_settings

[t3hf1gm3nt]

Looks like TLOZ uses the old method exactly once to find the filepath for our baserom (line 74 of Rom.py)

@Rosalie-A knowing that you have the Z1 update out there, how do you wanna proceed with this? (looks like it would be on line 144 of Rom.py on your beta branch)

[NewSoupVi]

add to the list Adventure, BizHawk Client, Multiserver, SNIClient, factorio, and alttp because they use Utils.get_settings() which only exists because Utils.get_options needs to import settings.get_settings

Thanks for pointing that out.
I added it to the PR.

With it, we get a couple more pings.
@JusticePS
@Berserker66

[Rosalie-A]

Looks like TLOZ uses the old method exactly once to find the filepath for our baserom (line 74 of Rom.py)

@Rosalie-A knowing that you have the Z1 update out there, how do you wanna proceed with this? (looks like it would be on line 144 of Rom.py on your beta branch)

I'll just bundle this one into the update, since I'll be submitting that sometime in the near future.

[t3hf1gm3nt]

#4832 will update TLOZ to use the new API (along with everything else that PR does)

[Rosalie-A]

Just double checked and #4448 no longer has Utils.get_options in the new client for FF1.

[qwint]

FYI for tracking, MMBN3 got this fix added to #4575 based on review

[Alchav]

I don't see where this is being used in pokemon_rb

[qwint]

I don't see where this is being used in pokemon_rb

looks like it was fixed in #4801
https://github.com/ArchipelagoMW/Archipelago/pull/4801/files#diff-7723e9776c2924a9599153f2992533ee31b576cc56beb9c98d7fec7327238e07L697

[NewSoupVi]

Oh nice, I missed that. Clicked the checkbox now :3

[NewSoupVi]

@t3hf1gm3nt Y'all have opened a PR, but it's in draft... I appreciate the effort, but obviously I can't really "count that". How close is that PR from being ready?

@PoryGone DKC3 and SMW still have Utils.get_options
@lordlou SM and SMZ3 still have Utils.get_options

ALTTP, BizhawkClient, and SNIClient also still need to remove their use of Utils.get_settings(). In case of BHC and SNIC, this is on core. In case of ALTTP, @Berserker66

[NewSoupVi]

If I missed something, let me know. I did a quick CTRL+Shift+F and saw that MMBN3 was actually fixed in an unrelated PR, yay :) But I still could have misidentified things.

[t3hf1gm3nt]

@t3hf1gm3nt Y'all have opened a PR, but it's in draft... I appreciate the effort, but obviously I can't really "count that". How close is that PR from being ready?

TBH I have no idea. Been mostly hands off of v2 outside the one test game I ran. That'd be a question for @Rosalie-A

[NewSoupVi]

@Rosalie-A there is also a Utils.get_options() in your client.

[Exempt-Medic]

OptionsType = Settings # TODO: remove when removing get_options

[NewSoupVi]

Merging start of next cycle