Mega Man X3: Implement New Game #3844

TheLX5 · 2024-08-24T06:08:42Z

What is this fixing or adding?

Implements Mega Man X3 in Archipelago.

How was this tested?

Months of weekly sessions in private and public games

If this makes graphical changes, please attach screenshots.

…o mmx3

TheLX5 · 2024-08-24T06:11:42Z

Part of the client code requires #3093 to be properly tested. It can work without it though.

ScipioWright

Just a cursory look for now

ScipioWright · 2024-08-26T13:29:48Z

worlds/mmx3/Regions.py

+from worlds.AutoWorld import World
+
+
+def create_regions(multiworld: MultiWorld, player: int, world: World, active_locations):


Suggested change

from worlds.AutoWorld import World

def create_regions(multiworld: MultiWorld, player: int, world: World, active_locations):

if typing.TYPE_CHECKING:

from . import MMX3World

def create_regions(world: "MMX3World", active_locations):

multiworld = world.multiworld

player = world.player

If you do that weird type_checking thing, you can import your actual world class for your typing. It does need to be put in quotes when typing.
And then, you can get the multiworld and player directly from the world class.

ScipioWright · 2024-08-26T13:30:53Z

worlds/mmx3/Regions.py

+    add_event_to_region(multiworld, player, RegionName.dr_doppler_lab_2, EventName.dr_doppler_lab_2_clear)
+
+    # Dr. Doppler Lab 3
+    if world.options.doppler_lab_3_boss_rematch_count.value > 0:


Suggested change

if world.options.doppler_lab_3_boss_rematch_count.value > 0:

if world.options.doppler_lab_3_boss_rematch_count > 0:

No need for .value here -- it "knows" to compare to the int value like this.
You can also remove the > 0 if you want, but you may have it here to keep it clearer so it's up to you.

ScipioWright · 2024-08-26T13:31:27Z

worlds/mmx3/Regions.py

+    connect(world, RegionName.dr_doppler_lab_4, RegionName.dr_doppler_lab_4_boss)
+
+    # Connect checkpoints
+    if world.options.logic_helmet_checkpoints.value:


Suggested change

if world.options.logic_helmet_checkpoints.value:

if world.options.logic_helmet_checkpoints:

No need for .value here

ScipioWright · 2024-08-26T13:31:52Z

worlds/mmx3/Regions.py

+        connect(world, RegionName.dr_doppler_lab_3, RegionName.dr_doppler_lab_3_after_rematches)
+
+
+def create_region(multiworld: MultiWorld, player: int, active_locations, name: str, locations=None):


Suggested change

def create_region(multiworld: MultiWorld, player: int, active_locations, name: str, locations=None):

def create_region(multiworld: MultiWorld, player: int, active_locations, name: str, locations=None) -> Region:

Would recommend having the return type shown where feasible

Return types and typing stuff were something I added last minute before deciding to PR. Not too long ago I noticed that it's quite useful info to have.

ScipioWright · 2024-08-26T13:34:11Z

worlds/mmx3/Rules.py

+from worlds.generic.Rules import add_rule, set_rule
+from BaseClasses import CollectionState
+
+from . import MMX3World


I'm kind of surprised this isn't giving you a recursive import error

I'm surprised as well now that I look at it, I think this has been around for a while in the world.

Well, as long as it works I guess lol

ScipioWright · 2024-08-26T13:35:22Z

worlds/mmx3/Rules.py

+    set_rule(multiworld.get_entrance(f"{RegionName.intro_stage} -> {RegionName.blizzard_buffalo}", player),
+             lambda state: state.has(ItemName.stage_blizzard_buffalo, player))


Suggested change

set_rule(multiworld.get_entrance(f"{RegionName.intro_stage} -> {RegionName.blizzard_buffalo}", player),

lambda state: state.has(ItemName.stage_blizzard_buffalo, player))

set_rule(world.get_entrance(f"{RegionName.intro_stage} -> {RegionName.blizzard_buffalo}"),

lambda state: state.has(ItemName.stage_blizzard_buffalo, player))

