@rian8337/osu-droid-replay-analyzer 4.0.0-beta.32 → 4.0.0-beta.34

package/dist/index.js

@@ -2331,7 +2331,7 @@ class ReplayAnalyzer {
             resultObject.accuracy.nmiss = rawObject[4].readInt32BE(28);
             resultObject.score = rawObject[4].readInt32BE(32);
             resultObject.maxCombo = rawObject[4].readInt32BE(36);
-            resultObject.isFullCombo = !!rawObject[4][44];
+            resultObject.isFullCombo = resultObject.accuracy.value() === 1;
             resultObject.playerName = rawObject[5];
             resultObject.rawMods = Object.values(rawObject[6].elements);
             resultObject.convertedMods = osuBase.ModUtil.droidStringToMods(this.convertDroidMods(resultObject.rawMods));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rian8337/osu-droid-replay-analyzer",
-    "version": "4.0.0-beta.32",
+    "version": "4.0.0-beta.34",
     "description": "A replay analyzer for analyzing osu!droid replay files.",
     "keywords": [
         "osu",
@@ -46,5 +46,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "dd164dcc63fea94501959236d310eccf5a7cda6a"
+    "gitHead": "84edfdafe59ec605b49716cf2e4a56bfc88d89b0"
 }

package/typings/index.d.ts

@@ -182,82 +182,168 @@ declare class CursorData {
 }
 
 /**
- * Represents an exported replay's JSON structure.
+ * The structure of the exported replay JSON data for version 1.
  */
-interface ExportedReplayJSON {
+interface ExportedReplayJSONDataV1 {
+    /**
+     * The path towards the beatmap's `.osu` file from the song directory of the game.
+     */
+    filename: string;
+    /**
+     * The name of the player.
+     */
+    playername: string;
+    /**
+     * The name of the replay file.
+     */
+    replayfile: string;
+    /**
+     * Droid modifications that are used in the replay.
+     */
+    mod: string;
+    /**
+     * The amount of total score achieved.
+     */
+    score: number;
+    /**
+     * The maximum combo achieved.
+     */
+    combo: number;
+    /**
+     * The rank achieved in the replay.
+     */
+    mark: string;
+    /**
+     * The amount of geki hits in the replay.
+     */
+    h300k: number;
+    /**
+     * The amount of great hits in the replay.
+     */
+    h300: number;
+    /**
+     * The amount of katu hits in the replay.
+     */
+    h100k: number;
+    /**
+     * The amount of good hits in the replay.
+     */
+    h100: number;
+    /**
+     * The amount of meh hits in the replay.
+     */
+    h50: number;
+    /**
+     * The amount of misses in the replay.
+     */
+    misses: number;
+    /**
+     * Accuracy gained in the replay.
+     */
+    accuracy: number;
+    /**
+     * The epoch date at which the score was set, in milliseconds.
+     */
+    time: number;
+    /**
+     * Whether the score is a full combo (1 is `true`, 0 is `false`).
+     */
+    perfect: number;
+}
+
+interface ExportedReplayJSONDataV2 {
+    /**
+     * The name of the beatmap.
+     */
+    filename: string;
+    /**
+     * The name of the player.
+     */
+    playername: string;
+    /**
+     * The name of the replay file.
+     */
+    replayfile: string;
+    /**
+     * The MD5 hash of the beatmap.
+     */
+    beatmapMD5: string;
+    /**
+     * Droid modifications that are used in the replay.
+     */
+    mod: string;
+    /**
+     * The amount of total score achieved.
+     */
+    score: number;
+    /**
+     * The maximum combo achieved.
+     */
+    combo: number;
+    /**
+     * The rank achieved in the replay.
+     */
+    mark: string;
+    /**
+     * The amount of geki hits in the replay.
+     */
+    h300k: number;
+    /**
+     * The amount of great hits in the replay.
+     */
+    h300: number;
+    /**
+     * The amount of katu hits in the replay.
+     */
+    h100k: number;
+    /**
+     * The amount of good hits in the replay.
+     */
+    h100: number;
+    /**
+     * The amount of meh hits in the replay.
+     */
+    h50: number;
+    /**
+     * The amount of misses in the replay.
+     */
+    misses: number;
+    /**
+     * Accuracy gained in the replay.
+     */
+    accuracy: number;
+    /**
+     * The epoch date at which the score was set, in milliseconds.
+     */
+    time: number;
+}
+
+/**
+ * Represents an exported replay's JSON structure for version 1.
+ */
+interface ExportedReplayJSONV1 {
     /**
      * The version of the exported replay.
      */
-    version: number;
+    version: 1;
     /**
      * Data of the exported replay.
      */
-    replaydata: {
-        /**
-         * The path towards the beatmap's `.osu` file from the song directory of the game.
-         */
-        filename: string;
-        /**
-         * The name of the player.
-         */
-        playername: string;
-        /**
-         * The name of the replay file.
-         */
-        replayfile: string;
-        /**
-         * Droid modifications that are used in the replay.
-         */
-        mod: string;
-        /**
-         * The amount of total score achieved.
-         */
-        score: number;
-        /**
-         * The maximum combo achieved.
-         */
-        combo: number;
-        /**
-         * The rank achieved in the replay.
-         */
-        mark: string;
-        /**
-         * The amount of geki hits in the replay.
-         */
-        h300k: number;
-        /**
-         * The amount of great hits in the replay.
-         */
-        h300: number;
-        /**
-         * The amount of katu hits in the replay.
-         */
-        h100k: number;
-        /**
-         * The amount of good hits in the replay.
-         */
-        h100: number;
-        /**
-         * The amount of meh hits in the replay.
-         */
-        h50: number;
-        /**
-         * The amount of misses in the replay.
-         */
-        misses: number;
-        /**
-         * Accuracy gained in the replay.
-         */
-        accuracy: number;
-        /**
-         * The epoch date at which the score was set, in milliseconds.
-         */
-        time: number;
-        /**
-         * Whether the score is a full combo (1 is `true`, 0 is `false`).
-         */
-        perfect: number;
-    };
+    replaydata: ExportedReplayJSONDataV1;
+}
+
+/**
+ * Represents an exported replay's JSON structure for version 2.
+ */
+interface ExportedReplayJSONV2 {
+    /**
+     * The version of the exported replay.
+     */
+    version: 2;
+    /**
+     * Data of the exported replay.
+     */
+    replaydata: ExportedReplayJSONDataV2;
 }
 
 /**
@@ -296,10 +382,16 @@ declare enum HitResult {
  */
 declare class ReplayObjectData {
     /**
-     * For circles, this is the offset at which the circle was hit. If the hit accuracy is 10000, it means the circle was tapped too late ([game source code](https://github.com/osudroid/osu-droid/blob/6306c68e3ffaf671eac794bf45cc95c0f3313a82/src/ru/nsu/ccfit/zuev/osu/game/HitCircle.java#L298-L306)).
+     * For circles, this is the offset at which the circle was hit. If the hit accuracy is 10000,
+     * it means the circle was tapped too late and therefore the player missed ([game source code](https://github.com/osudroid/osu-droid/blob/ca0e4a2c06b9db18d094a15a4abf3f7ffcb05d7a/src/ru/nsu/ccfit/zuev/osu/game/GameplayHitCircle.java#L305)).
+     *
+     * For sliders, this is the offset at which the slider head was hit. For sliderbreaks, there are two scenarios:
+     * - a value equal to `Math.floor(<hit window 50>ms) + 13ms` strictly for replays before version 1.7.2 ([game source code](https://github.com/osudroid/osu-droid/blob/6306c68e3ffaf671eac794bf45cc95c0f3313a82/src/ru/nsu/ccfit/zuev/osu/game/Slider.java#L821)), or
+     * - a value that is more than the slider's span duration ([game source code](https://github.com/osudroid/osu-droid/blob/ca0e4a2c06b9db18d094a15a4abf3f7ffcb05d7a/src/ru/nsu/ccfit/zuev/osu/game/GameplaySlider.java#L701)).
      *
-     * For sliders, this is the offset at which the slider head was hit. For
-     * sliderbreaks, the accuracy would be `Math.floor(<hit window 50>ms) + 13ms` ([game source code](https://github.com/osudroid/osu-droid/blob/6306c68e3ffaf671eac794bf45cc95c0f3313a82/src/ru/nsu/ccfit/zuev/osu/game/Slider.java#L821)).
+     * `tickset` and `result` can be used in conjunction with this value to derive whether the player sliderbroke in the slider.
+     * If `result` is a 300, the player did not sliderbreak. Otherwise, if all slider ticks, repeats, and ends were hit, the
+     * player sliderbroke. In other cases, it is almost impossible to derive this result.
      *
      * For spinners, this is the total amount at which the spinner was spinned:
      * ```js
@@ -1173,4 +1265,4 @@ declare class TwoHandChecker {
     private getCursorPosition;
 }
 
-export { CursorData, type CursorInformation, CursorOccurrence, CursorOccurrenceGroup, type ExportedReplayJSON, type Grade, type HitErrorInformation, HitResult, MovementType, RebalanceThreeFingerChecker, ReplayAnalyzer, ReplayData, ReplayObjectData, ReplayV3Data, ReplayV4Data, ReplayV5Data, SliderCheeseChecker, type SliderCheeseInformation, ThreeFingerChecker, type ThreeFingerInformation, TwoHandChecker, type TwoHandInformation };
+export { CursorData, type CursorInformation, CursorOccurrence, CursorOccurrenceGroup, type ExportedReplayJSONDataV1, type ExportedReplayJSONDataV2, type ExportedReplayJSONV1, type ExportedReplayJSONV2, type Grade, type HitErrorInformation, HitResult, MovementType, RebalanceThreeFingerChecker, ReplayAnalyzer, ReplayData, ReplayObjectData, ReplayV3Data, ReplayV4Data, ReplayV5Data, SliderCheeseChecker, type SliderCheeseInformation, ThreeFingerChecker, type ThreeFingerInformation, TwoHandChecker, type TwoHandInformation };