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

Sound driver and other documentation updates and fixes #34

Merged
merged 7 commits into from
Nov 21, 2021

Conversation

Brainulator9
Copy link
Contributor

Intended to work on #32, several edits have been made to do the following:

  • The most important: all nameless temporary labels within the sound driver file have been removed.
  • As a bonus, all of the sound driver's "zloc"-style labels (i.e. the default ones) have been given proper names.
  • Some functions in the main file, such as the Kosinski decompression routine, have also had their nameless temporary labels removed.
  • Various tab clusters have been edited for better consistency, seeing as this is meant to use 8-space-wide tabs.
  • Various proper nouns are now properly capitalized. This solely applies to comments and not labels.
  • Some comments have been updated or removed, in light of either new information or to reduce fluff.

Many of the labels I added were taken from the Sonic 1 disassembly.

Working towards [sonicretro#32](sonicretro#32); thankfully, it's close enough to Sonic 1's code that I can take names from the S1 disassembly. Some comments have been changed accordingly.

I also fixed a few typos and inconsistent tab character uses, as well as converted all uses of "branch" to "jump" to better reflect Z80 assembly nomenclature.
A more liberal take on things: some names have been replaced or reverted, based on feedback from my last commit.

Other things: I completely redid one comment for clarity's sake (since there was misleading information)... and I noticed this last time, but only saw fit to mention it now: there's a line that was changed between 1 and 2 that I don't know if this is a bug. Perhaps someone more knowledgable can clue me in?
Some more stuff changed to either a) reflect information gained from the released SMPS source code, b) make things a bit more person-neutral. and c) fill in the last remaining zloc-ed names.
After over a decade, every label should now have been changed from the default "zloc" style labels. All three version build bit-perfect.
The war (on nameless temporary labels) began, Earth trembling in fear
s2.sounddriver.asm Outdated Show resolved Hide resolved
Yes, these genuinely ARE out of order in the code. The order has been reversed to match both the Sonic 1 disassembly and the SMPS 68K source code release from Hidden Palace.
@flamewing flamewing merged commit 841bd1b into sonicretro:master Nov 21, 2021
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.

3 participants