DataFormat

Json format

The mod will send all it's data responses (except Images) as JSON following the format listed below.

Example JSON response:

{
    "location": 5,              // 0 = Menu, 1 = in song, 2 = mp in song, 3 = tutorial, 4 = campaign, 5 = in mp lobby
    "isPractice": false,        // If they are practice mode
    "paused": false,            // If the game is paused
    "time": 39,                 // Time of the song (in seconds)
    "endTime": 92,              // Length of the song (in seconds)
    "score": 91605,             // Score
    "rank": "B",                // Rank
    "combo": 0,                 // Combo
    "energy": 0,                // Health (0.0 to 1.0)
    "accuracy": 0.5321077108383179,            // accuracy (0.0 to 1.0)
    "levelName": "(can you) understand me?",   // Song name
    "levelSubName": "",                        // Song Sub name
    "levelAuthor": "Sotarks",                  // Mapper
    "songAuthor": "Komiya Mao",                // Song artist
    "id": "custom_level_DF27F79D91778CC141315B457D621D249C11DC6B", // Song id (remove "custom_level_" to get hash)
    "difficulty": 0,         // Selected difficulty (0 = easy, 1 = normal, 2 = hard, 3 = expert, 4 = expert +)
    "bpm": 185,              // bpm of the selected song
    "njs": 13,               // njs of the selected song
    "players": 1,            // Players in current mp lobby
    "maxPlayers": 5,         // max players of current mp lobby
    "mpGameId": "P7GZM",     // GameId of current multiplayer lobby
    "mpGameIdShown": false,  // If the Game Id is shown in game (true) or as ***** (false)
    "goodCuts": 282,         // How many blocks have been cut right
    "badCuts": 9,            // How many blocks have been cut wrong
    "missedNotes": 33,       // How many blocks have been missed
    "fps": 72,               // FPS of the game
    "configFetched":true,    // Set to false if Settings are changed in-game and haven't been fetched yet
    "coverFetchable": true   // true if the cover for the selected song is available from the cover endpoint
}

Currently many values only update and do not reset (What I mean is that after you go out of a mp lobby the game id will still be there)