Wario Land 4: Implement new game #3266

lilDavid · 2024-05-04T18:01:13Z

What is this fixing or adding?

Adds Wario Land 4 as an available game for AP.

How was this tested?

Many playtests and unsupported games over several APworld releases.

If this makes graphical changes, please attach screenshots.

Update setup_en.md

Fix winning golden treasure hunt early

git-subtree-dir: worlds/wl4 git-subtree-mainline: b6925c5 git-subtree-split: a7c7375

…nd_4

Exempt-Medic

Some comments and things I noticed briefly. I did not look at the client or rom or any of the tests. Some things in setup_locations I haven't quite figured out yet and I will later go back through Rules.py again since it's doing some pretty strange things I need to wrap my head around.

Exempt-Medic · 2024-08-20T17:08:47Z

worlds/wl4/docs/en_Wario Land 4.md

+
+## Where is the settings page?
+
+The [player settings page for this game](../player-settings) contains all the


These are options now (same change should be applied elsewhere in this file)

Suggested change

The [player settings page for this game](../player-settings) contains all the

The [player options page for this game](../player-options) contains all the

Exempt-Medic · 2024-08-20T17:11:37Z

worlds/wl4/docs/en_Wario Land 4.md

+## What does another world's item look like in Wario Land 4?
+
+Other games' items will look like Archipelago logos. When collected from a box, the item's name will
+be displayed at the bottom left corner of the screen. By default, you will have to carry the item to


Usually "in" is used here

Suggested change

be displayed at the bottom left corner of the screen. By default, you will have to carry the item to

be displayed in the bottom left corner of the screen. By default, you will have to carry the item to

Exempt-Medic · 2024-08-20T17:12:21Z

worlds/wl4/docs/en_Wario Land 4.md

+
+Other games' items will look like Archipelago logos. When collected from a box, the item's name will
+be displayed at the bottom left corner of the screen. By default, you will have to carry the item to
+the end of the level before the other player will receive it, at which point you will be told who


I think this reads a bit better:

Suggested change

the end of the level before the other player will receive it, at which point you will be told who

the end of the level for the other player to receive it, at which point you will be told who

Exempt-Medic · 2024-08-20T17:14:16Z

worlds/wl4/docs/setup_en.md

