Potsanity 3.0 #2069

rrealmuto · 2023-08-12T03:37:22Z

This is still a WIP and needs more testing but wanted to put it on people's radar.

Stuff the player will notice:

Shuffle empty pots/crates and fairy pots
This PR adds previously unshuffled pots and crates to the location pool. These are pots that are either empty or contain a fairy. Empty pots/crates have a "Nothing" item shuffled into the item pool, which, as the name suggests, does literally nothing. Fairy pots introduce a "stray fairy" item to the pool, which gives a full heal when collected.

Enhanced pot major item effect
When collecting a shuffled major item from freestanding/pot/crate/etc. checks, it used to turn invisible upon collecting it. Now, the item will display above links head until the message box is closed.

THE.LEGEND.OF.ZELDA.-.Project64.3.0.1.5664-2df3434.2023-08-11.23-41-54.mp4

The under the hood stuff:
This PR completely reworks the custom actor flag system that was introduced with potsanity.

Flag storage within an actor/Extending Actor struct:
The old system worked by storing unique flags for each actor into sort-of unused home rotation variables within the actor instance. This new system adds a hack that effectively increases the base Actor structure in order to store this flag information. While only being used for a handful of actors currently, this hack in an enabler for pretty much any other shuffle setting imaginable.
Flag info
Flags were previously a unique 16 bit identifier which consisted of the scene setup, room, and actor index for each actor. This PR extends the flag to 32 bits in order to include the scene index, and more importantly a "sub-flag". This is used by certain actors which spawn multiple shuffled items (goron pot, rupee towers, etc.). Those items previously had to be handled as special cases within the patcher. Now they are treated the same as any other shuffled item utilizing the new flags.
Flag tables/SRAM storage
This PR also changes how these flags are stored in SRAM to be significantly more compact. Previously, a large amount of the SRAM used by these new flags were unused bits which represented actors within a room that weren't shuffled. This new system ensures that there are no wasted bits stored in SRAM (at the expense of storing some more data in tables within the code payload).

fenhl · 2023-08-12T03:44:53Z

The changes to override keys will require changes to the co-op context.

r0bd0g · 2023-08-12T03:57:06Z

Here's a funny logic thing I thought of just now that I should probably post in case I forget about it later.

I assume you have to collect the item in the pot before the fairy will spawn from it on the next load? This causes a problem with the logic of the fairy pot in the bk chest room of MQ Fire, which previously expected you could obtain the fairy without having physical access to the pot. So you'll actually have to check whether that pot is shuffled, and if so, hard require the hookshot to obtain the fairy. In addition to needing to check whether dungeon pots are shuffled, because of the way pots revert to vanilla behaviour when disabled, this means the logic will need to be able to check whether the shuffled pot location is disabled, which I'm not sure is currently possible. [I think the actual logic file fix is something like, "... and (hookshot or not dungeonpots or disabled)"]

TreZc0 · 2023-08-12T07:48:42Z

Reminder for maintainers to heavily test encryption with this once it has been merged 🙂

Great job!

rrealmuto · 2023-08-21T16:15:15Z

The changes to override keys will require changes to the co-op context.

So I'm assuming that on the game's side, all that needs to happen is incrementing the COOP_VERSION and increasing the size of OUTGOING_KEY?

Something will need to happen on the multiworld client side too, right?

fenhl · 2023-08-22T11:12:59Z

So I'm assuming that on the game's side, all that needs to happen is incrementing the COOP_VERSION and increasing the size of OUTGOING_KEY?

I would also recommend moving OUTGOING_KEY to 0x0C1C instead of shifting everything else. Whatever changes are made will also need to be documented at Notes/coop-ctx.md.

Something will need to happen on the multiworld client side too, right?

Yes, each individual multiworld client will have to add support for the new co-op context version. In the past, the maintainers have required sending a corresponding PR to bizhawk-co-op to add minimal support for the new co-op context version, not sure if that's still the case.

