What is this? In some games you can use an item in-game to change the soundtrack on the fly. For instance, some Pokemon games let you find and use a "GB Player" item that changes the music to the same songs, but retro! This plugin seeks to replicate that ability, letting you apply audio swapping to BGMs, SEs, MEs, and BGSs as you wish. How to Use Add the .js file to your project's js/plugin folder, then open up the plugin manager in the editor and add the plugin.
What is this?
In some games you can use an item in-game to change the soundtrack on the fly. For instance, some Pokemon games let you find and use a "GB Player" item that changes the music to the same songs, but retro! This plugin seeks to replicate that ability, letting you apply audio swapping to BGMs, SEs, MEs, and BGSs as you wish.
How to Use
Add the .js file to your project's js/plugin folder, then open up the plugin manager in the editor and add the plugin.
There's general help in the description for each of the default settings.
As an example on how to setup alternate music, go to your game's audio/bgm folder. In it, make a new folder - for this example, let's call it Alternate1. But you can call it whatever! Then go to the plugin settings, open Alternate Music Subfolders, double-click a blank line to add a new one, and enter the name of the folder you made. The game will look in these folders for alternate music, and you can make as many as you wish. You can also make them with the same name in the audio/se, audio/me, and audio/bgs folders, and have the relevant Affect setting set to true to have alternate audio apply to those.
In the alternate folders you make, place audio files with the
same names as the ones in the main folder! They'll get played instead of the regular ones in the main folder when that folder is chosen. If a file is missing from an alternate folder, the game will try and play the regular audio file with the same name from the main folder first, to help prevent excess "missing file" crashes.
Once setup, in-game just use any of the plugin's commands to swap what folder audio is being pulled from! You could easily attach this functionality to a usable key item or a menu option (not included).
Plugin Commands
- Change Subfolder (ID) Sets the audio source folder to the ID you give it.
- Next Subfolder (ID) Sets the audio source folder to the next ID in the list. Wraps around if it goes past the end.
- Previous Subfolder (ID) Sets the audio source folder to the previous ID in the list. Wraps around if it goes past the start.
- Random Subfolder (ID) Sets the audio source folder to a random one from the list!
- Change Subfolder (Name) Sets the audio source folder to the one with the name you entered. Must still be defined in the plugin settings Alternate Music Subfolders list.
- Change Affected Lets you change what audio types are affected by the plugin mid-game.
- Save Global Data If global saving of the current subfolder is enabled in the plugin settings, will manually save the global data. Normally this gets saved automatically when the user saves the game.
- Erase Global Data Deletes the global save data.
Does this work on a release build if I encrypt my audio?
I've tested a build with encrypted audio and had no problems!
I've found a bug/I think this feature would help!
Please reply and let me know! I've tested as many edge cases as I can, but there's always going to be some that get missed.
Terms of Use
You can view the license
here. In short, it is free for commercial or non-commercial use. Credit is optional as long as you don't claim it as your own work.
Downloads
You can download just the plugin
here. Press the 'Raw' button then Ctrl+S to save it.
Terms of Use You can view the license here. In short, it is free for commercial or non-commercial use. Credit is optional as long as you don't claim it as your own work. Downloads You can download just the plugin here. Press the 'Raw' button then Ctrl+S to save it.
