@rian8337/osu-base 1.0.0 → 1.0.5

package/README.md

@@ -1,11 +1,68 @@
-# `osu-base`
+# About
 
-> TODO: description
+The base module required for all my osu! modules.
 
-## Usage
+# Features
 
+This module provides the required feature for all my osu! related modules, which is the beatmap parser.
+
+# Specific Requirements
+
+If you want to retrieve a beatmap using osu! API, you need to have an osu! API key set as `OSU_API_KEY` environment variable.
+
+See usage for more details.
+
+# Installation
+
+```
+npm i @rian8337/osu-base
 ```
-const osuBase = require('osu-base');
 
-// TODO: DEMONSTRATE API
+or
+
+```
+yarn add @rian8337/osu-base
+```
+
+# Usage
+
+## Using osu! API
+
+```js
+import { MapInfo } from "@rian8337/osu-base";
+
+// MD5 hash is also supported, but when both options are specified, beatmap ID is used
+const beatmapInfo = await MapInfo.getInformation({
+    beatmapID: 901854,
+    hash: "hash123",
+    file: true,
+});
+
+if (!beatmapInfo.title) {
+    return console.log("Beatmap not found");
+}
+
+// Parsed beatmap can be accessed via the `map` field
+// Note that the parsed beatmap will be cloned every time this is called. This allows caching of the original instance when needed
+console.log(beatmapInfo.map);
+```
+
+### Not retrieving beatmap file
+
+You can also opt out from downloading the beatmap (`.osu`) file if you just want to retrieve information from the API by setting `file` to `false`, however a parsed beatmap will not be provided.
+
+## Using without osu! API
+
+```js
+import { readFile } from "fs";
+import { Parser } from "@rian8337/osu-base";
+
+readFile("path/to/file.osu", { encoding: "utf-8" }, (err, data) => {
+    if (err) throw err;
+
+    const parser = new Parser().parse(data);
+
+    // Parsed beatmap can be accessed via the `map` field
+    console.log(parser.map);
+});
 ```

package/dist/utils/MapStats.js

@@ -192,13 +192,8 @@ class MapStats {
      * @param statisticsMultiplier The statistics multiplier to calculate from map-changing nonspeed-changing mods.
      */
     static modifyOD(baseOD, speedMultiplier, statisticsMultiplier) {
-        let od = baseOD;
-        od *= statisticsMultiplier;
-        let odMS = this.OD0_MS - Math.ceil(this.OD_MS_STEP * od);
-        odMS = Math.min(this.OD0_MS, Math.max(this.OD10_MS, odMS));
-        odMS /= speedMultiplier;
-        od = (this.OD0_MS - odMS) / this.OD_MS_STEP;
-        return od;
+        const hitWindowGreat = new HitWindow_1.OsuHitWindow(Math.min(10, baseOD * statisticsMultiplier)).hitWindowFor300() / speedMultiplier;
+        return (this.OD0_MS - hitWindowGreat) / this.OD_MS_STEP;
     }
 }
 exports.MapStats = MapStats;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rian8337/osu-base",
-  "version": "1.0.0",
+  "version": "1.0.5",
   "description": "Base module for all osu! related modules.",
   "keywords": [
     "osu",
@@ -17,6 +17,8 @@
   ],
   "scripts": {
     "build": "tsc",
+    "generate-docs": "typedoc src/index.ts",
+    "lint": "eslint --ext ts",
     "prepare": "npm run build",
     "test": "jest -i"
   },
@@ -39,5 +41,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e4fdb9c1ed6f90e70651c1aedfdb964b61cb240d"
+  "gitHead": "c8c092485a5ae3be16f2bfa0a3defb00163918d7"
 }

package/typings/index.d.ts

@@ -141,9 +141,9 @@ declare module "@rian8337/osu-base" {
         get maxCombo(): number;
         /**
          * Returns a time combined with beatmap-wide time offset.
-         * 
+         *
          * BeatmapVersion 4 and lower had an incorrect offset. Stable has this set as 24ms off.
-         * 
+         *
          * @param time The time.
          */
         getOffsetTime(time: number): number;
@@ -165,7 +165,10 @@ declare module "@rian8337/osu-base" {
          * @param time The time.
          * @param list The timing points to search in.
          */
-        private getTimingPoint<T extends TimingPoint>(time: number, list: T[]): T;
+        private getTimingPoint<T extends TimingPoint>(
+            time: number,
+            list: T[]
+        ): T;
         /**
          * Returns a string representative of the class.
          */
@@ -265,7 +268,7 @@ declare module "@rian8337/osu-base" {
     /**
      * Represents the headcircle of a slider (sliderhead).
      */
-    export class HeadCircle extends Circle { }
+    export class HeadCircle extends Circle {}
 
     /**
      * Represents a hitobject in a beatmap.
@@ -643,7 +646,7 @@ declare module "@rian8337/osu-base" {
         });
         /**
          * Calculates map statistics.
-         * 
+         *
          * This can only be called once for an instance.
          */
         calculate(params?: {
@@ -1564,7 +1567,7 @@ declare module "@rian8337/osu-base" {
     /**
      * Represents the tailcircle of a slider (sliderend).
      */
-    export class TailCircle extends Circle { }
+    export class TailCircle extends Circle {}
 
     /**
      * Represents a timing point that changes the beatmap's BPM.
@@ -1882,7 +1885,7 @@ declare module "@rian8337/osu-base" {
         buildURL(): string;
         /**
          * Sends a request to the API using built parameters.
-         * 
+         *
          * If the request fails, it will be redone 5 times.
          */
         sendRequest(): Promise<RequestResponse>;