There's a newer world.get_entrance which doesn't require the player number (since that's in the world already)

That's useful :o

ScipioWright · 2024-08-26T13:38:00Z

worlds/mmx3/Rules.py

+            add_rule(entrance_blizzard, lambda state: state.has_group("Weapons", player, world.options.vile_weapon_count.value))
+            add_rule(entrance_volt, lambda state: state.has_group("Weapons", player, world.options.vile_weapon_count.value))
+            add_rule(entrance_crush, lambda state: state.has_group("Weapons", player, world.options.vile_weapon_count.value))


Consider using has_group_unique for these, which is like has_group but it ignores duplicates.
I have a feeling these will erroneously succeed if someone start_inventory's something then receives a duplicate of it.

Ah, I didn't consider it. I just copied this from the Ride Armor logic and didn't think about it twice.

ScipioWright · 2024-08-26T13:50:55Z

worlds/mmx3/__init__.py

+        if hasattr(self.multiworld, "generation_is_fake"):
+            if hasattr(self.multiworld, "re_gen_passthrough"):
+                if "Mega Man X3" in self.multiworld.re_gen_passthrough:
+                    slot_data = self.multiworld.re_gen_passthrough["Mega Man X3"]
+                    self.boss_weaknesses = slot_data["weakness_rules"]


Suggested change

if hasattr(self.multiworld, "generation_is_fake"):

if hasattr(self.multiworld, "re_gen_passthrough"):

if "Mega Man X3" in self.multiworld.re_gen_passthrough:

slot_data = self.multiworld.re_gen_passthrough["Mega Man X3"]

self.boss_weaknesses = slot_data["weakness_rules"]

if hasattr(self.multiworld, "generation_is_fake"):

if hasattr(self.multiworld, "re_gen_passthrough"):

if "Mega Man X3" in self.multiworld.re_gen_passthrough:

self.boss_weaknesses = self.multiworld.re_gen_passthrough["Mega Man X3"]["weakness_rules"]

Since you're only returning the one thing, might as well one-line this

Will not apply this one as I noticed I need to pass a lot more info to UT than just weaknesses which is pretty much most of the data I'm saving in slot_data.

ScipioWright · 2024-08-26T13:51:58Z

worlds/mmx3/docs/en_Mega Man X3.md

+are randomized in the multiworld. The requirements for entering Dr. Doppler's Lab can be randomized to require different 
+amount of items (Medals from Mavericks, Weapon count, Upgrade count, Heart Tank and Sub Tank count).


Suggested change

are randomized in the multiworld. The requirements for entering Dr. Doppler's Lab can be randomized to require different

amount of items (Medals from Mavericks, Weapon count, Upgrade count, Heart Tank and Sub Tank count).

are randomized in the multiworld. The requirements for entering Dr. Doppler's Lab can be randomized to require different

amounts of items (Medals from Mavericks, Weapon count, Upgrade count, Heart Tank and Sub Tank count).

ScipioWright · 2024-08-26T13:53:06Z

worlds/mmx3/docs/en_Mega Man X3.md

+EnergyLink is an energy storage supported by certain games that is shared across all worlds in a multiworld. In Mega Man 
+ X3, when enabled, deposits a certain amount of Energy to the EnergyLink pool. Only a quarter of the collected Energy is 
+successfully sent to the EnergyLink pool.


Suggested change

EnergyLink is an energy storage supported by certain games that is shared across all worlds in a multiworld. In Mega Man

X3, when enabled, deposits a certain amount of Energy to the EnergyLink pool. Only a quarter of the collected Energy is

successfully sent to the EnergyLink pool.

EnergyLink is an energy storage supported by certain games that is shared across all worlds in a multiworld. Mega Man

X3, when enabled, deposits a certain amount of collected Energy to the EnergyLink pool. Only a quarter of the collected Energy is

successfully sent to the EnergyLink pool.

ScipioWright · 2024-09-19T20:15:34Z

worlds/mmx3/__init__.py

@@ -255,64 +255,126 @@ def set_rules(self):
                if "Mega Man X3" in self.multiworld.re_gen_passthrough:
                    slot_data = self.multiworld.re_gen_passthrough["Mega Man X3"]
                    self.boss_weaknesses = slot_data["weakness_rules"]
+                    print (self.boss_weaknesses)


Suggested change

print (self.boss_weaknesses)

Probably not intended?

ScipioWright · 2024-09-19T20:17:49Z

worlds/mmx3/__init__.py

+        # Parse logic-relevant settings and save them elsewhere (needed for UT support)
+        self.boss_weakness_strictness = self.options.boss_weakness_strictness.value
+        self.pickupsanity = self.options.pickupsanity.value
+        self.jammed_buster = self.options.jammed_buster.value
+        self.logic_boss_weakness = self.options.logic_boss_weakness.value


Pycharm is probably screaming about these. I'd really recommend against this pattern

Take a look at how TUNIC is doing it -- we're setting the option values directly based on what was in the slot_data

Oh, that looks much better. Assuming I'm looking at the correct thing

Yup! That's the right thing there. Some of the options get set a little differently -- you can just ignore those, they're because of ER stuff and how I'm handling it.

ScipioWright · 2024-09-19T20:18:54Z

worlds/mmx3/__init__.py

+    def interpret_slot_data(self, slot_data):
+        local_weaknesses = {boss: entries for boss, entries in slot_data["weakness_rules"].items()}
+
+        interpreted_slot_data = {


Has anything actually changed between slot_data and interpreted_slot_data? This looks like you are just returning the exact same thing you put in.

Can I just return the entire slot_data in that case? 🤔
Honestly I'm way too lost at UT stuff, I just find it handy to have, especially when testing logic.

Yup! You can just return that directly

@staticmethod def interpret_slot_data(slot_data: Dict[str, Any]) -> Dict[str, Any]: return slot_data

ScipioWright · 2024-09-19T20:19:56Z

worlds/mmx3/__init__.py

+                    self.boss_weakness_strictness = slot_data["boss_weakness_strictness"]
+                    self.pickupsanity = slot_data["pickupsanity"]
+                    self.jammed_buster = slot_data["jammed_buster"]
+                    self.logic_boss_weakness = slot_data["logic_boss_weakness"]


I'd recommend putting this stuff in generate_early instead -- that way everything after generate_early can catch the option changes

TheLX5 · 2024-09-20T06:48:47Z

The commits should address the previous concerns/suggested changes, I'll begin porting X1's suggestions here shortly ™️ .

TheLX5 added 30 commits March 3, 2024 23:08

Initial MMX3 commit

aed8a3d

Adds a bunch of features

7b270ab

v0.0.2 batch of changes

1d153df

Add white space to item group in Regions.py

859152a

Add a proper event to gravity beetle

9661585

Fix group name

d8b7400

Translate options to english

caac7a4

Add logic for Vile stage unlock

2aea325

Add Vile Stage item

cfa60e7

Remove unnecesary imports from the client

5048b61

Implement Vile options

701504f

Fix capsules giving out sub tank checks

3d09418

Fix Vile options

4f91521

Includes every ride armor into logic (@m.)

33c32a2

Added more descriptive location names (@m.)

e655bbb

Includes every ride armor into logic (M.)

6adef3f

Added more descriptive location names (M.)

0e69b01

Merge branch 'mmx3-main' of https://github.com/TheLX5/Archipelago int…

2a09a48

…o mmx3

Rework logic handling

bbba426

Avoid giving items if the player is going through a door

970e530

Rewrite region, location and rule handling

27e0acf

Mark items that aren't being used in logic as useful

bb1c929

Remove useless line

156aa51

Place one local stage on sphere 1

63ee50e

Remove mosquitus

5f50e21

Add even more options

ec80204

Adjust logic

100fd2f

Update mmx3_basepatch.bsdiff4

fc9f40d

Update client with a bunch of things

818ab41

Add (untested) support for the legacy collection ROM

5634e57

TheLX5 added 15 commits July 1, 2024 23:47

enable option groups

aebd438

modernize client

8c0deee

basepatch adjustments

a1b3407

Move rematches handling to the ROM

1d967be

Merge branch 'ArchipelagoMW:main' into mmx3-main

481055a

final 1.3.0 files

9dd3ee0

lower amount of progression items for doppler

068f1f7

make collect only write to RAM once per game_watcher run

09ffe32

fix dr doppler region connection

aa4de5b

logic stuff for 1.3.1

4e55510

v1.4.0

b26dda1

rewording

bfbe711

text

b878a3d

fixes in options

7de07f8

Merge branch 'ArchipelagoMW:main' into mmx3-main

5d66eaf

github-actions bot added the waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. label Aug 24, 2024

NewSoupVi added the is: new game Pull requests for implementing new games into Archipelago. label Aug 24, 2024

fix helmet teleport rules in toxic seahorse

3e88e97

ScipioWright reviewed Aug 26, 2024

View reviewed changes

TheLX5 mentioned this pull request Sep 7, 2024

Mega Man X: Implement New Game #3842

Draft

TheLX5 added 3 commits September 19, 2024 13:13

remove unusted things

bb09b2e

better UT support

8620978

update checkpoint tracking

1bf1a44

ScipioWright reviewed Sep 19, 2024

View reviewed changes

TheLX5 added 3 commits September 19, 2024 23:41

change UT code to maybe match TUNIC's implementation

66e2d5f

enforce helmet checkpoints to always be in logic

f4a8bcf

update init file

b985c38

TheLX5 marked this pull request as draft January 23, 2025 08:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mega Man X3: Implement New Game #3844

Mega Man X3: Implement New Game #3844

TheLX5 commented Aug 24, 2024

TheLX5 commented Aug 24, 2024

ScipioWright left a comment

ScipioWright Aug 26, 2024

ScipioWright Aug 26, 2024

ScipioWright Aug 26, 2024

ScipioWright Aug 26, 2024

TheLX5 Aug 26, 2024

ScipioWright Aug 26, 2024

TheLX5 Aug 26, 2024

ScipioWright Aug 26, 2024

ScipioWright Aug 26, 2024

TheLX5 Aug 26, 2024

ScipioWright Aug 26, 2024

TheLX5 Aug 26, 2024

ScipioWright Aug 26, 2024

TheLX5 Sep 17, 2024

ScipioWright Aug 26, 2024

ScipioWright Aug 26, 2024

ScipioWright Sep 19, 2024

TheLX5 Sep 19, 2024

ScipioWright Sep 19, 2024

ScipioWright Sep 19, 2024

TheLX5 Sep 19, 2024

ScipioWright Sep 19, 2024

ScipioWright Sep 19, 2024

TheLX5 Sep 19, 2024

ScipioWright Sep 19, 2024

ScipioWright Sep 19, 2024

TheLX5 commented Sep 20, 2024 •

edited

Loading

		from worlds.AutoWorld import World


		def create_regions(multiworld: MultiWorld, player: int, world: World, active_locations):

-from worlds.AutoWorld import World
-def create_regions(multiworld: MultiWorld, player: int, world: World, active_locations):
+if typing.TYPE_CHECKING:
+    from . import MMX3World
+def create_regions(world: "MMX3World", active_locations):
+    multiworld = world.multiworld
+    player = world.player

	if world.options.doppler_lab_3_boss_rematch_count.value > 0:
	if world.options.doppler_lab_3_boss_rematch_count > 0:

	if world.options.logic_helmet_checkpoints.value:
	if world.options.logic_helmet_checkpoints:

		connect(world, RegionName.dr_doppler_lab_3, RegionName.dr_doppler_lab_3_after_rematches)


		def create_region(multiworld: MultiWorld, player: int, active_locations, name: str, locations=None):

		set_rule(multiworld.get_entrance(f"{RegionName.intro_stage} -> {RegionName.blizzard_buffalo}", player),
		lambda state: state.has(ItemName.stage_blizzard_buffalo, player))

		are randomized in the multiworld. The requirements for entering Dr. Doppler's Lab can be randomized to require different
		amount of items (Medals from Mavericks, Weapon count, Upgrade count, Heart Tank and Sub Tank count).

Mega Man X3: Implement New Game #3844

Are you sure you want to change the base?

Mega Man X3: Implement New Game #3844

Conversation

TheLX5 commented Aug 24, 2024

What is this fixing or adding?

How was this tested?

If this makes graphical changes, please attach screenshots.

TheLX5 commented Aug 24, 2024

ScipioWright 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

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

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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheLX5 commented Sep 20, 2024 • edited Loading

TheLX5 commented Sep 20, 2024 •

edited

Loading