Alt music/sound function and startup choice

[Adam-M93]

As mentioned on Discord, I've been playing around with the alt bgm and se functions, and I had the idea of having a startup option like the opening movie, I copied the &opening.txt file and used that to make a &sound.txt file, but that could be split into music being &music and sound effects being &sound to give a mix and match startup choice.

&sound.txt

Currently it sets the GAltSEflow flag to match the BGM, except for Anime and MangaGamer, as I'm guessing they would use the same SE as the original, so I've set them to flag 0 too.
I have it set to check the GAltBGM flag as GAltBGMFlow doesn't seem to need it so I'd left it at 0 to ask me every time, it could probably use its own flag and maybe have it ask whether you want it to never ask about the music again which would set it to 1.

example videos
Showing startup select with Original, New Patch & Console, same as posted in discord
https://www.youtube.com/watch?v=dAztNBA5jyk

Old MangaGamer OST
https://www.youtube.com/watch?v=OPVGLOGRmy4

I don't have the anime music from the anime music mod but it's there as an option

I've been doing it like for BGM

	if (GetGlobalFlag(GAltBGMflow) == 0) { 	PlayBGM( 2, "Original\msys01", 128, 0); }
	if (GetGlobalFlag(GAltBGMflow) == 1) { 	PlayBGM( 2, "NewUpdate\msys01", 128, 0); }
	if (GetGlobalFlag(GAltBGMflow) == 2) { 	PlayBGM( 2, "Console\hm01_01", 128, 0); }
	if (GetGlobalFlag(GAltBGMflow) == 3) { 	PlayBGM( 2, "Anime\msys01", 128, 0); }
	if (GetGlobalFlag(GAltBGMflow) == 4) { 	PlayBGM( 2, "MangaGamer\msys01", 128, 0); }

and for SE
the console sound effect probably doesn't match as I don't know what console sounds are supposed to play where, so I just picked the nearest sound I heard as a placeholder

	if (GetGlobalFlag(GAltSEflow) == 0) { 	PlaySE( 4, "Original\wa_020", 128, 64 ); }
	if (GetGlobalFlag(GAltSEflow) == 1) { 	PlaySE( 4, "NewPatch\wa_020", 128, 64 ); }
	if (GetGlobalFlag(GAltSEflow) == 2) { 	PlaySE( 4, "Console\vse_do_s", 128, 64 ); }

As for FadeOutBGM, if all soundtracks are to fade at the same time, then the current

FadeOutBGM( 2, 1000, TRUE );

should work no matter the music, but if console music fades in a different place than the rest, then I'm wondering if something like an if not command could be made work to fade everything but console, the best I could do was setting flag 2 to fade a high number channel and everything else to fade the music. I'm not sure what the TRUE/FALSE parts are for, so it's FALSE from testing. A far from ideal method, but it seemed to work

if (GetGlobalFlag(GAltBGMflow) == 2) { FadeOutBGM( 20, 1000, FALSE ); } else { FadeOutBGM( 2, 1000, TRUE ); }

Getting original and the new patch sound done first might be easiest.

Also the MangaGamer OST has tracks used for multiple parts so the file names could be renamed to mg01, mg02 and use one file, for example mangagamer track 1 is used for msys01, msysre and msysmi. The file I downloaded from https://steamcommunity.com/sharedfiles/filedetails/?id=802920332 to try it has duplicated tracks, but it could be cut down.

I'm not sure how possible it would be, but having a way to detect if there's a folder in the bgm folder and only activate flags if it's there would be nice for people that only want some of the soundtracks and not to download all of them, so if someone only wants original, console and mangagamer, then have the game look for those folders in bgm and if they are there then show those 3 options on the ost selector, and the flag switch hotkey would skip it like 0-2-4. If possible this could use an addon selector in the installer that Italo mentioned to download only what you want, or all.

I haven't seen any way to get the hotkey to work while in game, by that I mean you can change the flag with the hotkey, but it won't update the music until the next music change, and if you get to a music change, then save the game after, change the flag, then reload, it will still be the music from the old flag, so Original Music>Save>Change Flag to Console>Load will still play Original Music until it gets to a point where a new console track will play. I'm also not sure how a fallback would work if you did start after choosing console music for example, but didn't have the files as right now it would just play nothing.

