sonolus-llsif-engine 1.0.0-beta.0 → 1.0.1

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,69 @@
+# Sonolus LLSIF Engine
+
+A recreation of Love Live! School idol festival engine in [Sonolus](https://sonolus.com).
+
+## Links
+
+-   [Sonolus Website](https://sonolus.com)
+-   [Sonolus Wiki](https://github.com/NonSpicyBurrito/sonolus-wiki)
+
+## Installation
+
+```
+npm install sonolus-llsif-engine
+```
+
+## Custom Resources
+
+### Skin Sprites
+
+| Name                      |
+| ------------------------- |
+| `LLSIF Connection Active` |
+
+## 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.
+
+### `nssToSIFC(nss)`
+
+Converts NSS (note setting asset) to SIFC (SIF Chart).
+
+-   `nss`: note setting asset.
+
+### `sifcToLevelData(chart, offset?)`
+
+Converts SIFC (SIF Chart) to Level Data.
+
+-   `chart`: SIF Chart.
+-   `offset`: offset (default: `0`).

package/dist/index.cjs

@@ -1,12 +1,28 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.engineThumbnail = exports.engineData = exports.engineConfiguration = exports.engineInfo = exports.version = exports.sifcToLevelData = exports.nssToSIFC = void 0;
 const Resource_cjs_1 = require("./Resource.cjs");
 var convert_cjs_1 = require("./nss/convert.cjs");
 Object.defineProperty(exports, "nssToSIFC", { enumerable: true, get: function () { return convert_cjs_1.nssToSIFC; } });
+__exportStar(require("./nss/index.cjs"), exports);
 var convert_cjs_2 = require("./sifc/convert.cjs");
 Object.defineProperty(exports, "sifcToLevelData", { enumerable: true, get: function () { return convert_cjs_2.sifcToLevelData; } });
-exports.version = '1.0.0-beta.0';
+__exportStar(require("./sifc/index.cjs"), exports);
+exports.version = '1.0.1';
 exports.engineInfo = {
     name: 'llsif',
     version: 8,

package/dist/index.d.cts

@@ -1,7 +1,9 @@
 import { Resource } from './Resource.cjs';
 export { nssToSIFC } from './nss/convert.cjs';
+export * from './nss/index.cjs';
 export { sifcToLevelData } from './sifc/convert.cjs';
-export declare const version = "1.0.0-beta.0";
+export * from './sifc/index.cjs';
+export declare const version = "1.0.1";
 export declare const engineInfo: {
     readonly name: "llsif";
     readonly version: 8;

package/dist/nss/convert.cjs

@@ -5,7 +5,7 @@ const index_cjs_1 = require("./index.cjs");
 const nssToSIFC = (nss) => {
     const objects = [
         {
-            type: 'BPM',
+            type: 'bpm',
             beat: 0,
             bpm: 60,
         },
@@ -15,18 +15,18 @@ const nssToSIFC = (nss) => {
         const beat = note.timing_sec;
         const lane = 5 - note.position;
         switch (note.effect) {
-            case index_cjs_1.NoteEffect.Tap1:
-            case index_cjs_1.NoteEffect.Tap2:
-            case index_cjs_1.NoteEffect.Tap4:
+            case index_cjs_1.NSSNoteEffect.Tap1:
+            case index_cjs_1.NSSNoteEffect.Tap2:
+            case index_cjs_1.NSSNoteEffect.Tap4:
                 objects.push({
-                    type: 'Tap',
+                    type: 'tap',
                     beat,
                     lane,
                 });
                 break;
-            case index_cjs_1.NoteEffect.TapHold:
+            case index_cjs_1.NSSNoteEffect.TapHold:
                 objects.push({
-                    type: 'Tap',
+                    type: 'tap',
                     beat,
                     lane,
                     hold: {
@@ -34,8 +34,8 @@ const nssToSIFC = (nss) => {
                     },
                 });
                 break;
-            case index_cjs_1.NoteEffect.Swing:
-            case index_cjs_1.NoteEffect.SwingHold: {
+            case index_cjs_1.NSSNoteEffect.Swing:
+            case index_cjs_1.NSSNoteEffect.SwingHold: {
                 const notes = swings.get(note.notes_level);
                 if (notes) {
                     notes.push(note);
@@ -62,9 +62,9 @@ const nssToSIFC = (nss) => {
                         ? 'Right'
                         : 'Left'
                     : 'Left';
-            if (note.effect === index_cjs_1.NoteEffect.Swing) {
+            if (note.effect === index_cjs_1.NSSNoteEffect.Swing) {
                 objects.push({
-                    type: 'Swing',
+                    type: 'swing',
                     beat,
                     lane,
                     direction,
@@ -72,7 +72,7 @@ const nssToSIFC = (nss) => {
             }
             else {
                 objects.push({
-                    type: 'Swing',
+                    type: 'swing',
                     beat,
                     lane,
                     direction,
@@ -85,7 +85,6 @@ const nssToSIFC = (nss) => {
     }
     return {
         attribute: nss[0].notes_attribute - 1,
-        offset: 0,
         objects,
     };
 };

package/dist/nss/convert.d.cts

@@ -1,3 +1,3 @@
-import { SIFChart } from '../sifc/index.cjs';
+import { SIFC } from '../sifc/index.cjs';
 import { NSS } from './index.cjs';
-export declare const nssToSIFC: (nss: NSS) => SIFChart;
+export declare const nssToSIFC: (nss: NSS) => SIFC;

package/dist/nss/index.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NoteEffect = void 0;
-exports.NoteEffect = {
+exports.NSSNoteEffect = void 0;
+exports.NSSNoteEffect = {
     Tap1: 1,
     Tap2: 2,
     Tap4: 4,

package/dist/nss/index.d.cts

@@ -1,5 +1,5 @@
-export type NSS = Note[];
-export declare const NoteEffect: {
+export type NSS = NSSNote[];
+export declare const NSSNoteEffect: {
     readonly Tap1: 1;
     readonly Tap2: 2;
     readonly Tap4: 4;
@@ -7,12 +7,12 @@ export declare const NoteEffect: {
     readonly Swing: 11;
     readonly SwingHold: 13;
 };
-export type NoteEffect = (typeof NoteEffect)[keyof typeof NoteEffect];
-export type Note = {
+export type NSSNoteEffect = (typeof NSSNoteEffect)[keyof typeof NSSNoteEffect];
+export type NSSNote = {
     timing_sec: number;
     position: number;
     notes_attribute: number;
     notes_level: number;
-    effect: NoteEffect;
+    effect: NSSNoteEffect;
     effect_value: number;
 };

package/dist/sifc/convert.cjs

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sifcToLevelData = void 0;
 const sonolus_core_1 = require("sonolus-core");
-function sifcToLevelData(chart) {
+function sifcToLevelData(chart, offset = 0) {
     const entities = [];
     const beatToIntermediates = new Map();
     const intermediateToRef = new Map();
@@ -90,7 +90,7 @@ function sifcToLevelData(chart) {
         }
     }
     return {
-        bgmOffset: chart.offset,
+        bgmOffset: offset,
         entities,
     };
 }
@@ -158,7 +158,7 @@ const hold = (head, beat, append) => {
     });
 };
 const handlers = {
-    BPM: bpm,
-    Tap: tap,
-    Swing: swing,
+    bpm,
+    tap,
+    swing,
 };

package/dist/sifc/convert.d.cts

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

package/dist/sifc/index.d.cts

@@ -1,25 +1,24 @@
-export type SIFChart = {
-    offset: number;
+export type SIFC = {
     attribute: number;
-    objects: ChartObject[];
+    objects: SIFCObject[];
 };
-export type ChartObject = BPMObject | TapNote | SwingNote;
-type ObjectBase = {
+export type SIFCObject = SIFCBPMChangeObject | SIFCTapNote | SIFCSwingNote;
+type BaseSIFCObject = {
     beat: number;
 };
-export type BPMObject = ObjectBase & {
-    type: 'BPM';
+export type SIFCBPMChangeObject = BaseSIFCObject & {
+    type: 'bpm';
     bpm: number;
 };
-type NoteBase = ObjectBase & {
+type BaseSIFCNote = BaseSIFCObject & {
     lane: number;
-    hold?: ObjectBase;
+    hold?: BaseSIFCObject;
 };
-export type TapNote = NoteBase & {
-    type: 'Tap';
+export type SIFCTapNote = BaseSIFCNote & {
+    type: 'tap';
 };
-export type SwingNote = NoteBase & {
-    type: 'Swing';
+export type SIFCSwingNote = BaseSIFCNote & {
+    type: 'swing';
     direction: 'Left' | 'Right';
 };
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sonolus-llsif-engine",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.1",
   "description": "A recreation of Love Live! School idol festival engine in Sonolus",
   "author": "NonSpicyBurrito",
   "repository": "github:NonSpicyBurrito/sonolus-llsif-engine",
@@ -18,16 +18,16 @@
     "build": "tsc -p ./lib/tsconfig.json && sonolus-cli --build && node ./lib/build.mjs"
   },
   "devDependencies": {
-    "@types/node": "^16.18.30",
-    "@typescript-eslint/eslint-plugin": "^5.59.1",
-    "@typescript-eslint/parser": "^5.59.1",
-    "eslint": "^8.39.0",
+    "@types/node": "^16.18.36",
+    "@typescript-eslint/eslint-plugin": "^5.59.11",
+    "@typescript-eslint/parser": "^5.59.11",
+    "eslint": "^8.42.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",
     "prettier": "^2.8.8",
     "prettier-plugin-organize-imports": "^3.2.2",
-    "sonolus-core": "~7.0.0-beta.0",
-    "sonolus.js": "~9.0.0-beta.0",
-    "typescript": "~5.0.4"
+    "sonolus-core": "~7.0.0",
+    "sonolus.js": "~9.0.0",
+    "typescript": "~5.1.3"
   }
 }