sonolus-bandori-engine 1.0.0 → 1.0.2

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 NonSpicyBurrito
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# Sonolus Bandori Engine
+
+A recreation of BanG Dream! Girls Band Party engine in [Sonolus](https://sonolus.com).
+
+## Links
+
+-   [Sonolus Website](https://sonolus.com)
+-   [Sonolus Wiki](https://github.com/NonSpicyBurrito/sonolus-wiki)
+
+## Installation
+
+```
+npm install sonolus-bandori-engine
+```
+
+## Custom Resources
+
+### Skin Sprites
+
+| Name                                     | Bandori Asset Path                                    |
+| ---------------------------------------- | ----------------------------------------------------- |
+| `Bandori Stage`                          | `/ingameskin/fieldskin/{name}/bg_line_rhythm`         |
+| `Bandori Judgment Line`                  | `/ingameskin/fieldskin/{name}/game_play_line`         |
+| `Bandori Directional Flick Note Left`    | `/ingameskin/noteskin/{name}/DirectionalFlickSprites` |
+| `Bandori Directional Flick Note Right`   | `/ingameskin/noteskin/{name}/DirectionalFlickSprites` |
+| `Bandori Directional Flick Marker Left`  | `/ingameskin/noteskin/{name}/DirectionalFlickSprites` |
+| `Bandori Directional Flick Marker Right` | `/ingameskin/noteskin/{name}/DirectionalFlickSprites` |
+
+### Effect Clips
+
+| Name                               | Bandori Asset Path                         |
+| ---------------------------------- | ------------------------------------------ |
+| `Bandori Directional Flick Single` | `/sound/tapseskin/{name}/directional_fl`   |
+| `Bandori Directional Flick Double` | `/sound/tapseskin/{name}/directional_fl_2` |
+| `Bandori Directional Flick Triple` | `/sound/tapseskin/{name}/directional_fl_3` |
+
+### Particle Effects
+
+| Name                                       |
+| ------------------------------------------ |
+| `Bandori Circular Directional Flick Left`  |
+| `Bandori Linear Directional Flick Left`    |
+| `Bandori Circular Directional Flick Right` |
+| `Bandori Linear Directional Flick Right`   |
+
+## Documentation
+
+### `version`
+
+Package version.
+
+### `engineInfo`
+
+Partial engine information compatible with [sonolus-express](https://github.com/NonSpicyBurrito/sonolus-express).
+
+### `engineConfiguration`
+
+Engine Configuration.
+
+-   `engineConfiguration.path`: path to file.
+-   `engineConfiguration.buffer`: buffer of file.
+-   `engineConfiguration.hash`: hash of file.
+
+### `engineData`
+
+Engine Data.
+
+-   `engineData.path`: path to file.
+-   `engineData.buffer`: buffer of file.
+-   `engineData.hash`: hash of file.
+
+### `engineThumbnail`
+
+Engine Thumbnail.
+
+-   `engineThumbnail.path`: path to file.
+-   `engineThumbnail.buffer`: buffer of file.
+-   `engineThumbnail.hash`: hash of file.
+
+### `bestdoriToLevelData(chart, offset?)`
+
+Converts Bestdori chart to Level Data.
+
+-   `chart`: Bestdori chart.
+-   `offset`: offset (default: `0`).

package/dist/bestdori/convert.cjs

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bestdoriToLevelData = void 0;
 const sonolus_core_1 = require("sonolus-core");
-function bestdoriToLevelData(chart, bgmOffset = 0) {
+function bestdoriToLevelData(chart, offset = 0) {
     const entities = [];
     const beatToIntermediates = new Map();
     const intermediateToRef = new Map();
@@ -88,7 +88,7 @@ function bestdoriToLevelData(chart, bgmOffset = 0) {
         }
     }
     return {
-        bgmOffset,
+        bgmOffset: offset,
         entities,
     };
 }

package/dist/bestdori/convert.d.cts

@@ -1,3 +1,3 @@
 import { LevelData } from 'sonolus-core';
 import { BestdoriChart } from './index.cjs';
-export declare function bestdoriToLevelData(chart: BestdoriChart, bgmOffset?: number): LevelData;
+export declare function bestdoriToLevelData(chart: BestdoriChart, offset?: number): LevelData;

package/dist/index.cjs

@@ -4,7 +4,7 @@ exports.engineThumbnail = exports.engineData = exports.engineConfiguration = exp
 const Resource_cjs_1 = require("./Resource.cjs");
 var convert_cjs_1 = require("./bestdori/convert.cjs");
 Object.defineProperty(exports, "bestdoriToLevelData", { enumerable: true, get: function () { return convert_cjs_1.bestdoriToLevelData; } });
-exports.version = '1.0.0';
+exports.version = '1.0.2';
 exports.engineInfo = {
     name: 'bandori',
     version: 8,

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { Resource } from './Resource.cjs';
 export { bestdoriToLevelData } from './bestdori/convert.cjs';
-export declare const version = "1.0.0";
+export declare const version = "1.0.2";
 export declare const engineInfo: {
     readonly name: "bandori";
     readonly version: 8;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sonolus-bandori-engine",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A recreation of BanG Dream! Girls Band Party engine in Sonolus",
   "author": "NonSpicyBurrito",
   "repository": "github:NonSpicyBurrito/sonolus-bandori-engine",