Replace OSRS tracks with presets (such as OSRSBeatz or RS3 music) or your own music. It also allows you to search the music from youtube.
The replaced (or "overridden") tracks will behave like the normal music. That is, it'll play whenever the original track would play and volume is controlled by the one in-game.
❗ Note: the music plugin is required to be on and you must've changed volume through it at least once. (Because this plugin uses the music plugin's music volume config item.)
With bulk override you can replace multiple tracks at once.
Just right-click on the music-tab, choose Override tracks and select if you want to override From preset or From directory (local).
With presets you can easily replace all (available) tracks by some preset such as OSRSBeatz or RS3 music.
When you select a preset it will begin downloading all the tracks in the preset (or possibly skip if already overridden).
(Note that if you stop runelite prematurely it may not have overridden all tracks available in the preset.)
(In case you're missing any track in an existing preset, or a preset altogether, please create a PR for the presets file).
You can also bulk override with (supported) local files.
To do this just select the folder which contains the files.
For this to work the file names must be identical to the track name.
In the config there's a Skip overridden if bulk checkbox that, when on, will cause bulk-override to skip any already overridden files.
Useful when you've already manually overridden a few files, now want to use a preset but don't want to override the ones you already replaced.
To replace single tracks go to the track you wish to replace in the track list.
(For ease of use you can jump to track or use the search functionality of the music plugin).
Right-click on the track you wish to replace and click Override.
Then choose to override With a local file. or From a youtube search..
When overriding from a youtube search enter your desired search term and choose an item.
Use Continue to see more search results.
The audio will then be downloaded and when finished the track will be replaced.
When overriding with a local file just select with which (supported) file you want to override.
- To remove all overrides right-click the music tab and select
Remove overrides. - To remove a single override right-click (an overridden) track and select
Remove override.
Clicking on the currently playing label will jump to the track in the music list.
When the Play overrides to end config checkbox is on a new track won't be played until the current override is finished.
Especially useful if you remain in one area with vanilla Music area mode on Modern because it might end your override tracks prematurely
(which happens because osrs thinks the vanilla track is done and starts playing a new one).
It will practically queue the next track, and when one is queued the Playing label on the music tab will become bold and get a hover tooltip for which track is Up next.
The label will also become clickable to end the current override.
❗ Note: This feature might be somewhat counter-intuitive, which is also why it's off by default.
For example this also means that when you manually click a track to play it won't play until the current override is finished.
(Unless then clicked on the Playing label as described above).
Currently only wav (in CD quality) and mp3 formats are supported.
This project uses the JaCo mp3 player to play mp3, its source can be found here. The JaCo project is licensed under LGPL which you can find here or otherwise here. In case one wishes to swap out JaCo for something different, one can clone this plugin and implement the MusicPlayer for the mp3 extension.
For any questions or feedback you can find me on Discord as Mr.A#0220
Feel free to help out by creating issues, pull requests, or just messaging me (on Discord).