Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move cutscenes skips out of Patches.py, improve documentation, add a new one and improve on two existing ones #2219

Merged
merged 1 commit into from
May 20, 2024

Conversation

GSKirox
Copy link

@GSKirox GSKirox commented May 13, 2024

An attempt to start on #2213

This PR moves all cutscenes skips done in Patches.py to a new file Cutscenes.py, and tries to document them by interfacing some of the hacks done with clearer functions, or by adding comments on their purpose. Most of them have been cleaned of unnecessary byte changes, which are a ton easier to detect nowadays with decomp.
The hacks have been sorted by "Vanilla walkthrough" order.

There's also a couple of additions :

New cutscene shortened :

  • Master Sword cutscene in Temple of Time has been shortened to 20 frames from 230 and 210 respectively for child => adult and adult => child.

Already existing cutscenes skips shortened further

  • Lake Hylia water restored after killing Morpha, shortened to 2 frames from 199.
  • Bottom of the Well draining after playing Song of Storms in the windmill, shortened to 3 frames from 180.

These two cutscenes waited for their respective flags to be set before being cut. With the new functions we can easily set the flag on the first frame and then immediately stop.

Aside from that, the behaviour to all cutscenes should be strictly identical to before and if not then i made a mistake somewhere !
They were all left untouched because the purpose of this change was not so much to improve on existing skips rather than making them easier to either improve or toggling them off in future devs.

@fenhl fenhl added Type: Enhancement New feature or request Status: Needs Review Someone should be looking at it Status: Needs Testing Probably should be tested Status: Under Consideration Developers are considering whether to accept or decline the feature described Component: Patching Affects the patching of the ROM Type: Maintenance Code style, infrastructure, updating dependencies labels May 13, 2024
@fenhl fenhl removed the Status: Needs Review Someone should be looking at it label May 13, 2024
@fenhl fenhl removed the Status: Needs Testing Probably should be tested label May 17, 2024
@fenhl fenhl linked an issue May 17, 2024 that may be closed by this pull request
@fenhl fenhl removed the Status: Under Consideration Developers are considering whether to accept or decline the feature described label May 20, 2024
@fenhl fenhl added this to the next milestone May 20, 2024
@fenhl fenhl merged commit f23114d into OoTRandomizer:Dev May 20, 2024
3 checks passed
@GSKirox GSKirox deleted the cutscenes branch May 22, 2024 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Patching Affects the patching of the ROM Type: Enhancement New feature or request Type: Maintenance Code style, infrastructure, updating dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Better documentation for cutscene patches
3 participants