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

[WIP] Sequence Instructions Documentation #1248

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

engineer124
Copy link
Contributor

This PR adds documentation to all the sequence instructions introduced in the audio extraction PR #1236. This WIP will hopefully give context to the sequence instructions to all the OoT sequences, and help reviewers with understanding the scripts and extraction process for sequences introduce in audio extraction.

The current approach is to just use comments on the switch cases to pair instructions to cases, I am unsure if it is worth making macro's for this long list of instructions for a single use case. I added a brief description of each instruction names as many of the instructions are very abbreviated (too abbreviated imo but that's a discussion for the other PR).

This will likely remain a WIP until the audio extraction PR is complete, and is here more for reference to help review audio extraction, and to discuss how we want to sync the documentation of sequence instructions between sequences themselves and in audio_seqplayer.c

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant