sonolus-voez-engine 1.4.0 → 1.5.0

package/LICENSE.txt

@@ -1,21 +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
+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

@@ -1,85 +1,74 @@
-# Sonolus VOEZ Engine
-
-A recreation of VOEZ engine in [Sonolus](https://sonolus.com).
-
-## Links
-
--   [Sonolus Website](https://sonolus.com)
--   [Sonolus Wiki](https://github.com/NonSpicyBurrito/sonolus-wiki)
-
-## Installation
-
-```
-npm install sonolus-voez-engine
-```
-
-## Custom Resources
-
-### Skin Sprites
-
-| Name                           |
-| ------------------------------ |
-| `VOEZ Track Body 0`            |
-| `VOEZ Track Body 1`            |
-| `VOEZ Track Body 2`            |
-| `VOEZ Track Body 3`            |
-| `VOEZ Track Body 4`            |
-| `VOEZ Track Body 5`            |
-| `VOEZ Track Body 6`            |
-| `VOEZ Track Body 7`            |
-| `VOEZ Track Body 8`            |
-| `VOEZ Track Body 9`            |
-| `VOEZ Track Line`              |
-| `VOEZ Track Left Border`       |
-| `VOEZ Track Right Border`      |
-| `VOEZ Track Glow Body`         |
-| `VOEZ Track Glow Left Border`  |
-| `VOEZ Track Glow Right Border` |
-| `VOEZ Flick`                   |
-
-## Documentation
-
-### `version`
-
-Package version.
-
-### `databaseEngineItem`
-
-Partial database engine item compatible with [sonolus-express](https://github.com/NonSpicyBurrito/sonolus-express).
-
-### `engineConfigurationPath`
-
-Path to Engine Configuration file.
-
-### `enginePlayDataPath`
-
-Path to Engine Play Data file.
-
-### `engineWatchDataPath`
-
-Path to Engine Watch Data file.
-
-### `enginePreviewDataPath`
-
-Path to Engine Preview Data file.
-
-### `engineTutorialDataPath`
-
-Path to Engine Tutorial Data file.
-
-### `engineThumbnailPath`
-
-Path to Engine Thumbnail file.
-
-### `vsToVC(vs)`
-
-Converts VS (VOEZ Source) to VC (VOEZ Chart).
-
--   `vs`: VOEZ source.
-
-### `vcToLevelData(vc, offset?)`
-
-Converts VC (VOEZ Chart) to Level Data.
-
--   `vc`: VOEZ chart.
--   `offset`: offset (default: `0`).
+# Sonolus VOEZ Engine
+
+A recreation of VOEZ engine in [Sonolus](https://sonolus.com).
+
+## Links
+
+- [Sonolus Website](https://sonolus.com)
+- [Sonolus Wiki](https://github.com/NonSpicyBurrito/sonolus-wiki)
+
+## Installation
+
+```
+npm install sonolus-voez-engine
+```
+
+## Custom Resources
+
+### Skin Sprites
+
+| Name                           |
+| ------------------------------ |
+| `VOEZ Track Body 0`            |
+| `VOEZ Track Body 1`            |
+| `VOEZ Track Body 2`            |
+| `VOEZ Track Body 3`            |
+| `VOEZ Track Body 4`            |
+| `VOEZ Track Body 5`            |
+| `VOEZ Track Body 6`            |
+| `VOEZ Track Body 7`            |
+| `VOEZ Track Body 8`            |
+| `VOEZ Track Body 9`            |
+| `VOEZ Track Line`              |
+| `VOEZ Track Left Border`       |
+| `VOEZ Track Right Border`      |
+| `VOEZ Track Glow Body`         |
+| `VOEZ Track Glow Left Border`  |
+| `VOEZ Track Glow Right Border` |
+| `VOEZ Flick`                   |
+
+## Documentation
+
+### `version`
+
+Package version.
+
+### `databaseEngineItem`
+
+Partial database engine item compatible with [sonolus-express](https://github.com/NonSpicyBurrito/sonolus-express).
+
+### `vsToVC(vs)`
+
+Converts VS (VOEZ Source) to VC (VOEZ Chart).
+
+- `vs`: VOEZ source.
+
+### `vcToLevelData(vc, offset?)`
+
+Converts VC (VOEZ Chart) to Level Data.
+
+- `vc`: VOEZ chart.
+- `offset`: offset (default: `0`).
+
+### Assets
+
+The following assets are exposed as package entry points:
+
+- `EngineConfiguration`
+- `EnginePlayData`
+- `EngineWatchData`
+- `EnginePreviewData`
+- `EngineTutorialData`
+- `EngineThumbnail`
+
+In Node.js, you can obtain path to assets using `require.resolve('sonolus-voez-engine/EngineConfiguration')` or `import.meta.resolve('sonolus-voez-engine/EngineConfiguration')`.

package/dist/index.cjs

@@ -14,15 +14,14 @@ 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.engineThumbnailPath = exports.engineTutorialDataPath = exports.enginePreviewDataPath = exports.engineWatchDataPath = exports.enginePlayDataPath = exports.engineConfigurationPath = exports.databaseEngineItem = exports.version = exports.vsToVC = exports.vcToLevelData = void 0;
-const node_path_1 = require("node:path");
+exports.databaseEngineItem = exports.version = exports.vsToVC = exports.vcToLevelData = void 0;
 var convert_cjs_1 = require("./vc/convert.cjs");
 Object.defineProperty(exports, "vcToLevelData", { enumerable: true, get: function () { return convert_cjs_1.vcToLevelData; } });
 __exportStar(require("./vc/index.cjs"), exports);
 var convert_cjs_2 = require("./vs/convert.cjs");
 Object.defineProperty(exports, "vsToVC", { enumerable: true, get: function () { return convert_cjs_2.vsToVC; } });
 __exportStar(require("./vs/index.cjs"), exports);
-exports.version = '1.4.0';
+exports.version = '1.5.0';
 exports.databaseEngineItem = {
     name: 'voez',
     version: 12,
@@ -47,9 +46,3 @@ exports.databaseEngineItem = {
         ].join('\n'),
     },
 };
-exports.engineConfigurationPath = (0, node_path_1.resolve)(__dirname, 'EngineConfiguration');
-exports.enginePlayDataPath = (0, node_path_1.resolve)(__dirname, 'EnginePlayData');
-exports.engineWatchDataPath = (0, node_path_1.resolve)(__dirname, 'EngineWatchData');
-exports.enginePreviewDataPath = (0, node_path_1.resolve)(__dirname, 'EnginePreviewData');
-exports.engineTutorialDataPath = (0, node_path_1.resolve)(__dirname, 'EngineTutorialData');
-exports.engineThumbnailPath = (0, node_path_1.resolve)(__dirname, 'thumbnail.png');

package/dist/index.d.cts

@@ -2,7 +2,7 @@ export { vcToLevelData } from './vc/convert.cjs';
 export * from './vc/index.cjs';
 export { vsToVC } from './vs/convert.cjs';
 export * from './vs/index.cjs';
-export declare const version = "1.4.0";
+export declare const version = "1.5.0";
 export declare const databaseEngineItem: {
     readonly name: "voez";
     readonly version: 12;
@@ -19,9 +19,3 @@ export declare const databaseEngineItem: {
         readonly en: string;
     };
 };
-export declare const engineConfigurationPath: string;
-export declare const enginePlayDataPath: string;
-export declare const engineWatchDataPath: string;
-export declare const enginePreviewDataPath: string;
-export declare const engineTutorialDataPath: string;
-export declare const engineThumbnailPath: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sonolus-voez-engine",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "A recreation of VOEZ engine in Sonolus",
   "author": "NonSpicyBurrito",
   "repository": "github:NonSpicyBurrito/sonolus-voez-engine",
@@ -8,30 +8,41 @@
   "keywords": [
     "Sonolus"
   ],
-  "main": "dist/index.cjs",
   "files": [
     "dist"
   ],
+  "exports": {
+    ".": "./dist/index.cjs",
+    "./EngineConfiguration": "./dist/EngineConfiguration",
+    "./EnginePlayData": "./dist/EnginePlayData",
+    "./EngineWatchData": "./dist/EngineWatchData",
+    "./EnginePreviewData": "./dist/EnginePreviewData",
+    "./EngineTutorialData": "./dist/EngineTutorialData",
+    "./EngineThumbnail": "./dist/thumbnail.png"
+  },
   "scripts": {
     "dev:play": "sonolus-cli --dev ./play",
     "dev:watch": "sonolus-cli --dev ./watch",
     "dev:preview": "sonolus-cli --dev ./preview",
     "dev:tutorial": "sonolus-cli --dev ./tutorial",
-    "prebuild": "tsc -p ./lib --noEmit && tsc -p ./shared --noEmit && tsc -p ./play --noEmit && tsc -p ./watch --noEmit && tsc -p ./preview --noEmit && tsc -p ./tutorial --noEmit && eslint . && prettier . --check",
+    "check-type": "tsc -p ./lib --noEmit && tsc -p ./shared --noEmit && tsc -p ./play --noEmit && tsc -p ./watch --noEmit && tsc -p ./preview --noEmit && tsc -p ./tutorial --noEmit",
+    "check-lint": "eslint .",
+    "check-format": "prettier . --check",
     "build": "tsc -p ./lib && sonolus-cli --build ./play && sonolus-cli --build ./watch && sonolus-cli --build ./preview && sonolus-cli --build ./tutorial && node ./lib/build.mjs"
   },
   "dependencies": {
-    "@sonolus/core": "~7.5.0"
+    "@sonolus/core": "~7.9.3"
   },
   "devDependencies": {
-    "@sonolus/sonolus.js": "~9.4.0",
-    "@types/node": "^16.18.68",
-    "@typescript-eslint/eslint-plugin": "^6.14.0",
-    "@typescript-eslint/parser": "^6.14.0",
-    "eslint": "^8.55.0",
+    "@eslint/js": "^9.16.0",
+    "@sonolus/sonolus.js": "~9.5.1",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^20.17.9",
+    "eslint": "^9.16.0",
     "eslint-config-prettier": "^9.1.0",
-    "prettier": "^3.1.1",
-    "prettier-plugin-organize-imports": "^3.2.4",
-    "typescript": "~5.3.3"
+    "prettier": "^3.4.1",
+    "prettier-plugin-organize-imports": "^4.1.0",
+    "typescript": "~5.7.2",
+    "typescript-eslint": "^8.16.0"
   }
 }