Core, all worlds: Hard-deprecate old options API (by August 10th 2024)

[NewSoupVi]

world.options_definitions and accessing option values through world.multiworld.option_name[player] was deprecated in #993.

We are now looking to hard deprecate it.

Here is every world in source, and whether it is confirmed to have fully moved over:

• Core
• Adventure - Adventure: Update to use new options api #3326
• ALTTP
• ArchipIDLE
• BK Sudoku
• Blasphemous
• Bumper Stickers
• Celeste 64
• ChecksFinder
• Clique - PR Planned, not opened
• CV64
• DarkSouls3 - DS3: Version 3.0.0 #3128
• DKC3
• DLCQuest
• Doom
• Doom II
• Factorio
• FF1
• FFMQ - FFMQ: Efficiency Improvement and Use New Options Methods #2767
• Heretic
• HK
• Hylics 2
• KDL3
• KH2
• LADX
• Landstalker
• Lingo
• Lufia 2
• Meritous
• Messenger
• Minecraft
• MLSS
• MMBN3
• Muse Dash
• Noita
• OoT
• Overcooked 2
• Pokemon Emerald
• Pokemon RB
• Raft
• Rogue Legacy - PR planned, not opened
• RoR2
• SA2B
• SC2
• Shivers -Shivers: New features and removes two missed options using the old options API #3287
• A Short Hike
• SM - SM and SMZ3 option_definitions deprecation fix #3372
• SM64
• SMW
• SMZ3 - SM and SMZ3 option_definitions deprecation fix #3372
• SoE
• Slay the Spire
• Stardew Valley
• Subnautica - swim_rule
• Terraria
• Timespinner - Timespinner: migrate to new options api and correct random #2485
• TLOZ
• TUNIC
• Undertale
• V6
• Wargroove
• Witness
• Yoshi's Island
• Zillion
• Zork - Grand Inquisitor

The reason some worlds are "unconfirmed" is that it's not a trivial thing, some worlds might be using the new options API mostly, but using the old one in one instance at runtime. Also, some worlds might call their multiworld reference "world" or "mw". I did my best, please forgive any shortcomings of this initial list.

Also, there are generic features such as starting_inventory which are part of the options api, while others, like local_early_items, are not. The ones that are part of options and have to be accessed through the new API can be found in the PerGameCommonOptions class:

@dataclass
class PerGameCommonOptions(CommonOptions):
    local_items: LocalItems
    non_local_items: NonLocalItems
    start_inventory: StartInventory
    start_hints: StartHints
    start_location_hints: StartLocationHints
    exclude_locations: ExcludeLocations
    priority_locations: PriorityLocations
    item_links: ItemLinks

If your game is not checked off on this list, you will be given three months (Until the 10th of August, 2024) to do one of the following:

1. Confirm that your world is already fully moved over
2. Open a PR to move it to the new options API (it does not need to be merged by the deadline, just opened)

If neither of these are met by the deadline, core maintainers are entitled to go in and fix it themselves, or move your world to worlds_disabled if they can't figure out how to do it. You also might lose some status as a "responsive world maintainer", so please do not rely on core maintainers going in and doing it for you.

The new API is detailed here: https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/options%20api.md

If you have any questions, people will be happy to help you in the designated channels, such as #ap-world-dev in the Discord server!

World maintainers of worlds that are failing or unconfirmed:
@JusticePS @Berserker66 @TRPG0 @SunCatMC @ThePhar @LiquidCat64 @Marechal-L @axe-y @agilbert1412 @jtoyoda @Alchav @wildham0 @Daivuk @BadMagic100 @Silvris @JaredWeakStrike @zig-for @KonoTyran @espeon65536 @SunnyBat @PoryGone @RaspberrySpace @GodlFire @lordlou @Seldom-SE @Jarno458 @silent-destroyer @ScipioWright @NewSoupVi @jonloveslegos @FlySniper
If all of your worlds already are marked off, congratulations, your world passed the check independently since I created this PR thanks to the work of some lovely people~

