@rian8337/osu-difficulty-calculator 1.2.3 → 1.3.0

package/README.md

@@ -26,7 +26,7 @@ yarn add @rian8337/osu-base @rian8337/osu-difficulty-calculator
 
 # Usage
 
-## General usage
+## Difficulty calculator
 
 ```js
 import { MapInfo } from "@rian8337/osu-base";
@@ -67,7 +67,7 @@ console.log(rating.droidStars);
 console.log(rating.pcStars);
 ```
 
-## Specifying parameters
+### Specifying difficulty calculation parameters
 
 Parameters can be applied to alter the result of the calculation:
 
@@ -104,3 +104,103 @@ console.log(rating.droidStars);
 // osu!standard difficulty
 console.log(rating.pcStars);
 ```
+
+## Performance calculator
+
+```js
+import { MapInfo } from "@rian8337/osu-base";
+import {
+    DroidPerformanceCalculator,
+    MapStars,
+    OsuPerformanceCalculator,
+} from "@rian8337/osu-difficulty-calculator";
+
+const beatmapInfo = await MapInfo.getInformation({ beatmapID: 901854 });
+
+if (!beatmapInfo.title) {
+    return console.log("Beatmap not found");
+}
+
+const rating = new MapStars().calculate({
+    map: beatmapInfo.map,
+});
+
+// osu!droid performance
+const droidPerformance = new DroidPerformanceCalculator().calculate({
+    stars: rating.droidStars,
+});
+
+console.log(droidPerformance);
+
+// osu!standard performance
+const osuPerformance = new OsuPerformanceCalculator().calculate({
+    stars: rating.pcStars,
+});
+
+console.log(osuPerformance);
+```
+
+### Specifying performance calculation parameters
+
+Parameters can be passed to alter the result of the calculation:
+
+-   Combo: The maximum combo achieved. Defaults to the beatmap's maximum combo.
+-   Accuracy: The accuracy achieved. Defaults to 100%.
+-   Misses: The amount of misses achieved.
+-   Tap penalty: Penalty given from three-finger detection. Only applied for osu!droid gamemode. Defaults to 1.
+-   Custom statistics: Used to apply a custom speed multiplier and force AR. Defaults to none.
+
+```js
+import { Accuracy, MapInfo, MapStats } from "@rian8337/osu-base";
+import {
+    OsuPerformanceCalculator,
+    OsuStarRating,
+} from "@rian8337/osu-difficulty-calculator";
+
+const beatmapInfo = await MapInfo.getInformation({ beatmapID: 901854 });
+
+if (!beatmapInfo.title) {
+    return console.log("Beatmap not found");
+}
+
+const rating = new OsuStarRating().calculate({
+    map: beatmapInfo.map,
+});
+
+const accuracy = new Accuracy({
+    // Specify your misses here
+    nmiss: 1,
+
+    // The module provides a convenient way to specify accuracy based on the data that you have
+    // Remove the codes below as you see fit
+
+    // If you have hit data (amount of 300s, 100s, and 50s)
+    n300: 1000,
+    n100: 0,
+    n50: 0,
+
+    // If you have accuracy percentage
+    // While this method is more convenient to use, the amount of 300s, 100s, and 50s will be estimated
+    // This will lead to values being off when calculating for specific accuracies
+    percent: 100,
+    nobjects: beatmapInfo.objects,
+});
+
+const stats = new MapStats({
+    ar: 9.5,
+    isForceAR: true,
+    speedMultiplier: 1.25,
+});
+
+const performance = new OsuPerformanceCalculator().calculate({
+    stars: rating,
+    combo: 1250,
+    accPercent: accuracy,
+    // The tap penalty can be properly obtained by checking a replay for three finger usage
+    // However, a custom value can also be provided
+    tapPenalty: 1.5,
+    stats: stats,
+});
+
+console.log(performance);
+```

package/dist/DroidPerformanceCalculator.js

@@ -51,11 +51,8 @@ class DroidPerformanceCalculator extends PerformanceCalculator_1.PerformanceCalc
      */
     calculateAverageRhythmMultiplier() {
         // The first object doesn't have any rhythm multiplier, so we begin with the second object
-        const rhythmMultipliers = this.stars.objects
-            .map((v) => v.rhythmMultiplier)
-            .slice(1);
-        this.aggregatedRhythmMultiplier = Math.max(1, rhythmMultipliers.reduce((total, value) => total + value, 0) /
-            Math.max(500, rhythmMultipliers.length));
+        const rhythmObjects = this.stars.objects.slice(1);
+        this.aggregatedRhythmMultiplier = Math.max(1, rhythmObjects.reduce((total, value) => total + value.rhythmMultiplier, 0) / Math.max(500, rhythmObjects.length));
     }
     /**
      * Calculates the aim performance value of the beatmap.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rian8337/osu-difficulty-calculator",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "description": "A module for calculating osu!standard beatmap difficulty and performance value with respect to the current difficulty and performance algorithm.",
   "keywords": [
     "osu",
@@ -11,6 +11,7 @@
   "license": "MIT",
   "main": "dist/index.js",
   "types": "typings/index.d.ts",
+  "typedocMain": "src/index.ts",
   "files": [
     "dist/**",
     "typings/**"
@@ -21,7 +22,6 @@
   },
   "scripts": {
     "build": "tsc",
-    "generate-docs": "typedoc src/index.ts",
     "lint": "eslint --ext ts",
     "prepare": "npm run build",
     "test": "jest -i"
@@ -30,10 +30,10 @@
     "url": "https://github.com/Rian8337/osu-droid-module/issues"
   },
   "dependencies": {
-    "@rian8337/osu-base": "^1.2.1"
+    "@rian8337/osu-base": "^1.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e2d1f9bef01c9b12954a78683c3b8dcddabc7b1d"
+  "gitHead": "0efc41e2d7f077aaf388424318ee9bd356ff611f"
 }

package/typings/index.d.ts

@@ -872,9 +872,9 @@ declare module "@rian8337/osu-difficulty-calculator" {
              */
             mode?: modes;
             /**
-             * The speed penalty to apply for penalized scores. Only applies to droid gamemode.
+             * The tap penalty to apply for penalized scores. Only applies to droid gamemode.
              */
-            speedPenalty?: number;
+            tapPenalty?: number;
             /**
              * Custom map statistics to apply custom speed multiplier and force AR values as well as old statistics.
              */
@@ -914,9 +914,9 @@ declare module "@rian8337/osu-difficulty-calculator" {
                  */
                 mode?: modes;
                 /**
-                 * The speed penalty to apply for penalized scores.
+                 * The tap penalty to apply for penalized scores.
                  */
-                speedPenalty?: number;
+                tapPenalty?: number;
                 /**
                  * Custom map statistics to apply custom speed multiplier and force AR values as well as old statistics.
                  */