+  - Detailed installation instructions for Bizhawk can be found at the above link.
+  - Windows users must run the prereq installer first, which can also be found at the above link.
+- The built-in Archipelago client, which can be installed [here](https://github.com/ArchipelagoMW/Archipelago/releases)
+  (select `Wario Land 4 Client` during installation).


This isn't a thing anymore

Suggested change

(select `Wario Land 4 Client` during installation).

Exempt-Medic · 2024-08-20T17:16:42Z

worlds/wl4/docs/setup_en.md

+
+### Where do I get a config file?
+
+The Player Settings page on the website allows you to configure your personal


Settings -> Options

Exempt-Medic · 2024-08-20T19:20:25Z

worlds/wl4/__init__.py

+        for _ in range(full_health_items):
+            itempool.append(self.create_item('Full Health Item'))
+
+        if (treasure_hunt):


These are few places with redundant parens, but this one struck me as especially unneeded

Suggested change

if (treasure_hunt):

if treasure_hunt:

Exempt-Medic · 2024-08-20T19:20:56Z

worlds/wl4/__init__.py

+        junk_count = total_required_locations - len(itempool)
+        junk_item_pool = tuple(filter_item_names(type=ItemType.ITEM))
+        for _ in range(junk_count):
+            item_name = self.multiworld.random.choice(junk_item_pool)


Multiworld.random should be avoided

Suggested change

item_name = self.multiworld.random.choice(junk_item_pool)

item_name = self.random.choice(junk_item_pool)

Exempt-Medic · 2024-08-20T19:22:56Z

worlds/wl4/__init__.py

+        if self.options.goal in (Goal.option_local_golden_treasure_hunt, Goal.option_local_golden_diva_treasure_hunt):
+            self.options.local_items.value.update(self.item_name_groups['Golden Treasure'])
+        if self.options.required_jewels > self.options.pool_jewels:
+            self.options.pool_jewels = PoolJewels(self.options.required_jewels)


I guess this was working, but it seems like .value makes more sense

Suggested change

self.options.pool_jewels = PoolJewels(self.options.required_jewels)

self.options.pool_jewels = PoolJewels(self.options.required_jewels.value)

Exempt-Medic · 2024-08-20T19:25:19Z

worlds/wl4/__init__.py

+            if difficulty == 0:
+                full_health_items -= 8
+            else:
+                raise ValueError('Not enough locations to place abilities for '


It looks like this error is entirely from user options, so two things.

This could be changed to an OptionError

This could be done much earlier, like in generate_early so that generation doesn't halt as late as create_items over this

Exempt-Medic · 2024-08-20T19:28:27Z

worlds/wl4/__init__.py

+        goal = self.multiworld.get_location(goal, self.player)
+        goal.place_locked_item(self.create_item('Escape the Pyramid'))
+        goal.show_in_spoiler = False


goal changes types here, so using a new variable is best

Suggested change

goal = self.multiworld.get_location(goal, self.player)

goal.place_locked_item(self.create_item('Escape the Pyramid'))

goal.show_in_spoiler = False

goal_loc = self.multiworld.get_location(goal, self.player)

goal_loc.place_locked_item(self.create_item('Escape the Pyramid'))

goal_loc.show_in_spoiler = False

Exempt-Medic · 2024-08-20T20:33:06Z

worlds/wl4/test/test_helpers.py

+        with self.subTest('Jewel Pieces'):
+            pieces = items.filter_items(type=ItemType.JEWEL)
+            assert all(map(lambda p: p[0].endswith('Piece'), pieces))
+            assert all(map(lambda p: p[1].type, pieces))


This test fails for me. This passes though:

Suggested change

assert all(map(lambda p: p[1].type, pieces))

assert all(map(lambda p: p[1].type == ItemType.JEWEL, pieces))

Exempt-Medic

Some more comments. One general question I have is why this code is using Sequence and Mapping so much instead of List and Dict?

Exempt-Medic · 2024-08-21T12:41:20Z

worlds/wl4/__init__.py

+        'CDs': set(filter_item_names(type=ItemType.CD)),
+        'Abilities': set(filter_item_names(type=ItemType.ABILITY)),
+        'Golden Treasure': set(filter_item_names(type=ItemType.TREASURE)),
+        'Traps': { 'Wario Form Trap', 'Lightning Trap'},


An extra space

Suggested change

'Traps': { 'Wario Form Trap', 'Lightning Trap'},

'Traps': {'Wario Form Trap', 'Lightning Trap'},

Exempt-Medic · 2024-08-21T12:48:43Z

worlds/wl4/__init__.py

+        checks = filter(lambda p: self.options.difficulty in p[1].difficulties, location_table.items())
+        if not self.options.goal.needs_treasure_hunt():
+            checks = filter(lambda p: p[1].source != LocationType.CHEST, checks)
+        checks = {name for name, _ in checks}
+
+        if self.options.goal.needs_diva():
+            checks.remove('Sound Room - Emergency Exit')
+        else:
+            checks.remove('Golden Diva')
+        return checks


So here checks changes from a filter with tuples to a set of strings. Could do this instead:

Suggested change

checks = filter(lambda p: self.options.difficulty in p[1].difficulties, location_table.items())

if not self.options.goal.needs_treasure_hunt():

checks = filter(lambda p: p[1].source != LocationType.CHEST, checks)

checks = {name for name, _ in checks}

if self.options.goal.needs_diva():

checks.remove('Sound Room - Emergency Exit')

else:

checks.remove('Golden Diva')

return checks

checks = filter(lambda p: self.options.difficulty in p[1].difficulties, location_table.items())

if not self.options.goal.needs_treasure_hunt():

checks = filter(lambda p: p[1].source != LocationType.CHEST, checks)

check_names = {name for name, _ in checks}

if self.options.goal.needs_diva():

check_names.remove('Sound Room - Emergency Exit')

else:

check_names.remove('Golden Diva')

return check_names

Exempt-Medic · 2024-08-21T13:12:58Z

worlds/wl4/__init__.py

+        for _ in range(junk_count):
+            item_name = self.multiworld.random.choice(junk_item_pool)
+            itempool.append(self.create_item(item_name))


You could use a comprehension instead:

Suggested change

for _ in range(junk_count):

item_name = self.multiworld.random.choice(junk_item_pool)

itempool.append(self.create_item(item_name))

itempool.extend([self.create_item(self.random.choice(junk_item_pool)) for _ in range(junk_count)])

Exempt-Medic · 2024-08-21T13:21:51Z

worlds/wl4/__init__.py

+            for _ in range(copies):
+                itempool.append(self.create_item(name, force_non_progression))
+
+        for name in filter_item_names(type=ItemType.CD):


It seems a little odd to me that you're filtering these for each world instead of creating some lists once on the class that they can all share and only have to be created once.

Exempt-Medic · 2024-08-21T14:01:35Z

worlds/wl4/rules.py

+def set_access_rules(world: WL4World):
+    for name, rule in location_rules.items():
+        try:
+            location = world.multiworld.get_location(name, world.player)


Can use the helper function

Suggested change

location = world.multiworld.get_location(name, world.player)

location = world.get_location(name)

Exempt-Medic · 2024-08-21T14:21:09Z

worlds/wl4/rules.py

+        except KeyError as k:
+            # Raise for invalid location names, not ones that aren't in this player's world
+            if name not in locations.location_table:
+                raise ValueError(f'Location {name} does not exist') from k


Is there a way for this error to be hit? Seems more debug-y to me, so you could use an assert instead

Suggested change

except KeyError as k:

# Raise for invalid location names, not ones that aren't in this player's world

if name not in locations.location_table:

raise ValueError(f'Location {name} does not exist') from k

except KeyError:

# Raise for invalid location names, not ones that aren't in this player's world

assert name in locations.location_table, f"Location {name} does not exist"

Exempt-Medic · 2024-08-21T14:30:15Z

worlds/wl4/rules.py

+def option(option_name: str, choice: Option):
+    return Requirement(lambda w, _: getattr(w.options, option_name) == choice)
+
+def difficulty(difficulty: options.Difficulty):
+    return option('difficulty', difficulty)
+
+def not_difficulty(_difficulty: options.Difficulty):
+    return Requirement(lambda w, s: not difficulty(_difficulty).inner(w, s))
+
+def logic(logic: options.Logic):
+    return option('logic', logic)


The way you're doing this, these are all ints
You can also remove the Options import with this change

Suggested change

def option(option_name: str, choice: Option):

return Requirement(lambda w, _: getattr(w.options, option_name) == choice)

def difficulty(difficulty: options.Difficulty):

return option('difficulty', difficulty)

def not_difficulty(_difficulty: options.Difficulty):

return Requirement(lambda w, s: not difficulty(_difficulty).inner(w, s))

def logic(logic: options.Logic):

return option('logic', logic)

def option(option_name: str, choice: int):

return Requirement(lambda w, _: getattr(w.options, option_name) == choice)

def difficulty(difficulty: int):

return option('difficulty', difficulty)

def not_difficulty(_difficulty: int):

return Requirement(lambda w, s: not difficulty(_difficulty).inner(w, s))

def logic(logic: int):

return option('logic', logic)

Exempt-Medic · 2024-08-21T14:44:01Z

worlds/wl4/rules.py

+    item, count = resolve_helper(item_name)
+    return Requirement(lambda w, s: s.has(item, w.player, count))
+
+def has_all(items: Sequence[str]) -> Requirement:


make_boss_access_rule passes in a tuple of strings and ints so this function is used with both types of RequiredItem

Suggested change

def has_all(items: Sequence[str]) -> Requirement:

def has_all(items: Sequence[RequiredItem]) -> Requirement:

Exempt-Medic · 2024-08-21T14:45:19Z

worlds/wl4/rules.py

+        return functools.partial(self.inner, world)
+
+
+def has(item_name: str) -> Requirement:


Because has_all can thus call this with a tuple of strings and ints, this also handles all RequiredItem types

Suggested change

def has(item_name: str) -> Requirement:

def has(item_name: RequiredItem) -> Requirement:

Exempt-Medic · 2024-08-21T15:09:26Z

worlds/wl4/rules.py

+def resolve_helper(item_name: RequiredItem):
+    requirement = helpers.get(item_name, item_name)
+    if isinstance(requirement, str):
+        return (requirement, 1)
+    else:
+        return requirement


So because this accepts tuples of ints, you're calling helpers.get with a tuple of ints which isn't exactly supported here (it works, but it's kind of taking advantage of this not causing an error). You could do this instead:

def resolve_helper(item_name: RequiredItem): if not isinstance(item_name, str): return item_name item_name = helpers.get(item_name, item_name) if not isinstance(item_name, str): return item_name return item_name, 1

Another option that I think is quite a bit cleaner is changing helpers to a Mapping[str, Tuple[str, int]] so you'd change 'Progressive Ground Pound' to ('Progressive Ground Pound', 1) and then just having this instead:

def resolve_helper(item_name: RequiredItem): if not isinstance(item_name, str): return item_name return helpers.get(item_name, (item_name, 1))

Exempt-Medic · 2024-08-21T17:31:54Z

Something else I forgot to mention, you may want to implement a get_filler_item_name function, so that when the multiworld has to ask for items from your world (like with plando or itemlinks) it will only pull from filler items you define instead of all items, including progression ones. Another thing you could consider is adding start_inventory_from_pool support, it's a pretty simple options change and you wouldn't have to rearrange anything to support it (it would also benefit from get_filler_item_name).

lilDavid · 2024-08-22T15:36:35Z

Some more comments. One general question I have is why this code is using Sequence and Mapping so much instead of List and Dict?

I like to use Sequence and Mapping because they give more of a hint that the value won't be modified. I use tuples as immutable sequences a lot, and Sequence covers both tuples and lists.

lilDavid added 30 commits April 12, 2023 07:32

Adjust item sending mechanics

4a16c5c

Add documentation

e1fbd5a

Build basepatch with shell script

363b8b1

Track sent items' owners

f35f04c

Overhaul item receiving (it actually works again)

c4ae874

Make some noise when receiving an item

5ea3736

Sort assembly files

497bb08

Move most patches to basepatch

2071a7e

Icons for received items

03747e2

Fix full health item bugs

4c3993b

Add AP logo sprite

2e4666c

Fix a bug in the box contents loading

84175bd

Keep up with changes on main

53c2846

Fix jewel display not existing

1655437

Clean up symbol table

c0d8062

Enforce alignment for more code

36f7820

Add info formerly in host.yaml

073e7b4

Identify multiworld items with player names

09d7c03

Create text sprite tiles

540e800

More text graphics

7cf30ee

Load player and item names into VRAM

f512718

Display text on screen

3a3d95f

Fix item collection being completely broken

5fc23a6

Readable bit fields

436b7ab

Use WL4's font for item messages

3c3f1d8

Properly subscript typing.Type

afb7fc7

Results screen: Multiworld item pickup messages

eaf5f01

Fix small text apostrophes/hyphens/commas

62934f4

Items received on pyramid screen

e019b68

Adjust message times

b3d86af

lilDavid added 23 commits May 10, 2024 07:07

WL4: Fix bad header checksum

16a2eaa

WL4: Clean up inconsistent quotes

8290e07

Merge pull request #2 from Fairweather-Furry/wario_land_4

d930648

Update setup_en.md

WL4: Option to limit queued traps

900ed61

WL4: Current room info for tracker

6ede12a

WL4: Convert to procedure patch

fa97118

WL4: Move death link setting to client

b88b601

Fix reversed 40 Below Fridge snowman puzzle boxes

7d3652d

WL4: Fix generation fail when starting with treasures

9fe9143

Fix winning golden treasure hunt early

WL4: Specify a WL4 ROM is not needed to generate

b54c3c8

Add .gitignore, LICENSE, and README

1b5430c

Fix generation failure with door set to open

791bbea

Properly add Trap Behavior option

92a9aae

Fix shuffled music and Wario voices bleeding across players

e939895

Add option groups

a7c7375

Add 'worlds/wl4/' from commit 'a7c73754a9f174dc2d1c288138065758b1463c25'

81353cd

git-subtree-dir: worlds/wl4 git-subtree-mainline: b6925c5 git-subtree-split: a7c7375

WL4: AP main file updates

561d445

Fully add location and item name groups

4bc5b05

Fix boss treasure popups appearing in Golden Diva goal

74d9bb3

Fix Doodle Woods CD Box on Normal with advanced logic

41cfaf4

Update logic option to link to resources

65735eb

Merge commit '65735ebe7e92f484318cf9c7a29f3d81ae23e115' into wario_la…

626b583

…nd_4

Merge branch 'main' into wario_land_4

08a6c77

lilDavid force-pushed the wario_land_4 branch from 602f5ba to 08a6c77 Compare July 28, 2024 17:48

Exempt-Medic suggested changes Aug 20, 2024

View reviewed changes

Exempt-Medic reviewed Aug 20, 2024

View reviewed changes

Exempt-Medic suggested changes Aug 21, 2024

View reviewed changes

Exempt-Medic added the waiting-on: author Issue/PR is waiting for feedback or changes from its author. label Aug 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wario Land 4: Implement new game #3266

Wario Land 4: Implement new game #3266

lilDavid commented May 4, 2024

Exempt-Medic left a comment

Exempt-Medic Aug 20, 2024

Exempt-Medic Aug 20, 2024

Exempt-Medic Aug 20, 2024

Exempt-Medic Aug 20, 2024

Exempt-Medic Aug 20, 2024

Exempt-Medic Aug 20, 2024

Exempt-Medic Aug 20, 2024

Exempt-Medic Aug 20, 2024

Exempt-Medic Aug 20, 2024

Exempt-Medic Aug 20, 2024

Exempt-Medic Aug 20, 2024

Exempt-Medic left a comment

Exempt-Medic Aug 21, 2024

Exempt-Medic Aug 21, 2024

Exempt-Medic Aug 21, 2024 •

edited

Loading

Exempt-Medic Aug 21, 2024

Exempt-Medic Aug 21, 2024

Exempt-Medic Aug 21, 2024

Exempt-Medic Aug 21, 2024

Exempt-Medic Aug 21, 2024

Exempt-Medic Aug 21, 2024

Exempt-Medic Aug 21, 2024 •

edited

Loading

Exempt-Medic commented Aug 21, 2024

lilDavid commented Aug 22, 2024


		## Where is the settings page?

		The [player settings page for this game](../player-settings) contains all the

	The [player settings page for this game](../player-settings) contains all the
	The [player options page for this game](../player-options) contains all the

	be displayed at the bottom left corner of the screen. By default, you will have to carry the item to
	be displayed in the bottom left corner of the screen. By default, you will have to carry the item to

	the end of the level before the other player will receive it, at which point you will be told who
	the end of the level for the other player to receive it, at which point you will be told who


		### Where do I get a config file?

		The Player Settings page on the website allows you to configure your personal

	item_name = self.multiworld.random.choice(junk_item_pool)
	item_name = self.random.choice(junk_item_pool)

	self.options.pool_jewels = PoolJewels(self.options.required_jewels)
	self.options.pool_jewels = PoolJewels(self.options.required_jewels.value)

	assert all(map(lambda p: p[1].type, pieces))
	assert all(map(lambda p: p[1].type == ItemType.JEWEL, pieces))

	'Traps': { 'Wario Form Trap', 'Lightning Trap'},
	'Traps': {'Wario Form Trap', 'Lightning Trap'},

	location = world.multiworld.get_location(name, world.player)
	location = world.get_location(name)

	def has_all(items: Sequence[str]) -> Requirement:
	def has_all(items: Sequence[RequiredItem]) -> Requirement:

		return functools.partial(self.inner, world)


		def has(item_name: str) -> Requirement:

	def has(item_name: str) -> Requirement:
	def has(item_name: RequiredItem) -> Requirement:

Wario Land 4: Implement new game #3266

Are you sure you want to change the base?

Wario Land 4: Implement new game #3266

Conversation

lilDavid commented May 4, 2024

What is this fixing or adding?

How was this tested?

If this makes graphical changes, please attach screenshots.

Exempt-Medic 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

Exempt-Medic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Exempt-Medic Aug 21, 2024 • edited Loading

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

Exempt-Medic Aug 21, 2024 • edited Loading

Choose a reason for hiding this comment

Exempt-Medic commented Aug 21, 2024

lilDavid commented Aug 22, 2024

Exempt-Medic Aug 21, 2024 •

edited

Loading

Exempt-Medic Aug 21, 2024 •

edited

Loading