Skip to content

Rewrite the music system to use regions

Player Name requested to merge PlayerName/2009scape:music-rewrite into master

What has been done in this MR?

Authentically, music is based on regions. Ours is currently based on tiles, which has led to many tiny inauthenticities when somebody hadn't gotten the borders exactly snapped to region boundaries. Rip out all the old and replace it with better stuff. I'll be undertaking the following steps:

  • Completely rewrite our music_configs.json based on a region:id key-value system
  • Rewrite the server parsing code to ingest this new JSON
  • Check that my rewritten music locations are actually correct
    • Correct Zanaris borders, fix #1810
    • Correct music for the western half of Jatiszo, which was completely wrong
    • Slight corrections to the borders for The Lunar Isle, Saga, Legend, Grotto, think also a couple more but I forgot to keep track
    • Fixes for stronghold of player safety from greg
  • Implement special casing for:
    • Sorceress's Garden
    • GWD
    • the bulging dungeon in The Route of All Evil
    • the Stronghold of Player Safety
  • FUTURE WORK: Ceik has expressed willingness to enable Zaros to work with this new approach to music, making life easier for future contributors

What should testers check?

  • That all music tracks in the entire game are correct, or at least no worse than they were before...
  • Double check all five GWD areas, the five sorceress's garden areas, the three Chaos Tunnels areas, and the stronghold of player safety. These all use tile-specific rather than region-wide music.
  • I have tested these changes thoroughly.
  • I used the relevant Zaros tool for any JSON edits where possible, and have attached screenshots of any changes.
Edited by Player Name

Merge request reports