[Adam-M93]

I dumped what I've done in a fork of Oni https://github.com/Adam-M93/onikakushi if anyone wants to look and/or try it out.
I've got hold of the sound effects from the 2009 MG version and some are different, so I've added them too to the scripts, ambient bgms/looping sound effects are changed with the GAltSEflow flag so they'll change with different SE options. I've been having Looping Sound Effects for console are set to load from BGM\Console\LoopSE.

7z files containing original, new update, console and mangagamer bgm and se
https://drive.google.com/open?id=1a1-UmWGNYRCJlXEAXtqLU9AgKV99_7zg

I've been doing:
Flag 0 - root of BGM/SE folder, for 07th mod pack, like mentioned in #55
Flag 1 - \Original - audio from original release
Flag 2 - \April2019Update - audio from new 2019 update (I'm not sure what else to call this, my ideas were between 'NewUpdate', 'NewPatch' and 'April2019Update')
Flag 3 - \Console - audio from console release
Flag 4 - \MangaGamer - audio from 2009 MangaGamer release
Flag 5 - \Anime - for anime music

Anime will by default use flag 0 sound effects and ambient bgm/looping sound effects.

Couple questions
Is it possible to have choices, like what's used for the Opening, as buttons instead of text, similar to how the extras menu is displayed, right now the audio selection looks like this

but I'm wondering if it's possible to have it more like this mockup image I did

and how is the audio for the tips menu and menu clicks, ect handled? they aren't in scripts

[Adam-M93]

I've done a light version of the audio switch for ch1-4 which only includes support for default (for 07th mod pack), original and the 2019 update while I still work on stuff for the rest,

https://github.com/Adam-M93/onikakushi/tree/audio-switch-lite

https://github.com/Adam-M93/watanagashi/tree/audio-switch-lite

https://github.com/Adam-M93/tatarigoroshi/tree/audio-switch-lite

https://github.com/Adam-M93/himatsubushi/tree/audio-switch-lite

ps I don't know why the startup choice is so big for ch4

[enumag]

Ok I'm really sorry for only responding here now. This post is fairly long and wasn't available when I wanted to read it due to your GH ban and then I forgot about it. Anyway now with our recent update with the new textbox, font, ui and installer already out, we can spend some time on this I think. Big thanks for your efforts, I know this must have taken a lot of time and could be disappinting that we left it without attention for 2 months.

I've been playing around with the alt bgm and se functions, and I had the idea of having a startup option like the opening movie

While the idea isn't bad it means we would have to always install all the audio packs which is not a good idea due to their size. I don't want to outright refuse the idea, we just need to consider this when making the decision how to implement this.

I've been doing it like for BGM

How exactly did you handle the console music? Afaik the BGMs play and fade in different places than in our games. Did you implement that?

should work no matter the music, but if console music fades in a different place than the rest, then I'm wondering if something like an if not command could be made work to fade everything but console

Afaik if (GetGlobalFlag(GAltSEflow) != 2) { should work just fine, no?

I'm not sure what the TRUE/FALSE parts are for

I believe that's for blocking. As in whether the script should be stuck on this command for the specified duration and only continue after or if it should start executing the next command immediatelly.

Also the MangaGamer OST has tracks used for multiple parts so the file names could be renamed

What is the MangaGamer OST? How does it differ from the music from our vanilla games before April 2019?

I'm not sure how possible it would be, but having a way to detect if there's a folder in the bgm folder and only activate flags if it's there

Exactly what I was thinking. It should be relatively easy for us to implement a DLL function ModDirectoryExists or ModMusicPackExists.

I haven't seen any way to get the hotkey to work while in game, by that I mean you can change the flag with the hotkey, but it won't update the music until the next music change

Yeah that's a fact. It would be possible to get this working correctly with some more DLL work. Basically the PlayBGM could not be hidden inside ifs but it would have to be a custom ModPlayBGM function that would specify the pack number or name as one of the parameters. The game would have to keep track which songs would be playing at any given time based on this and switch them correctly when the hotkey is pressed. Not sure if it is worth the effort to implement but definitely possible.

Is it possible to have choices, like what's used for the Opening, as buttons instead of text, similar to how the extras menu is displayed

No, it's not possible at the moment.

and how is the audio for the tips menu and menu clicks, ect handled? they aren't in scripts

All that is hardcoded in the DLL. With some work we could extract it into JSON config.

[enumag]

Note: Overall I'm not entirely convinced if the alt audio packs should be implemented this way. For console arcs some ifs and/or custom dll work is inevitable but everything else can most likely be dealt with as an installer option just like the new installer selects the orignal or april 2019 music - except for console we can simply add more options there.

[Adam-M93]

No worries about the time, I forgot about this too lol

While the idea isn't bad it means we would have to always install all the audio packs which is not a good idea due to their size. I don't want to outright refuse the idea, we just need to consider this when making the decision how to implement this.

I agree, while I'm happy to have everything installed, others might not be

How exactly did you handle the console music? Afaik the BGMs play and fade in different places than in our games. Did you implement that?

I just used PlayBGM in different parts, if console didn't play a track I'd just not have the PlayBGM for it, or if it fade while others didn't I'd just have it fade for that flag, but I don't think this is a good method

Afaik if (GetGlobalFlag(GAltSEflow) != 2) { should work just fine, no?

Yeah I figured that out pretty recently after looking at dll stuff, I've not tried in scripts but I imagine it'll work there too

What is the MangaGamer OST? How does it differ from the music from our vanilla games before April 2019?

When MangaGamer released it in 2009 they replaced the music and sound effects with their own however there's much less of them, for example, msys01, msysRe and msysMi are all duplicates of the same track in the MG soundtrack. Same with SE, for example wa_002-wa005 are all the same sound. Personally I think it'd be better to remove the dupes, I've been using mgXX for BGM and mgse_XX for SE but they should probably but slightly changed for consistant naming.
Here is a playlist of the MG soundtrack
https://www.youtube.com/watch?v=MPAj_Ovnb7o&list=PLDE2529339AAFE339

Yeah that's a fact. It would be possible to get this working correctly with some more DLL work. Basically the PlayBGM could not be hidden inside ifs but it would have to be a custom ModPlayBGM function that would specify the pack number or name as one of the parameters. The game would have to keep track which songs would be playing at any given time based on this and switch them correctly when the hotkey is pressed. Not sure if it is worth the effort to implement but definitely possible.

I recently had an idea for this but I really have no idea how to implement it properly or if the idea is even good, I posted a pastebin of it in discord but to sum it up basicly in the script would be like
ModPlayBGM(channel, Flag0BGM, Flag1BGM, Flag2BGM, Flag3BGM, Flag4BGM, Flag5BGM, volume, fadein);
and in the DLL, it would get the filenames from the scripts and have them in a list, and then play using the filenamesfrom the list. if it gets to a place where console doesn't change then only replace the ones that do change and keep the current console track the same. stopping the bgm would clear the list
the hotkey would read from this list and load and play the track when changing the flag,
the pastebin is https://pastebin.com/m5rSgdi4

I'm not sure about how to handle the looping sound effects though, like the sounds of higurashi or typing, etc and if my idea would even be able to handle multiple bgm file names at once. Maybe just leaving them on default PlayBGM and not have on the fly switching for them, and tie them to the GAltSEflow flag.
Standard SE probably won't need on the fly switching so they could either use default PlaySE or use something like ModPlayBGM to keep everything on a single like but not have any on the fly switching stuff.

Since I wrote the last post I'd also done a few things with dll editing

• Audio Switch flag for startup choice.
  Asks if you want to use default or select custom, then select bgm, then italo flag, then SE. If you've already chose and restart it'll ask if you want to keep your last or start the selection from scratch.
• Flag for Italo's remakes.
  If enabled Italo's version will play instead of the current soundtracks, however I'm not sure how to handle it with the modplaybgm idea, maybe something like if italoflag=1 and iffileexists play italo version, else play current soundtrack.
• ported over the fixed choices positioning from console arcs

As I said in discord, I'm not a programmer so I don't know much about this kind of stuff, I've just been trying to figure out how something that's already in the dll/scripts work and going from there, while also managing to accidentally break things in the process lol. So sorry if anything I've wrote doesn't make sense

EDIT
I previously mentioned doing
ModPlayBGM(channel, Flag0BGM, Flag1BGM, Flag2BGM, Flag3BGM, Flag4BGM, Flag5BGM, volume, fadein);

however if Flag0BGM, Flag1BGM, Flag2BGM and Flag5BGM always play at the same places, and have the same filenames, just in different folders, then it could probably be
ModPlayBGM(channel, og_bgmfilename, console_bgmfilename, mangagamer_filename, volume, fadein);

and have it load from a folder depending on the flag, so:
flag 0 = BGM\og_bgmfilename
flag 1 = BGM\Original\og_bgmfilename
etc

as for Italo's remakes, something like

string ItaloFolder = Path.Combine(MODSystem.BaseDirectory, "StreamingAssets\\BGM\\ItaloRemakes\\");
if (BurikoMemory.Instance.GetGlobalFlag("GItaloVer").IntValue() == 1 && File.Exists(ItaloFolder + OG_BGMfilename))
{
AudioController.Instance.PlayAudio("ItaloRemakes\\" + OG_BGMfilename, Audio.AudioType.BGM, channel, volume, (float)num2);
}

would play italo's remakes in place if the file exists

[Adam-M93]

EDIT
Latest progress video
https://www.youtube.com/watch?v=UietpyHgYNk
Also shows textbox swapping

I've been continuing work on this myself
https://www.youtube.com/watch?v=IZpYfDa2EmQ

What I've managed for BGMs:

• On the fly switching.
• Keep playing current BGM if no BGM change for current soundtrack, yet there is one for other soundtracks.
• Keep BGM filename stored for on the fly switching in previous points scenario.
• Toggle Italo's remakes and only play if they exist, else play currently selected soundtrack, if Italo's is set to on then AltBGMflow hotkey won't change music.
• Not shown in vid but a new ModFadeOutBGM that works like normal FadeOutBGM but clears stored BGM filenames so you can't switch the bgm and have it start playing again.
• If soundtrack folder doesn't exist then AltBGMflow hotkey skips it, for example missing console music would make hotkey cycle 0-1-2-4-5-0
• Loading game plays the BGM for the currently selected soundtrack, so you could save while playing with Original BGM, swap to April 2019 Update music and load and it will play the music from the April 2019 Update soundtrack
• Save list of BGM filenames, volume and channel when saving the game, so when loading the save you can still swap bgms. (I couldn't figure out how to get this to be saved in the current save, so I saved them to a saveXXX_BGM.txt file with the normal saves)
• Soundtrack subfolders are set in init.txt and no longer hardcoded, I would however prefer it to have a fallback like how tips do, but I haven't figured that out)
  When loading game play BGM for currently selected soundtrack and load BGM filenames from time of save for hotkey BGM switching. (I couldn't figure out how to

What's left that I think could be done:

• Dynamic startup choice that only shows options that have the bgm folders
• Get Looping SE (higurasi, semi, etc) to use this kind of system, but would have to be modified as there's sometimes multiple playing at once so it would have to store them per channel
• Slightly modify previously mentioned ModFadeOutBGM so you can fade out per bgm, there's a couple points where 1 will fade but the rest won't and right now it's all or nothing, maybe something like
  ModFadeOutBGM(ogfade, consolefade, mgfade, channel, time, waitforfade)
  and setting the ogfade, consolesfade, mgfade to true or 1 will fade out only if it's playing one from those and remove that filename from storage

Might be more than should be done, but they are what I've thought about

Also shown in the vid is new entries on the Mod UI display showing what the current bgm filenames are, they were for testing but could be left if wanted. Something similar I've done since the last vid is to show what the BGM folders are set to, so I could check they were updating corrently