@rian8337/osu-difficulty-calculator 1.0.0 → 1.0.1

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/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.1",
+  "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"
@@ -28,10 +28,10 @@
     "url": "https://github.com/Rian8337/osu-droid-module/issues"
   },
   "dependencies": {
-    "@rian8337/osu-base": "^1.0.0"
+    "@rian8337/osu-base": "^1.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e4fdb9c1ed6f90e70651c1aedfdb964b61cb240d"
+  "gitHead": "8406e60764d46fc30483b95f56a097f2c0245417"
 }

package/typings/index.d.ts

@@ -945,16 +945,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.
          */