@rian8337/osu-difficulty-calculator 1.0.0 → 1.0.5

package/README.md

@@ -1,11 +1,106 @@
-# `osu-difficulty-calculator`
+# About
 
-> TODO: description
+The difficulty and performance calculator portion of my osu! module that uses the current difficulty and performance algorithm.
 
-## Usage
+# Features
 
+This module provides an osu! difficulty and performance calculator that uses the current difficulty and performance algorithm for osu!standard gamemode.
+
+An error margin should be expected from difficulty and performance calculator due to differences between C# and TypeScript.
+
+# Specific Requirements
+
+This module has no specific requirements, however installed modules in installation may have specific requirements. It's advised to check them.
+
+# Installation
+
+```
+npm i @rian8337/osu-base @rian8337/osu-difficulty-calculator
+```
+
+or
+
+```
+yarn add @rian8337/osu-base @rian8337/osu-difficulty-calculator
 ```
-const osuDifficultyCalculator = require('osu-difficulty-calculator');
 
-// TODO: DEMONSTRATE API
+# Usage
+
+## General usage
+
+```js
+import { MapInfo } from "@rian8337/osu-base";
+import {
+    DroidStarRating,
+    MapStars,
+    OsuStarRating,
+} from "@rian8337/osu-difficulty-calculator";
+
+const beatmapInfo = await MapInfo.getInformation({ beatmapID: 901854 });
+
+if (!beatmapInfo.title) {
+    return console.log("Beatmap not found");
+}
+
+// Calculate osu!droid difficulty
+const droidRating = new DroidStarRating().calculate({
+    map: beatmapInfo.map,
+});
+
+console.log(droidRating);
+
+// Calculate osu!standard difficulty
+const osuRating = new OsuStarRating().calculate({
+    map: beatmapInfo.map,
+});
+
+console.log(osuRating);
+
+// Calculate both osu!droid and osu!standard difficulty
+const rating = new MapStars().calculate({
+    map: beatmapInfo.map,
+});
+
+// osu!droid difficulty
+console.log(rating.droidStars);
+// osu!standard difficulty
+console.log(rating.pcStars);
+```
+
+## Specifying parameters
+
+Parameters can be applied to alter the result of the calculation:
+
+-   Mods: Modifications that will be considered when calculating the difficulty of a beatmap. Defaults to none.
+-   Custom statistics: Used to apply a custom speed multiplier and force AR. Defaults to none.
+
+```js
+import { MapInfo, MapStats, ModUtil } from "@rian8337/osu-base";
+import { MapStars } from "@rian8337/osu-difficulty-calculator";
+
+const beatmapInfo = await MapInfo.getInformation({ beatmapID: 901854 });
+
+if (!beatmapInfo.title) {
+    return console.log("Beatmap not found");
+}
+
+const mods = ModUtil.pcStringToMods("HDHR");
+
+const stats = new MapStats({
+    ar: 9,
+    isForceAR: true,
+    speedMultiplier: 1.5,
+});
+
+// Also available for `DroidStarRating` and `OsuStarRating`
+const rating = new MapStars().calculate({
+    map: beatmapInfo.map,
+    mods: mods,
+    stats: stats,
+});
+
+// osu!droid difficulty
+console.log(rating.droidStars);
+// osu!standard difficulty
+console.log(rating.pcStars);
 ```

package/dist/DroidPerformanceCalculator.js

@@ -74,18 +74,16 @@ class DroidPerformanceCalculator extends PerformanceCalculator_1.PerformanceCalc
         // Combo scaling
         this.aim *= this.comboPenalty;
         // We want to give more reward for lower AR when it comes to aim and HD. This nerfs high AR and buffs lower AR.
-        let hiddenBonus = 1;
         if (this.stars.mods.some((m) => m instanceof osu_base_1.ModHidden)) {
             // The bonus starts decreasing twice as fast
             // beyond AR10 and reaches 1 at AR11.
             if (calculatedAR > 10) {
-                hiddenBonus += Math.max(0, 0.08 * (11 - calculatedAR));
+                this.aim *= 1 + Math.max(0, 0.08 * (11 - calculatedAR));
             }
             else {
-                hiddenBonus += 0.04 * (12 - calculatedAR);
+                this.aim *= 1 + 0.04 * (12 - calculatedAR);
             }
         }