[PoryGone]

SMW should be done as of this PR opened in January and merged in March:
#2762

SA2B is slated for resolution with our next content update, which does not yet have a release window.

[PoryGone]

Also, did you cross-reference with the output provided by this:

Archipelago/worlds/AutoWorld.py

Line 83 in d48f2ab

logging.warning(f"{name} Assigned options through option_definitions which is now deprecated. "

[ScipioWright]

TUNIC is good to go

[NewSoupVi]

SMW should be done as of this PR opened in January and merged in March: #2762

My bad, I was on something outdated :) Will mark SMW as resolved

[NewSoupVi]

Also, did you cross-reference with the output provided by this:

Archipelago/worlds/AutoWorld.py

Line 83 in d48f2ab

logging.warning(f"{name} Assigned options through option_definitions which is now deprecated. "

I did, yes, that's how I confirmed some worlds were bad immediately, before going in and checking whether any worlds offend in different ways at runtime

[NewSoupVi]

TUNIC is good to go

Alrighty :)

[NewSoupVi]

SA2B is slated for resolution with our next content update, which does not yet have a release window.

As for SA2B, I will accept that for now, but if it takes so long that we're past the deadline and SA2B is the last world on old options, I will ask for something to be done about it ahead of the content update. Hopefully not tho

[BadMagic100]

Just mentioning because I was pinged here, the world side of HK is not my problem. This is a phar issue, I have no intent of trying to figure out how to programmatically generate a dataclass (this change is like actively bad for HK, fwiw)

[BadMagic100]

From a code perspective there at least one block of code somewhere with a "todo: remove this when the old way is deprecated" which I don't see removed here.

[NewSoupVi]

From a code perspective there at least one block of code somewhere with a "todo: remove this when the old way is deprecated" which I don't see removed here.

That's fair, this is a copy of #3284 which as I understand didn't actually aim to remove this functionality & wanted to preserve it working on the WebHost

I'm more here to lead the charge in getting all the worlds changed - @alwaysintreble can I involve you in this to think about the code side of what a hard removal with all worlds being forced to switch over would look like?
Maybe also some of the other core maintainers reading this, because there is the question of "should we completely break old unmaintained unsupported .apworlds with no way of getting them running anymore unless you go in and change the code" - Like, is that something we care about, to the point where we make some sort of arg like --allow-old-options or something

(Would prefer to have that discussion in Discord tho because I imagine this PR is gonna see a lot of activity already)

[Ziktofel]

SC2 already migrated with 0.4.5

[Jarno458]

Timespinner is worked on in #2485

[alwaysintreble]

From a code perspective there at least one block of code somewhere with a "todo: remove this when the old way is deprecated" which I don't see removed here.

The old way is not removed, just hard deprecated rather than soft deprecated. This means it won't work on source but will still function for apworlds used with the 0.4.7 (if this gets merged before then) release.

[GodlFire]

Shivers removal of last two instances of using old options API is fixed in this PR: #3287

[jtoyoda]

I will not be able to take a look at this and would recommend
A. Offering another developer to become the lead developer of FF1 as I have not been able to look at it
B. Deprecating FF1 (I am not sure how popular it is anyways)

Thanks for the continued improvements.

[JusticePS]

I should have time to get a PR put together for Adventure by sometime next weekend.

[FlySniper]

Wargroove has a PR for the new options system: #3306

[JusticePS]

Adventure PR #3326 to remove the deprecated options

[PoryGone]

#3357 Resolves SA2B. I'd forgotten that the Option Accessing was already handled with v2.3, and only migrating to the Dataclass was still required.

[LegendaryLinux]

#3357 is merged.

[ThePhar]

For Rogue Legacy: I believe I will wait for MultiClient.Net update to finalize and then do it in combination of that refactor to support #1933.

For Clique: I will update it this weekend.

[lordlou]

#3372 resolves SM and SMZ3.

[Seldom-SE]

#3414 resolves Terraria