@rel-packages/osu-beatmap-preview 0.9.0 → 0.11.0

package/README.md

@@ -7,8 +7,9 @@ created to be used on [osu-stuff](https://github.com/mezleca/osu-stuff)
 
 - preview for standard and mania modes
 - basic configurable skin (colors, animations, toggles)
-- canvas backend (not the most performant due to the nature of canvas)
+- pixi/webgl renderer backend
 - beatmap parser (.osu, .osz files)
+- hitsounds resolved from mapset/skin files (no bundled default hitsound pack)
 
 ## supported mods
 
@@ -26,23 +27,29 @@ created to be used on [osu-stuff](https://github.com/mezleca/osu-stuff)
 import { BeatmapPlayer, get_available_mods } from "osu-beatmap-preview";
 
 const player = new BeatmapPlayer({ canvas });
-await player.load(oszFile);
+await player.load_osz(oszFile);
 player.play();
 
 // get mods for current gamemode
 const mods = get_available_mods("standard");
 ```
 
-## skin config
+## skin loading
 
 ```typescript
-player.set_skin({
-    combo_colors: ["255,0,0", "0,255,0"],
-    enable_slider_ball: false,
-    enable_hit_animations: true,
-    follow_circle_color: "#ff8800",
-    ...
-});
+// load external skin archive (.osk)
+await player.load_skin_osk(osk_arr_buffer);
+
+// or load extracted files
+await player.load_skin_files(
+    new Map<string, ArrayBuffer | string>([
+        ["skin.ini", text],
+        ["hitcircle.png", hitcirclebytes]
+    ])
+);
+
+// reset to bundled default-skin
+player.clear_loaded_skin();
 ```
 
 ## events
@@ -53,3 +60,11 @@ player.on("pause", () => console.log("paused"));
 player.on("seek", (time) => console.log("seeked to", time));
 player.on("timeupdate", (time, duration) => {});
 ```
+
+## assets
+
+- default skin assets are a mixture of elements from [owc remake](https://skins.osuck.net/skins/3301) and the default skin from osu! stable (mostly hitsounds)
+
+```
+
+```

package/dist/assets/.gitkeep

@@ -0,0 +1 @@
+

package/dist/assets/assets.d.ts

@@ -0,0 +1,4 @@
+export declare const get_default_skin_folder_manifest_url: () => string;
+export declare const resolve_default_skin_folder_asset_url: (relative_path: string) => string;
+export declare const resolve_runtime_asset_url: (relative_path: string) => string;
+//# sourceMappingURL=assets.d.ts.map

package/dist/assets/assets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../src/assets/assets.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,oCAAoC,QAAO,MAEvD,CAAC;AAEF,eAAO,MAAM,qCAAqC,GAAI,eAAe,MAAM,KAAG,MAE7E,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAAI,eAAe,MAAM,KAAG,MAEjE,CAAC"}

package/dist/assets/default-skin/manifest.json

@@ -0,0 +1,108 @@
+[
+  "approachcircle.png",
+  "approachcircle@2x.png",
+  "default-0.png",
+  "default-0@2x.png",
+  "default-1.png",
+  "default-1@2x.png",
+  "default-2.png",
+  "default-2@2x.png",
+  "default-3.png",
+  "default-3@2x.png",
+  "default-4.png",
+  "default-4@2x.png",
+  "default-5.png",
+  "default-5@2x.png",
+  "default-6.png",
+  "default-6@2x.png",
+  "default-7.png",
+  "default-7@2x.png",
+  "default-8.png",
+  "default-8@2x.png",
+  "default-9.png",
+  "default-9@2x.png",
+  "drum-hitclap.ogg",
+  "drum-hitfinish.ogg",
+  "drum-hitnormal.ogg",
+  "drum-hitwhistle.ogg",
+  "drum-sliderslide.ogg",
+  "drum-slidertick.ogg",
+  "drum-sliderwhistle.ogg",
+  "followpoint-0.png",
+  "followpoint-0@2x.png",
+  "followpoint-1.png",
+  "followpoint-1@2x.png",
+  "followpoint-2.png",
+  "followpoint-2@2x.png",
+  "followpoint-3.png",
+  "followpoint-3@2x.png",
+  "followpoint-4.png",
+  "followpoint-4@2x.png",
+  "followpoint-5.png",
+  "followpoint-5@2x.png",
+  "followpoint-6.png",
+  "followpoint-6@2x.png",
+  "followpoint-7.png",
+  "followpoint-7@2x.png",
+  "followpoint.png",
+  "followpoint@2x.png",
+  "hitcircleoverlay.png",
+  "hitcircleoverlay@2x.png",
+  "mania-key1@2x.png",
+  "mania-key1D@2x.png",
+  "mania-key2@2x.png",
+  "mania-key2D@2x.png",
+  "mania-keyS@2x.png",
+  "mania-keySD@2x.png",
+  "mania-note1@2x.png",
+  "mania-note1H@2x.png",
+  "mania-note1L-0@2x.png",
+  "mania-note1L-1@2x.png",
+  "mania-note1L-2@2x.png",
+  "mania-note1L-3@2x.png",
+  "mania-note1L-4@2x.png",
+  "mania-note1L-5@2x.png",
+  "mania-note2@2x.png",
+  "mania-note2H@2x.png",
+  "mania-note2L-0@2x.png",
+  "mania-note2L-1@2x.png",
+  "mania-note2L-2@2x.png",
+  "mania-note2L-3@2x.png",
+  "mania-note2L-4@2x.png",
+  "mania-note2L-5@2x.png",
+  "mania-noteS@2x.png",
+  "mania-noteSH@2x.png",
+  "mania-noteSL-0@2x.png",
+  "mania-noteSL-1@2x.png",
+  "mania-noteSL-2@2x.png",
+  "mania-noteSL-3@2x.png",
+  "mania-noteSL-4@2x.png",
+  "mania-noteSL-5@2x.png",
+  "mania-stage-hint@2x.png",
+  "mania-stage-left@2x.png",
+  "mania-stage-light@2x.png",
+  "mania-stage-right@2x.png",
+  "normal-hitclap.ogg",
+  "normal-hitfinish.ogg",
+  "normal-hitnormal.ogg",
+  "normal-hitwhistle.ogg",
+  "normal-sliderslide.ogg",
+  "normal-slidertick.ogg",
+  "normal-sliderwhistle.ogg",
+  "reversearrow.png",
+  "reversearrow@2x.png",
+  "skin.ini",
+  "sliderb0.png",
+  "sliderb0@2x.png",
+  "sliderendcircle.png",
+  "sliderfollowcircle.png",
+  "sliderfollowcircle@2x.png",
+  "soft-hitclap.ogg",
+  "soft-hitfinish.ogg",
+  "soft-hitnormal.ogg",
+  "soft-hitwhistle.ogg",
+  "soft-sliderslide.ogg",
+  "soft-slidertick.ogg",
+  "soft-sliderwhistle.ogg",
+  "spinnerbonus.ogg"
+]

package/dist/assets/default-skin/skin.ini

@@ -0,0 +1,33 @@
+// Ini parser v0.2.9 // cyperdark#6890 // https://github.com/cyperdark/ck-tools
+
+
+[General]
+    Name: owc Skin Remake
+    Author: R1gel
+    Version: latest
+
+// -=- Cursor
+    CursorCentre: 1
+    CursorExpand: 1
+    CursorRotate: 0
+
+// -=- Slider
+    AllowSliderBallTint: 0
+
+
+[Colours]
+// -=- Song Select
+    SongSelectActiveText: 255,255,255
+
+
+[Fonts]
+// -=- Circle Font
+    HitCirclePrefix: default
+    HitCircleOverlap: 170
+
+// -=- Score Font
+    ScorePrefix: score
+    ScoreOverlap: 0
+
+
+[Mania]

package/dist/beatmap/timing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"timing.d.ts","sourceRoot":"","sources":["../../src/beatmap/timing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,eAAO,MAAM,qBAAqB,GAAI,QAAQ,YAAY,EAAE,KAAG,YAAY,EAU1E,CAAC"}
+{"version":3,"file":"timing.d.ts","sourceRoot":"","sources":["../../src/beatmap/timing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,eAAO,MAAM,qBAAqB,GAAI,QAAQ,YAAY,EAAE,KAAG,YAAY,EAwB1E,CAAC"}

package/dist/config/standard.d.ts

@@ -0,0 +1,21 @@
+export declare const STANDARD_RUNTIME_DEFAULTS: {
+    readonly precompute: {
+        readonly lookback_ms: 1500;
+        readonly lookahead_ms: 8000;
+        readonly frame_budget_ms: 0.35;
+        readonly bootstrap_budget_ms: 12;
+        readonly bootstrap_total_ms: 120;
+    };
+    readonly slider_cache: {
+        readonly max_entries: 72;
+        readonly max_bytes: number;
+        readonly retention_ms: 14000;
+        readonly trim_interval_ms: 250;
+    };
+    readonly stack: {
+        readonly default_leniency: 0.7;
+        readonly distance: 3;
+        readonly offset_multiplier: 6.4;
+    };
+};
+//# sourceMappingURL=standard.d.ts.map

package/dist/config/standard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../../src/config/standard.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;CAmB5B,CAAC"}

package/dist/index.d.ts

@@ -9,9 +9,10 @@ export * from "./types/result";
 export { type ISkinConfig, DEFAULT_SKIN, merge_skin, get_combo_color, get_mania_lane_color } from "./skin/skin_config";
 export * from "./mods";
 export { type IRenderBackend } from "./renderer/backend/render_backend";
-export { CanvasBackend } from "./renderer/backend/canvas_backend";
+export { PixiBackend } from "./renderer/backend/pixi_backend";
+export { create_backend, type BackendType } from "./renderer/backend/backend_factory";
 export { BaseRenderer, type IRendererConfig, DEFAULT_RENDERER_CONFIG, GridLevel, PLAYFIELD_WIDTH, PLAYFIELD_HEIGHT } from "./renderer/base_renderer";
 export { StandardRenderer } from "./renderer/standard/standard_renderer";
 export { ManiaRenderer } from "./renderer/mania/mania_renderer";
-export { load_font } from "./fonts";
+export { get_default_skin_folder_manifest_url, resolve_runtime_asset_url } from "./assets/assets";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACrF,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAE,SAAS,EAAE,KAAK,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxE,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAG/B,OAAO,EAAE,KAAK,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAGvH,cAAc,QAAQ,CAAC;AAGvB,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,KAAK,eAAe,EAAE,uBAAuB,EAAE,SAAS,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACrJ,OAAO,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAGhE,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACrF,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAE,SAAS,EAAE,KAAK,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExE,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAE/B,OAAO,EAAE,KAAK,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAEvH,cAAc,QAAQ,CAAC;AAEvB,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,KAAK,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,KAAK,eAAe,EAAE,uBAAuB,EAAE,SAAS,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACrJ,OAAO,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEhE,OAAO,EAAE,oCAAoC,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC"}