How to use simple modcharts

How to use simple modcharts

Note that simple modcharts are still work in progress and are subject to change

Simple modcharts are JSON files created in a song's folder, and containing informations that the game uses to execute some actions

To create a modchart, create a modchart.json file in a song's folder. Then add {"modchart": [modchart instructions here]}

List of modchart instructions:

• Actions:

Actions directly execute things during the song. To use actions, add {"type": action type here, parameters here} in the modchart instructions.

List of actions:

• "arrowAlphaChange":
  This changes the alpha of the arrows of a side, with a linear transition from the start value to the end value
  Parameters:

  • "player": the player affected. 1 for opponent and 2 for player
  • "startValue": the start value of the alpha (between 0 and 1 included)
  • "endValue": the end value of the alpha (between 0 and 1 included)
  • "startTime": the time in seconds where the transition begins
  • "endTime": the time in seconds where the transition ends
  • "pos": the time in milliseconds where this action is read by the game. While this time isn't reached, this action will be ignored

• "characterAlphaChange":
  This changes the alpha of the character of a side, with a linear transition from the start value to the end value. It uses the same parameters as the "arrowAlphaChange" action

• "characterLoading":
  This defines the characters that are loaded at the beginning of the song. This is used with the "changeCharacter" action, as characters that are not loaded can't be changed Parameters:

  • "name": the name of the character that you want to load
  • "player": the position where the character will be when changed to replace one of the characters. 1 for the opponent and 2 for the player

• "changeCharacter":
  This changes one of the characters of the game to an other one. The character have to be loaded first with the "characterLoading" action Parameters:

  • "name": the name of the character you want to replace one of the characters with
  • "player": the position where the character will be. 1 for the opponent and 2 for the player
  • "pos": the time in milliseconds where the character is changed

• "arrowTextureLoading":
  Is used to load arrow textures that will be used in the song to change mid-game or special arrows.
  Note: There is always 3 special textures that you shouldn't use as your loaded name: "Main", "Player" and "Opponent"
  "Main" is the main texture, the one that is selected in the options by the player
  "Player" and "Opponent" are the textures currently used for the player and opponent side
  Parameters:

  • "loadedName": the name the texture will have once loaded (the name you enter to select the texture)
  • "textureName": the name of the texture to load

• "changeArrowTexture":
  Is used to change the arrow textures mid-game.
  Note: There is always 3 special textures that you shouldn't use as your loaded name: "Main", "Player" and "Opponent"
  "Main" is the main texture, the one that is selected in the options by the player
  "Player" and "Opponent" are the textures currently used for the player and opponent side
  Parameters:

  • "player": the number of the side that is affected by the change. 1 for the opponent's side and 2 for the player's side
  • "name": the name of the texture that will replace the previous one. This is the same name as the "loadedName" parameter of the "arrowTextureLoading" action
  • "pos": the time in milliseconds where the arrow texture is changed

• Conditions:

These are only executed when the specified condition is met, and executes the specified actions recursively (like if it contained a little modchart inside, that can contain other conditions which contains conditions etc...)

List of conditions:

• "Organiser":
  This is a condition that is always True, to organise your modchart Parameters:
  • "modchart": the elements of the modchart that are executed. These work exactly the same as the main modchart

Tip: To know the timings for positions in time of your actions, press spacebar in-game for debug info. It will print in the console (cmd for the exe version of the game) the position in time (in milliseconds) of when you pressed spacebar