Adding Custom Content

By default, akashi is configured to have all of the vanilla content available. If you want to add your own characters, backgrounds, or music, you must edit the configuration files.

Adding music

To add a song, put the name, duration and potential file alias in the music.json.

If you want to add a music category, you need to add a new category block to the music.json. Everything inside the song block will show up under that category in the client music list.

Your music.json is structured like this:

[
   {
      "category":"==Music==",
      "songs":[
         {
            "name":"Announce The Truth (AA).opus",
            "length":-1,
            "realname":
         }
      ]
   },
   {
      "category":"==Custom Music==",
      "songs":[
         {
            "name":"Announce The Truth (AJ).opus",
            "length":-1,
            "realname":
         }
      ]
   }
]

Notice how category names do not contain a file extension. The option "realname" is optional and can be used to put streaming links behind song names for servers that do not have a webserver for content hosting but still want to take advantage of the 2.9+ streaming feature. The length option is used for the jukebox to define the play duration. If a song has a length of -1 it can't be played trough the jukebox.

Adding backgrounds

Backgrounds are defined in backgrounds.txt. Users can change the background to any of the backgrounds listed in this file. To add a background, add the background's name (that is, the name of its folder in base/background/) to a new line.

Adding characters

Characters are defined in characters.txt. These will display whenever a user enters the character select screen. To add a character, add the character's name (that is, the name of its folder in base/characters/) to a new line.