-        this.aim *= hiddenBonus;
         // AR scaling
         let arFactor = 0;
         if (calculatedAR > 10.33) {

package/dist/OsuPerformanceCalculator.js

@@ -77,11 +77,9 @@ class OsuPerformanceCalculator extends PerformanceCalculator_1.PerformanceCalcul
         // Buff for longer maps with high AR.
         this.aim *= 1 + arFactor * lengthBonus;
         // We want to give more reward for lower AR when it comes to aim and HD. This nerfs high AR and buffs lower AR.
-        let hiddenBonus = 1;
         if (this.stars.mods.some((m) => m instanceof osu_base_1.ModHidden)) {
-            hiddenBonus += 0.04 * (12 - calculatedAR);
+            this.aim *= 1 + 0.04 * (12 - calculatedAR);
         }
-        this.aim *= hiddenBonus;
         // Scale the aim value with slider factor to nerf very likely dropped sliderends.
         this.aim *= this.sliderNerfFactor;
         // Scale the aim value with accuracy.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rian8337/osu-difficulty-calculator",
-  "version": "1.0.0",
-  "description": "A module for calculating osu!standard beatmap difficulty with respect to the current difficulty and performance algorithm.",
+  "version": "1.0.5",
+  "description": "A module for calculating osu!standard beatmap difficulty and performance value with respect to the current difficulty and performance algorithm.",
   "keywords": [
     "osu",
     "osu-difficulty-calculator"
@@ -21,6 +21,8 @@
   },
   "scripts": {
     "build": "tsc",
+    "generate-docs": "typedoc src/index.ts",
+    "lint": "eslint --ext ts",
     "prepare": "npm run build",
     "test": "jest -i"
   },
@@ -28,10 +30,10 @@
     "url": "https://github.com/Rian8337/osu-droid-module/issues"
   },
   "dependencies": {
-    "@rian8337/osu-base": "^1.0.0"
+    "@rian8337/osu-base": "^1.0.5"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e4fdb9c1ed6f90e70651c1aedfdb964b61cb240d"
+  "gitHead": "c8c092485a5ae3be16f2bfa0a3defb00163918d7"
 }

package/typings/index.d.ts

@@ -1,5 +1,15 @@
 declare module "@rian8337/osu-difficulty-calculator" {
-    import { Accuracy, Beatmap, HitObject, MapStats, Mod, modes, OsuHitWindow, Slider, Vector2 } from "@rian8337/osu-base";
+    import {
+        Accuracy,
+        Beatmap,
+        HitObject,
+        MapStats,
+        Mod,
+        modes,
+        OsuHitWindow,
+        Slider,
+        Vector2,
+    } from "@rian8337/osu-base";
 
     //#region Classes
 
@@ -39,7 +49,7 @@ declare module "@rian8337/osu-difficulty-calculator" {
         flashlightStrain: number;
         /**
          * The normalized distance from the "lazy" end position of the previous hitobject to the start position of this hitobject.
-         * 
+         *
          * The "lazy" end position is the position at which the cursor ends up if the previous hitobject is followed with as minimal movement as possible (i.e. on the edge of slider follow circles).
          */
         lazyJumpDistance: number;
@@ -393,6 +403,41 @@ declare module "@rian8337/osu-difficulty-calculator" {
         protected override saveToHitObject(current: DifficultyHitObject): void;
     }
 
+    /**
+     * A star rating calculator that configures which mode to calculate difficulty for and what mods are applied.
+     */
+    export class MapStars {
+        /**
+         * The osu!droid star rating of the beatmap.
+         */
+        readonly droidStars: DroidStarRating;
+        /**
+         * The osu!standard star rating of the beatmap.
+         */
+        readonly pcStars: OsuStarRating;
+        /**
+         * Calculates the star rating of a beatmap.
+         */
+        calculate(params: {
+            /**
+             * The beatmap to calculate.
+             */
+            map: Beatmap;
+            /**
+             * Applied modifications.
+             */
+            mods?: Mod[];
+            /**
+             * Custom map statistics to apply speed multiplier and force AR values as well as old statistics.
+             */
+            stats?: MapStats;
+        }): MapStars;
+        /**
+         * Returns a string representative of the class.
+         */
+        toString(): string;
+    }
+
     /**
      * Represents the skill required to correctly aim at every object in the map with a uniform CircleSize and normalized distances.
      */
@@ -822,7 +867,10 @@ declare module "@rian8337/osu-difficulty-calculator" {
         /**
          * Calculates the amount of misses + sliderbreaks from combo.
          */
-        private calculateEffectiveMissCount(combo: number, maxCombo: number): number;
+        private calculateEffectiveMissCount(
+            combo: number,
+            maxCombo: number
+        ): number;
     }
 
     /**
@@ -945,16 +993,6 @@ declare module "@rian8337/osu-difficulty-calculator" {
          * Calculates every star rating of the beatmap and stores it in this instance.
          */
         abstract calculateAll(): void;
-        /**
-         * Generates the strain chart of this beatmap and returns the chart as a buffer.
-         *
-         * @param beatmapsetID The beatmapset ID to get background image from. If omitted, the background will be plain white.
-         * @param color The color of the graph.
-         */
-        getStrainChart(
-            beatmapsetID?: number,
-            color?: string
-        ): Promise<Buffer | null>;
         /**
          * Returns a string representative of the class.
          */