sonolus-deemo-engine 1.0.0

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,61 @@
+# Sonolus Deemo Engine
+
+A recreation of Deemo engine in [Sonolus](https://sonolus.com).
+
+## Links
+
+-   [Sonolus Website](https://sonolus.com)
+-   [Sonolus Wiki](https://github.com/NonSpicyBurrito/sonolus-wiki)
+
+## Installation
+
+```
+npm install sonolus-deemo-engine
+```
+
+## 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.
+
+### `chartToDC(chart)`
+
+Converts Deemo source chart to DC (Deemo Chart).
+
+-   `chart`: Deemo source chart.
+
+### `dcToLevelData(dc, offset?)`
+
+Converts DC (Deemo Chart) to Level Data.
+
+-   `dc`: Deemo chart.
+-   `offset`: offset (default: `0`).

package/dist/Resource.cjs

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Resource = void 0;
+const node_crypto_1 = require("node:crypto");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+class Resource {
+    constructor(path) {
+        this.path = (0, node_path_1.resolve)(__dirname, path);
+    }
+    get hash() {
+        this._hash ??= (0, node_crypto_1.createHash)('sha1').update(this.buffer).digest('hex');
+        return this._hash;
+    }
+    get buffer() {
+        this._buffer ??= (0, node_fs_1.readFileSync)(this.path);
+        return this._buffer;
+    }
+}
+exports.Resource = Resource;

package/dist/Resource.d.cts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+export declare class Resource {
+    readonly path: string;
+    private _hash?;
+    private _buffer?;
+    constructor(path: string);
+    get hash(): string;
+    get buffer(): Buffer;
+}

package/dist/chart/convert.cjs

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chartToDC = void 0;
+const chartToDC = (chart) => {
+    const dc = [
+        {
+            type: 'bpm',
+            beat: 0,
+            bpm: 60,
+        },
+    ];
+    const slideIds = chart.links.flatMap((link) => link.notes.map((note) => note.$ref));
+    for (const note of chart.notes) {
+        if (note.pos > 2)
+            continue;
+        dc.push({
+            type: slideIds.includes(note.$id) ? 'slide' : 'tap',
+            beat: note.time,
+            lane: note.pos * 4,
+            size: note.size * 2,
+        });
+    }
+    return dc;
+};
+exports.chartToDC = chartToDC;

package/dist/chart/convert.d.cts

@@ -0,0 +1,3 @@
+import { DC } from '../dc/index.cjs';
+import { Chart } from './index.cjs';
+export declare const chartToDC: (chart: Chart) => DC;

package/dist/chart/index.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/chart/index.d.cts

@@ -0,0 +1,15 @@
+export type Chart = {
+    notes: Note[];
+    links: Link[];
+};
+export type Note = {
+    $id: string;
+    pos: number;
+    size: number;
+    time: number;
+};
+export type Link = {
+    notes: {
+        $ref: string;
+    }[];
+};

package/dist/dc/convert.cjs

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dcToLevelData = void 0;
+const sonolus_core_1 = require("sonolus-core");
+const dcToLevelData = (dc, offset = 0) => {
+    const entities = [
+        {
+            archetype: 'Initialization',
+            data: [],
+        },
+        {
+            archetype: 'InputManager',
+            data: [],
+        },
+        {
+            archetype: 'Stage',
+            data: [],
+        },
+    ];
+    for (const object of dc) {
+        const { archetype, data } = handlers[object.type](object);
+        entities.push({
+            archetype,
+            data: Object.entries(data).map(([name, value]) => ({ name, value })),
+        });
+    }
+    return {
+        bgmOffset: offset,
+        entities,
+    };
+};
+exports.dcToLevelData = dcToLevelData;
+const bpm = (object) => ({
+    archetype: sonolus_core_1.EngineArchetypeName.BpmChange,
+    data: {
+        [sonolus_core_1.EngineArchetypeDataName.Beat]: object.beat,
+        [sonolus_core_1.EngineArchetypeDataName.Bpm]: object.bpm,
+    },
+});
+const tap = (object) => ({
+    archetype: 'TapNote',
+    data: {
+        [sonolus_core_1.EngineArchetypeDataName.Beat]: object.beat,
+        lane: object.lane,
+        size: object.size,
+    },
+});
+const slide = (object) => ({
+    archetype: 'SlideNote',
+    data: {
+        [sonolus_core_1.EngineArchetypeDataName.Beat]: object.beat,
+        lane: object.lane,
+        size: object.size,
+    },
+});
+const handlers = {
+    bpm,
+    tap,
+    slide,
+};

package/dist/dc/convert.d.cts

@@ -0,0 +1,3 @@
+import { LevelData } from 'sonolus-core';
+import { DC } from './index.cjs';
+export declare const dcToLevelData: (dc: DC, offset?: number) => LevelData;

package/dist/dc/index.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/dc/index.d.cts

@@ -0,0 +1,20 @@
+export type DC = ChartObject[];
+export type ChartObject = BPMObject | TapNote | SlideNote;
+type ObjectBase = {
+    beat: number;
+};
+export type BPMObject = ObjectBase & {
+    type: 'bpm';
+    bpm: number;
+};
+type NoteBase = ObjectBase & {
+    lane: number;
+    size: number;
+};
+export type TapNote = NoteBase & {
+    type: 'tap';
+};
+export type SlideNote = NoteBase & {
+    type: 'slide';
+};
+export {};

package/dist/index.cjs

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.engineThumbnail = exports.engineData = exports.engineConfiguration = exports.engineInfo = exports.version = exports.dcToLevelData = exports.chartToDC = void 0;
+const Resource_cjs_1 = require("./Resource.cjs");
+var convert_cjs_1 = require("./chart/convert.cjs");
+Object.defineProperty(exports, "chartToDC", { enumerable: true, get: function () { return convert_cjs_1.chartToDC; } });
+var convert_cjs_2 = require("./dc/convert.cjs");
+Object.defineProperty(exports, "dcToLevelData", { enumerable: true, get: function () { return convert_cjs_2.dcToLevelData; } });
+exports.version = '1.0.0';
+exports.engineInfo = {
+    name: 'deemo',
+    version: 8,
+    title: {
+        en: 'Deemo',
+    },
+    subtitle: {
+        en: 'Deemo',
+    },
+    author: {
+        en: 'Burrito',
+    },
+    description: {
+        en: [
+            'A recreation of Deemo engine in Sonolus.',
+            '',
+            'Version:',
+            exports.version,
+            '',
+            'GitHub Repository:',
+            'https://github.com/NonSpicyBurrito/sonolus-deemo-engine',
+        ].join('\n'),
+    },
+};
+exports.engineConfiguration = new Resource_cjs_1.Resource('EngineConfiguration');
+exports.engineData = new Resource_cjs_1.Resource('EngineData');
+exports.engineThumbnail = new Resource_cjs_1.Resource('thumbnail.png');

package/dist/index.d.cts

@@ -0,0 +1,23 @@
+import { Resource } from './Resource.cjs';
+export { chartToDC } from './chart/convert.cjs';
+export { dcToLevelData } from './dc/convert.cjs';
+export declare const version = "1.0.0";
+export declare const engineInfo: {
+    readonly name: "deemo";
+    readonly version: 8;
+    readonly title: {
+        readonly en: "Deemo";
+    };
+    readonly subtitle: {
+        readonly en: "Deemo";
+    };
+    readonly author: {
+        readonly en: "Burrito";
+    };
+    readonly description: {
+        readonly en: string;
+    };
+};
+export declare const engineConfiguration: Resource;
+export declare const engineData: Resource;
+export declare const engineThumbnail: Resource;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "sonolus-deemo-engine",
+  "version": "1.0.0",
+  "description": "A recreation of Deemo engine in Sonolus",
+  "author": "NonSpicyBurrito",
+  "repository": "github:NonSpicyBurrito/sonolus-deemo-engine",
+  "license": "MIT",
+  "keywords": [
+    "Sonolus"
+  ],
+  "main": "dist/index.cjs",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "sonolus-cli --dev",
+    "prebuild": "tsc -p . --noEmit && eslint --ext .mts ./src && eslint --ext .cts ./lib",
+    "build": "tsc -p ./lib/tsconfig.json && sonolus-cli --build && node ./lib/build.mjs"
+  },
+  "devDependencies": {
+    "@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",
+    "sonolus.js": "~9.0.0",
+    "typescript": "~5.1.3"
+  }
+}