plugins/gitadora@asphyxia/README.md

GITADORA Plugin for Asphyxia-Core

This plugin is based on converted from public-exported Asphyxia's Routes.

Supported Versions

• Tri-Boost Re:EVOLVE
• Matixx
• EXCHAIN
• NEX+AGE
• HIGH-VOLTAGE
• FUZZ-UP
• GALAXY WAVE

When Plugin Doesn't work correctly / Startup Error on Plugin

The folder structure between v1.0 and v1.1 is quite different. Do not overwrite plugin folder.
If you encounter errors, Please try these steps:

1. Remove gitadora@asphyxia folder.
2. Ctrl-C and Ctrl-V the newest version of gitadora@asphyxia
3. (Custom MDB Users) Reupload MDB or move data/custom_mdb.xml to data/mdb/custom.xml

Known Issues

• ~Information dialog keep showing as plugin doesn't store item data currently.~ (Fixed as of version 1.2.1)
• Special Premium Encore on Nextage is unimplemented. However, a workaround is available. Try it.
• Friends and Rivals are unimplemented.

Shared Data Options

Two experimental options allow operators to share data across versions:

• Shared Favorite Songs (shared_favorite_songs, default: false): When enabled, favorite lists are unified across Guitar Freaks, DrumMania, and supported versions.
• Shared Song Scores (shared_song_scores, default: false): When enabled, the server merges the best results for each chart across every stored version and saves them under a shared version identifier. The merged record uses the following shape (fields marked with // describe their meaning):

scores: {
  "<musicid>": {
    update: [<seq>, <new_skill>], // Highest new_skill value seen and its associated seq
    diffs: {
      "<seq>": {
        perc: <number>,   // Highest achievement percentage
        rank: <number>,   // Highest rank reached for the chart
        clear: <boolean>, // Whether the chart has been cleared
        fc: <boolean>,    // Whether a full combo was achieved
        ex: <boolean>,    // Whether an excellent was achieved
        meter: "<string>",// Best meter value as a stringified bigint
        prog: <number>,   // Highest progression value
      }
    }
  }
}

Scores are stored under version: "shared" but are automatically applied to the active module when loading a profile, ensuring players benefit from their best combined results regardless of the client version.

Release Notes

v1.4.0

• Added support for Tri-Boost Re:EVOLVE, HIGH-VOLTAGE, FUZZ-UP, GALAXY WAVE
• Bugfix for launch core with "--dev/--console"

v1.3.0

• Added experimental 'Shared Favorite Songs' option. If disabled, players will be able to keep separate lists of favorite songs for each version of Gitadora, as well as between Guitar Freaks and Drummania. Enable this option to have a single unified list of favorite songs for both games, and across all versions. Default is false, to match original arcade behaviour.
• Added a leaderboards page to the WebUI. This page displays the rank of all players per game and version, ordered by Skill rating.
• More code cleanups to Profiles.ts

v1.2.4

• Fixed note scroll speed defaulting to 0.5x for newly registered profiles.
• Misc code cleanup. No changes expected to plugin behaviour.

v1.2.3

• Fixed bug preventing MDB files in XML format from loading (Thanks to DualEdge for reporting this ).

v1.2.2

• Major improvements to the MDB (song data) loader. MDB files can now be in .json, .xml or .b64 format. This applies to both the per-version defaults and custom MDBs. To use a custom MDB, enable it in the web UI, and place a 'custom.xml', 'custom.json' or 'custom.b64' file in the data/mdb subfolder.
• Added several player profile stats to the web UI.
• MDB loader now logs the number of loaded songs available to GF and DM when in dev mode.
• MDB: Fixed "is_secret" field being ignored (always set to false)

v1.2.1

• Secret Music (unlocked songs) are now saved and loaded correctly. Partially fixes Github issue #34. Note that all songs are already marked as unlocked by the server - there is no need to unlock them manually. If you would like to lock them, consider using a custom MDB.
• Rewards field is now saved and loaded correctly. Fixes Github issue #34

NOTE: Rewards and secret music data is saved at the end of each session, so you will see the unlock notifications one last time after updating the plugin to this version.

v1.2.0

• Fixed server error when saving profiles for two Guitar Freaks players at the end of a session. Fixes Github issue #39.
• Fixed another server error when two players are present, but only one player is using a profile.
• Added support for the "ranking" field. Gitadora will now correctly display your server ranking (based on Skill) on the post-game screen.
• "Recommended to friends" songs are now saved and loaded correctly. Since you don't have any friends, this won't be terribly useful, but it does at least provide an extra five slots for saving your favourite songs.
• Fixed "Recommended to friends" song list being incorrectly initialized to "I think about you".
• misc: Added logging for profile loading/saving when Asphyxia is running in dev mode.
• misc: Added more logging to mdb (song database) loading.
• misc: Removed some unneeded duplicate code.
• misc: Latest getPlayer() and savePlayers() API requests and responses are now saved to file when Asphyxia is in dev mode. Useful for debugging.

v1.1.1

• fix: Error when create new profile on exchain.
• fix: last song doesn't work correctly.
• misc: Add logger for tracking problem.

v1.1.0

• NEX+AGE Support (Not full support.)
• Restructure bit for maintaining.

v1.0.0

• Initial release for public