maniator / maniator/verticopolis
[Feature]: Add developer doc for sounds framework
Open
Beginner friendly
Nobody has claimed this yet.
enhancement
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Problem / motivation
The sounds system is not obvious and not easy to tell what is in the current tone collection. Our goal is to move to richer soundscape.
Proposed solution
Adding a SOUNDS.md file for describing the current soundscape machinery and how to replace tones with MP3s that are correctly coded.
Alternatives considered
n/a - just want to manage sounds better.
Which game mode should this target?
Both / mode-agnostic
Before submitting
- I searched existing issues and this is not a duplicate.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the current sounds system and tone collection, then create the proposed SOUNDS.md file. Document how the soundscape machinery works and how to replace tones with correctly coded MP3s; the work is done when both game modes are covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, game-dev
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100