Skip to main content

Audio

MahiruAbout 1 min

Audio

Play background music (BGM)

The way to play background music is extremely simple. You just need to place the background music in the bgm directory, then you can simply play it when needed:

bgm:XiaYing.mp3;

You can set a -volume parameter for background music to adjust its volume.

bgm:XiaYing.mp3 -volume=30;

In addition, you can use the -enter parameter for fade-in playback.

bgm:XiaYing.mp3 -enter=3000;

Finally, you can use the following statement to fade out the background music.

bgm:none -enter=3000;

Tips

-volume and -enter are optional parameters.
When -volume is not used, or when a value other than 0 ~ 100 is used, the default value of 100 is used.
When -enter is not used, or when a value other than 0 ~ is used, the default value of 0 is used.

Play voice

As we all know, what often attracts people most to visual novels is the excellent dubbing. Put your dubbing in the vocal folder, then add -audio_file_name parameters to play it.

Yui: I just got here -V3.ogg;

The introduction of dubbing is the same in continuous dialogue.

Yukino: You're here early -V1.ogg;  
Sorry, have you been waiting long? -V2.ogg;

You can set a -volume parameter for a voice to adjust its volume.

Yui: I just got here -V3.ogg -volume=30;

Tips

-volume is an optional parameter.
When -volume is not used, or when a value other than 0 ~ 100 is used, the default value of 100 is used.

Play sound effects

You just need to place the sound effects in the vocal directory, then you can use playEffect to play it.

playEffect:xxx.mp3;

You can set a -volume parameter for sound effects to adjust its volume.

playEffect:xxx.mp3 -volume=30;

Tips

-volume is an optional parameter.
When -volume is not used, or when a value other than 0 ~ 100 is used, the default value of 100 is used.

Loop sound effects

Giving an id to a sound effect will automatically enable sound effect looping. Use the same id later to stop it.

playEffect:xxx.mp3 -id=xxx;  
playEffect:none -id=xxx; // Stop this looping sound effect

Unlock audio for appreciation

Use unlockBgm to unlock audio in Audio Appreciation.

; // Unlock the bgm and give it a name.
unlockBgm:s_Title.mp3 -name=Smiling-Swinging!!!;