zladx/LADX-Disassembly

Clarify the relation between hMusicTrack, hNextMusicTrack and wActiveMusicTrack

Open

#232 opened on May 12, 2020

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Assembly (89 forks)github user discovery
audiohelp wanted

Repository metrics

Stars
 (886 stars)
PR merge metrics
 (PR metrics pending)

Description

There are several variables controlling the music track playback:

  • hMusicTrack,
  • hNextMusicTrack,
  • wActiveMusicTrack

These variables are often used together, but seem to have subtle differences (like one of these seems to have immediate effect, and another to store the track to be played after a transition).

We should understand better what these variables do (and maybe rename some of them accordingly).

Contributor guide

Research direction
Trace the usage of hMusicTrack, hNextMusicTrack, and wActiveMusicTrack through the disassembly. Look for comments or nearby code that reveals their roles. Compare with music playback logic in similar Game Boy disassemblies.
Tech stack
None
Domain
reverse engineering
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
AssemblyGame disassembly
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40