fenhl

The changes to the co-op context need to be documented in Notes/coop-ctx.md, and the changes to the save data in Notes/extra-save-data.md (might be a good opportunity to start documenting the contents of the extended save context).

fenhl · 2023-08-24T09:10:55Z

ASM/c/get_items.c

            break;
        }
-        if (z64_file.scene_flags[key_scene].unk_00_ == override.key.all) {
-            // Prevent duplicate entries
+        if (extended_savectx.incoming_queue[i].key.all == override.key.all) {


Keep the comment.

ASM/src/coop_state.asm

r0bd0g · 2023-11-02T13:37:40Z

I have some reservations about which crates are shuffled in which times of day. I think also some changes are probably needed regarding under what conditions the shield pot is shuffled, and what item it adds to the item pool. None of that really relates to the logic though. I have a couple of ideas for tricks but they're a bit weird b/c of how the drops tend move a bit randomly, so I'll just jot them down and maybe handle them another time.

Logic Review:

The crates at the top of vanilla Fire are behind a bombable wall, so explosives are also required. (In truth, the hammer alone can be used, but you have to reload the room after hammering the fake door, since the door and the bombable wall are tied to the same flag. But you can see with the logic for the hammer chest, that we have opted not to include that in logic, and even if we did, it would have to be a trick.)
The logic for fairy pot in the BK Chest Room of MQ Fire relies on destroying the pot from afar using a charged magic spin, and then waiting for the fairy to fly over to you (which it always does). If the pot is shuffled, you'll have to collect the drop first, which means the Hookshot will be required to get over there and pick it up. So the logic for the fairy drop needs to check that either the relevant settings for shuffling the fairy pot are not enabled, or that you have the Hookshot. The way that pots work when they are disabled is different from how other checks work -- they revert fully to vanilla behaviour, rather than having the check guaranteed to be a useless item. So you can additionally check for the shuffled fairy pot location being disabled as another alternative to Hookshot. We might not currently have a means of checking whether a location is disabled inside the logic files. It's kind of up to you whether you want to actually implement this, or maybe just leave a comment explaining the situation.
The pots near the boss room of vanilla Water shouldn't check for Longshot, as Longshot is not required if you were to enter the dungeon from the boss door. The checks are already in a region that checks for Longshot when coming into it from the rest of the dungeon.

ASM/c/item_table.c

fenhl · 2023-11-06T05:14:14Z

ASM/src/build.asm

@@ -142,6 +140,8 @@ TRIFORCE_ICON_TEXTURE:

 .align 0x10

+.skip 0x200 ; Temporary address bump to avoid audio issues


LocationList.py

SettingsList.py

fenhl · 2023-11-06T05:22:20Z

new scene flags.txt

This should go in the Notes directory.

data/World/Bottom of the Well MQ.json

fenhl · 2023-11-12T12:48:13Z

data/World/Overworld.json

+            "GF Crate 4": "can_break_crate",
+            "GF Crate 5": "can_break_crate",
+            "GF Crate 6": "can_break_crate",
+            "GF HBA Crate 1":  "((is_adult and Gerudo_Membership_Card) or is_child) and can_break_crate",


Maybe the archery range should be a separate region?

There are maybe a couple other cases along these lines but I figured, it wasn't broke. If these kinds of things are still there next time I go through it all, I'll clean up some things with extra regions at that time, whenever that happens to be.

rrealmuto · 2023-12-08T04:43:26Z

Now that wonderitems is merged I've rebased this and will start incorporating the changes identified here

Co-authored-by: Fenhl <fenhl@fenhl.net>

fenhl · 2024-03-28T17:34:14Z

The freeze does not occur on Dev-Rob.

rrealmuto · 2024-03-28T18:13:07Z

So the last commit here isn't up on my branch, and likely what caused the crash. I'll test tonight and depending on what's going on, might just revert that last commit.

fenhl · 2024-03-28T18:17:51Z

Can confirm the freeze does not happen on commit 17ae3a5.

fenhl · 2024-03-28T18:58:25Z

Another bug on commit 17ae3a5: A shuffled item in the pots in Dodongos Cavern Lower Lizalfos Pot 1 can't be picked up. Attempting to save the game after attempting to pick up the item breaks things to a point where soft/hard reset no longer work, and BizHawk crashes on core reboot. This bug also doesn't occur on Dev-Rob.

rrealmuto · 2024-03-28T19:30:40Z

Next thing you know you'll pick up the item from the pot and get teleported to ganon 🤔

rrealmuto · 2024-03-28T23:05:43Z

That should hopefully fix it

fenhl · 2024-03-28T23:26:34Z

Looks good! Maybe we could add a CI check to make sure this array is large enough?

rrealmuto · 2024-03-28T23:30:04Z

Haha I have a check in the patcher, but it was checking the wrong size (which is currently hard-coded into patches.py, and I probably copied that block over from my branch). Perhaps that could be made to dynamically determine the size of the array from get_items.c or from asm_symbols.txt and included in CI

rrealmuto · 2024-03-29T14:25:29Z

Doing some more testing and found that the alt overrides are still a bit broken. The table itself is fine but some scenes aren't using it correctly. Looking into a fix.

Example. The child kak crates will drop their item at night but not during the day.

This should be fixed now.

…checks to use the symbol lengths

rrealmuto · 2024-03-31T01:36:42Z

Looks good! Maybe we could add a CI check to make sure this array is large enough?

Done. I updated the format of data/generated/symbols.json to include the size of data symbols which seems to work well. I updated the runtime tests to compare against these sizes, and added a check in CI.py as well.

fenhl · 2024-03-31T16:27:41Z

Another bug report: If crate shuffle is disabled, all crates drop green rupees. Tested in the Kakariko backyard where 3 of the crates are supposed to drop nothing and the 4th is supposed to drop a red rupee:

{
    "settings": {
        "logic_rules": "none",
        "starting_age": "adult",
        "spawn_positions": ["adult"]
    },
    "entrances": {
        "Adult Spawn -> Temple of Time": "Kak Backyard"
    }
}

This bug also doesn't occur on Dev-Rob.

rrealmuto · 2024-03-31T18:32:00Z

Another bug report: If crate shuffle is disabled, all crates drop green rupees. Tested in the Kakariko backyard where 3 of the crates are supposed to drop nothing and the 4th is supposed to drop a red rupee:
{
    "settings": {
        "logic_rules": "none",
        "starting_age": "adult",
        "spawn_positions": ["adult"]
    },
    "entrances": {
        "Adult Spawn -> Temple of Time": "Kak Backyard"
    }
}
This bug also doesn't occur on Dev-Rob.

Should be fixed now.

fenhl · 2024-04-01T05:18:49Z

SettingsList.py

+        default        = False,
+        gui_tooltip    = '''\
+            Enabling this will include empty crates into the location
+            pool based on the Shuffle Pots setting chosen.


Suggested change

pool based on the Shuffle Pots setting chosen.

pool based on the Shuffle Crates setting chosen.

r0bd0g · 2024-04-28T12:16:42Z

I didn't realize the shuffle empty pots setting would put the items into the dmc pots as child...
Are the day crates in market still separate checks from the night crates?

rrealmuto · 2024-04-28T12:57:49Z

Yes

fenhl · 2024-05-01T20:16:49Z

HintList.py

@@ -524,6 +524,8 @@ def tokens_required_by_settings(world: World) -> int:
    'Ocarina C down Button':                                    (["a low note"], "the Ocarina C down Button", 'item'),
    'Ocarina C left Button':                                    (["a somewhat high note"], "the Ocarina C left Button", 'item'),
    'Ocarina C right Button':                                   (["a middle note"], "the Ocarina C right Button", 'item'),
+    'Fairy Drop':                                               (["an annoying companion"], "a Stray Fairy", 'item'),


We should make sure the cryptic hints make sense between bottled and stray fairies. I think “Navi's cousin” sounds more like a stray fairy than a bottled one, so I suggest adding it here and removing it from the Bottle with Fairy hints.

Suggested change

'Fairy Drop': (["an annoying companion"], "a Stray Fairy", 'item'),

'Fairy Drop': (["an annoying companion", "Navi's cousin"], "a Stray Fairy", 'item'),

Remember to also remove this hint from the bottled fairy item.

Co-authored-by: Fenhl <fenhl@fenhl.net>

rrealmuto · 2024-06-07T18:02:53Z

I just merged with the (almost) latest main Dev. Probably just needs a bit of testing to make sure I didn't overlook anything during the merge. Main conflicts were just gi_draw IDs

fenhl added Type: Enhancement New feature or request Component: Logic Non-trivial changes to the JSON logic files Component: ASM/C Changes some internals of the ASM/C libraries labels Aug 12, 2023

fenhl reviewed Aug 24, 2023

View reviewed changes

This was referenced Aug 26, 2023

Don't interrupt players receiving junk from the network #1767

Open

Add chu bag flag to multiworld progressive items state #2079

Merged

rrealmuto mentioned this pull request Sep 28, 2023

Water Temple MQ wonderitems logic incorrect rrealmuto/OoT-Randomizer#84

Closed

rrealmuto force-pushed the new_flags branch from 315a9f1 to 78c6df2 Compare September 29, 2023 18:54

fenhl mentioned this pull request Oct 10, 2023

Support co-op context changes on Dev-Rob midoshouse/ootr-multiworld#34

Closed

rrealmuto force-pushed the new_flags branch from b7342d2 to 78c6df2 Compare October 14, 2023 14:07

fenhl mentioned this pull request Oct 21, 2023

Bump co-op context version and document the change rrealmuto/OoT-Randomizer#85

Merged

fenhl reviewed Nov 6, 2023

View reviewed changes

rrealmuto mentioned this pull request Nov 6, 2023

Add support for Ocarina of Time coop version 7. TestRunnerSRL/bizhawk-co-op#71

Draft

fenhl reviewed Nov 12, 2023

View reviewed changes

rrealmuto added 2 commits November 30, 2023 20:01

New flag system

6e1f629

Add hack to set flags/chest types when spawning any actor

b216ff6

fenhl added the Changes Item Table Adds/removes items from the item table. Allows coordination of multiple PRs which add to the table. label Dec 5, 2023

rrealmuto force-pushed the new_flags branch from 0b1f71c to b216ff6 Compare December 8, 2023 04:42

rrealmuto and others added 3 commits December 7, 2023 23:50

Fix BOTW MQ Pot Typo

3de3817

Co-authored-by: Fenhl <fenhl@fenhl.net>

Empty Pots/Crates GUI format

092d614

Co-authored-by: Fenhl <fenhl@fenhl.net>

Pass CI checks

26da0b3

This was referenced Jan 19, 2024

Option to allow progressive items to give all the upgrades at once #2108

Open

Error generating Nothing item in shop fenhl/OoT-Randomizer#20

Closed

fenhl mentioned this pull request Mar 28, 2024

Can't pick up shuffled pot drops fenhl/OoT-Randomizer#25

Closed

Fix alt_override_table size

b0d38f7

rrealmuto added 5 commits March 29, 2024 14:20

Fix alt flag calculation

eb416c3

Reorder alt flags for child kak

8c92cda

Update build tools to capture symbol lengths. Rework run time length …

9dc4b79

…checks to use the symbol lengths

Add CI check for xflag/alt override tables

95fe87c

Add override table to CI check. Clean up plando

bb74d6f

Add table check for EXTENDED_OBJECT_TABLE

cb4de7f

Subflag fixes

7ad4bf3

fenhl reviewed Apr 1, 2024

View reviewed changes

Improve logic for DMC Pots with empty pots shuffled

b4f5e7a

fenhl reviewed May 1, 2024

View reviewed changes

Update HintList.py

bc46a82

Co-authored-by: Fenhl <fenhl@fenhl.net>

fenhl removed the Status: Needs Testing Probably should be tested label May 17, 2024

Merge branch 'upstream' into new_flags

a3ddded

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Potsanity 3.0 #2069

Potsanity 3.0 #2069

rrealmuto commented Aug 12, 2023 •

edited

fenhl commented Aug 12, 2023

r0bd0g commented Aug 12, 2023 •

edited

TreZc0 commented Aug 12, 2023

rrealmuto commented Aug 21, 2023

fenhl commented Aug 22, 2023

fenhl left a comment

fenhl Aug 24, 2023

r0bd0g commented Nov 2, 2023

fenhl Nov 6, 2023

fenhl Nov 6, 2023

fenhl Nov 12, 2023

r0bd0g Nov 12, 2023

rrealmuto commented Dec 8, 2023

fenhl commented Mar 28, 2024

rrealmuto commented Mar 28, 2024

fenhl commented Mar 28, 2024

fenhl commented Mar 28, 2024

rrealmuto commented Mar 28, 2024

rrealmuto commented Mar 28, 2024

fenhl commented Mar 28, 2024

rrealmuto commented Mar 28, 2024

rrealmuto commented Mar 29, 2024 •

edited

rrealmuto commented Mar 31, 2024 •

edited

fenhl commented Mar 31, 2024

rrealmuto commented Mar 31, 2024

fenhl Apr 1, 2024

r0bd0g commented Apr 28, 2024

rrealmuto commented Apr 28, 2024

fenhl May 1, 2024

fenhl May 11, 2024

rrealmuto commented Jun 7, 2024

		@@ -142,6 +140,8 @@ TRIFORCE_ICON_TEXTURE:

		.align 0x10

		.skip 0x200 ; Temporary address bump to avoid audio issues

	pool based on the Shuffle Pots setting chosen.
	pool based on the Shuffle Crates setting chosen.

	'Fairy Drop': (["an annoying companion"], "a Stray Fairy", 'item'),
	'Fairy Drop': (["an annoying companion", "Navi's cousin"], "a Stray Fairy", 'item'),

Potsanity 3.0 #2069

Are you sure you want to change the base?

Potsanity 3.0 #2069

Conversation

rrealmuto commented Aug 12, 2023 • edited

fenhl commented Aug 12, 2023

r0bd0g commented Aug 12, 2023 • edited

TreZc0 commented Aug 12, 2023

rrealmuto commented Aug 21, 2023

fenhl commented Aug 22, 2023

fenhl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

r0bd0g commented Nov 2, 2023

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

rrealmuto commented Dec 8, 2023

fenhl commented Mar 28, 2024

rrealmuto commented Mar 28, 2024

fenhl commented Mar 28, 2024

fenhl commented Mar 28, 2024

rrealmuto commented Mar 28, 2024

rrealmuto commented Mar 28, 2024

fenhl commented Mar 28, 2024

rrealmuto commented Mar 28, 2024

rrealmuto commented Mar 29, 2024 • edited

rrealmuto commented Mar 31, 2024 • edited

fenhl commented Mar 31, 2024

rrealmuto commented Mar 31, 2024

Choose a reason for hiding this comment

r0bd0g commented Apr 28, 2024

rrealmuto commented Apr 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rrealmuto commented Jun 7, 2024

rrealmuto commented Aug 12, 2023 •

edited

r0bd0g commented Aug 12, 2023 •

edited

rrealmuto commented Mar 29, 2024 •

edited

rrealmuto commented Mar 31, 2024 •

edited