Creating A Song - Vortex2Oblivion/LeatherEngine GitHub Wiki

Info

This guide will go over:

  • How to add song files (charts, audio tracks) to the game
  • How to add them to freeplay

Getting Started

In Leather Engine, songs are stored in the songs folder, and charts and metadata are stored in the data/song data folder, make these folders if you haven't already.

[!NOTE]
Keeping the casing of items consistent with this guide helps ensure that users on all operating systems will be able to play your mod since on Unix operating systems (EG: MacOS, Linux), folder and file name capitalization matter.

Audio Files

In your songs folder create a folder with the name of your song (should be lowercase).

freeplay songs list

Inside of the folder for each song, place the audio files for your song. Audio files should in the .ogg file format. Files should be called Inst.ogg and Voices.ogg respectively.

showcase of audio files

Audio File Suffixes

Audio files can have different suffixes. Some reasons you may want to do this is having specific audio tracks for different difficulties, or having split vocal tracks per character. For instance; the song file Inst-hard.ogg will only load when the difficulty of the current song is hard or Voices-player.ogg and Voices-opponent.ogg will be a split track for the player and opponent respectfully.

The game will search for tracks in the following order: (where Track is either Voices or Inst)

  • Track-difficulty-character.ogg
  • Track-difficulty.ogg
  • Track.ogg

[!TIP]
Character name suffixes for audio tracks can support specific character names too (other than just opponent and player). Voices-dad.ogg and Voices-bf.ogg are completely valid and will load for each character.

Chart files

In your data folder make a folder called song data, the the song data folder, make the a folder with your song's name

(inside of the data folder)

data folder

(inside of the song data folder)

song data folder