zladx/LADX-Disassembly

Document the sound effects generation

Open

#207 opened on Apr 6, 2020

View on GitHub
 (2 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

Sounds effects (i.e. jingles, waveform-based sfx and noise-based sfx) are generated in https://github.com/zladx/LADX-Disassembly/blob/master/src/code/audio/sfx.asm.

The format seems pretty straightforward; probably no op-codes are involved. Still, the code needs documentation, and at least labeling of the different sound effects.

Contributor guide

Research direction
Examine the audio source file at src/code/audio/sfx.asm, identify each sound effect label or constant, and add comments explaining when each sound is played and its purpose.
Tech stack
None
Domain
game devaudio video rtc
Issue type
Documentation
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-3 hours
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 Boy audio
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65