@theatrejs/plugin-ldtk 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-present Alexandre Blondeau (deformhead) deformhead@gmail.com
+
+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,33 @@
+[![Copyright](https://img.shields.io/badge/©-deformhead-white.svg)](https://github.com/deformhead) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/theatrejs/plugin-ldtk/blob/master/LICENSE) [![Bundle Size (Gzipped)](https://img.shields.io/bundlejs/size/@theatrejs/plugin-ldtk@latest)](https://www.npmjs.com/package/@theatrejs/plugin-ldtk/v/latest) [![NPM Version](https://img.shields.io/npm/v/@theatrejs/plugin-ldtk/latest)](https://www.npmjs.com/package/@theatrejs/plugin-ldtk/v/latest)
+
+# LDTK Plugin
+
+> *🛠️ A Plugin for LDTK JDON data.*
+
+## Installation
+
+```shell
+npm install @theatrejs/plugin-ldtk --save
+```
+
+## Quick Start
+
+```javascript
+import * as PLUGINLDTK from '@theatrejs/plugin-ldtk';
+
+import ldtkData from './ldtk.json';
+
+const ldtk = new PLUGINLDTK.Ldtk(ldtkData);
+
+const entities = ldtk.getEntities({
+    $level: 'Prototype',
+    $layer: 'actors'
+});
+
+const grid = ldtk.getGrid({
+    $level: 'Prototype',
+    $layer: 'grid'
+});
+```
+
+## [API](https://theatrejs.github.io/plugin-ldtk/index.html)

package/package.json

@@ -0,0 +1,58 @@
+{
+    "author": "Alexandre Blondeau",
+    "description": "🛠️ A Plugin for LDTK JDON data.",
+    "devDependencies": {
+
+        "docdash": "2.0.2",
+        "jsdoc": "4.0.3"
+    },
+    "engines": {
+
+        "node": "16.13.0",
+        "npm": "8.1.0"
+    },
+    "files": [
+
+        "sources/"
+    ],
+    "homepage": "https://github.com/theatrejs/plugin-ldtk",
+    "keywords": [
+
+        "2d",
+        "canvas",
+        "engine",
+        "game",
+        "game-engine",
+        "html",
+        "html5",
+        "javascript",
+        "ldtk",
+        "pixel-art",
+        "plugin",
+        "theatrejs",
+        "theatrejs-plugin",
+        "webgl",
+        "webgl2"
+    ],
+    "license": "MIT",
+    "main": "./sources/index.js",
+    "name": "@theatrejs/plugin-ldtk",
+    "peerDependencies": {
+
+        "@theatrejs/theatrejs": ">= 1.12.0"
+    },
+    "repository": {
+
+        "type": "git",
+        "url": "git+https://github.com/theatrejs/plugin-ldtk.git"
+    },
+    "scripts": {
+
+        "github-pages": "npm run github-pages:clean && npm run github-pages:generate ",
+        "github-pages:clean": "rm -rf ./docs/",
+        "github-pages:generate": "jsdoc ./tools/jsdoc/HOME.md ./sources/ --recurse --destination ./docs/ --template ./node_modules/docdash --configure ./tools/jsdoc/jsdoc.config.json",
+        "postversion": "node ./tools/custom/postversion.cjs"
+    },
+    "type": "module",
+    "version": "1.0.0"
+}

package/sources/index.js

@@ -0,0 +1 @@
+export {Ldtk} from './ldtk.js';

package/sources/ldtk.js

@@ -0,0 +1,293 @@
+import {Vector2} from '@theatrejs/theatrejs';
+
+/**
+ * Creates LDTK module managers.
+ *
+ * @example
+ *
+ * const ldtk = new Ldtk(data);
+ * ldtk.getEntities({$level, $layer});
+ */
+class Ldtk {
+
+    /**
+     * @typedef {Object} typeentity A transformed LDTK JSON entity.
+     * @property {string} typeentity.$identifier The identifier.
+     * @property {Vector2} typeentity.$position The position.
+     * @property {string} typeentity.$type The type.
+     * @protected
+     *
+     * @memberof Ldtk
+     */
+
+    /**
+     * @typedef {Object} typegrid A transformed LDTK JSON grid.
+     * @property {Vector2} typegrid.$cell The size of each cell.
+     * @property {Array<number>} typegrid.$data The flat data (one-dimensional).
+     * @property {Map<number, string>} typegrid.$definitions The data definitions.
+     * @property {number} typegrid.$height The number of cells on the y-axis.
+     * @property {Vector2} typegrid.$position The position.
+     * @property {number} typegrid.$width The number of cells on the x-axis.
+     * @protected
+     *
+     * @memberof Ldtk
+     */
+
+    /**
+     * @typedef {Object} typeldtkdefinitionlayergridvalue A LDTK JSON data layer grid value definition.
+     * @property {string} typeldtkdefinitionlayergridvalue.identifier The identifier.
+     * @property {number} typeldtkdefinitionlayergridvalue.value The value.
+     * @protected
+     *
+     * @memberof Ldtk
+     */
+
+    /**
+     * @typedef {Object} typeldtkdefinitionlayer A LDTK JSON data layer definition.
+     * @property {string} typeldtkdefinitionlayer.identifier The identifier.
+     * @property {Array<typeldtkdefinitionlayergridvalue>} typeldtkdefinitionlayer.intGridValues The grid values.
+     * @protected
+     *
+     * @memberof Ldtk
+     */
+
+    /**
+     * @typedef {Object} typeldtkdefinitions A LDTK JSON data definition.
+     * @property {Array<typeldtkdefinitionlayer>} typeldtkdefinitionlayer.layers The layers' definitions.
+     * @protected
+     *
+     * @memberof Ldtk
+     */
+
+    /**
+     * @typedef {Object} typeldtkentityfield A LDTK JSON data custom field.
+     * @property {string} typeldtkentityfield.__identifier The identifier.
+     * @property {string} typeldtkentityfield.__type The type.
+     * @property {any} typeldtkentityfield.__value The value.
+     * @protected
+     *
+     * @memberof Ldtk
+     */
+
+    /**
+     * @typedef {Object} typeldtkentity A LDTK JSON data entity.
+     * @property {string} typeldtkentity.__identifier The identifier.
+     * @property {Array<typeldtkentityfield>} typeldtkentity.fieldInstances The custom fields.
+     * @property {string} typeldtkentity.iid The iid.
+     * @property {Array<number>} typeldtkentity.px The position.
+     * @protected
+     *
+     * @memberof Ldtk
+     */
+
+    /**
+     * @typedef {Object} typeldtklayer A LDTK JSON data layer.
+     * @property {number} typeldtklayer.__cHei The number of grid cells on the x-axis.
+     * @property {number} typeldtklayer.__cWid The number of grid cells on the y-axis.
+     * @property {number} typeldtklayer.__gridSize The size of each cell.
+     * @property {string} typeldtklayer.__identifier The identifier.
+     * @property {Array<typeldtkentity>} typeldtklayer.entityInstances The entities.
+     * @property {Array<number>} typeldtklayer.intGridCsv The grid values.
+     * @protected
+     *
+     * @memberof Ldtk
+     */
+
+    /**
+     * @typedef {Object} typeldtklevel A LDTK JSON data level.
+     * @property {string} typeldtklevel.identifier The identifier.
+     * @property {Array<typeldtklayer>} typeldtklevel.layerInstances The layers.
+     * @property {number} typeldtklevel.pxHei The height.
+     * @property {number} typeldtklevel.pxWid The width.
+     * @protected
+     *
+     * @memberof Ldtk
+     */
+
+    /**
+     * @typedef {Object} typeldtk A LDTK JSON data.
+     * @property {typeldtkdefinitions} typeldtk.defs The definitions.
+     * @property {Array<typeldtklevel>} typeldtk.levels The delevs.
+     * @protected
+     *
+     * @memberof Ldtk
+     */
+
+    /**
+     * Stores the LDTK JSON data.
+     * @type {typeldtk}
+     * @private
+     */
+    $data;
+
+    /**
+     * Gets the LDTK JSON data.
+     * @type {typeldtk}
+     * @public
+     */
+    get data() {
+
+        return window.structuredClone(this.$data);
+    }
+
+    /**
+     * Creates a new LDTK module manager.
+     * @param {typeldtk} $data The LDTK JSON data.
+     */
+    constructor($data) {
+
+        this.$data = window.structuredClone($data);
+    }
+
+    /**
+     * Gets the entities from the given level on the given layer.
+     * @param {Object} $parameters The given parameters.
+     * @param {string} $parameters.$layer The layer of the entities to get.
+     * @param {string} $parameters.$level The level of the entities to get.
+     * @returns {Array<typeentity>}
+     * @public
+     */
+    getEntities({$layer, $level}) {
+
+        const level = this.$data.levels
+        .find(($current) => ($current.identifier === $level));
+
+        if (typeof level === 'undefined') {
+
+            return [];
+        }
+
+        const layer = level
+        .layerInstances.find(($current) => ($current.__identifier === $layer));
+
+        if (typeof layer === 'undefined') {
+
+            return [];
+        }
+
+        return layer
+        .entityInstances
+        .map(($entity) => ({
+
+            $identifier: $entity.iid,
+            $type: $entity.__identifier,
+            $position: new Vector2(
+
+                $entity.px[0] - (level.pxWid / 2),
+                - ($entity.px[1] - (level.pxHei / 2))
+            )
+        }));
+    }
+
+    /**
+     * Gets the LDTK JSON data entities from the given level on the given layer.
+     * @param {Object} $parameters The given parameters.
+     * @param {string} $parameters.$layer The layer of the entities to get.
+     * @param {string} $parameters.$level The level of the entities to get.
+     * @returns {Array<typeldtkentity>}
+     * @public
+     */
+    getEntitiesData({$layer, $level}) {
+
+        const level = this.$data.levels
+        .find(($current) => ($current.identifier === $level));
+
+        if (typeof level === 'undefined') {
+
+            return [];
+        }
+
+        const layer = level
+        .layerInstances.find(($current) => ($current.__identifier === $layer));
+
+        if (typeof layer === 'undefined') {
+
+            return [];
+        }
+
+        return layer
+        .entityInstances
+        .map(($entity) => (window.structuredClone($entity)));
+    }
+
+    /**
+     * Gets the grid from the given level on the given layer.
+     * @param {Object} $parameters The given parameters.
+     * @param {string} $parameters.$layer The layer of the grid to get.
+     * @param {string} $parameters.$level The level of the grid to get.
+     * @returns {(typegrid | undefined)}
+     * @public
+     */
+    getGrid({$layer, $level}) {
+
+        const level = this.$data.levels
+        .find(($current) => ($current.identifier === $level));
+
+        if (typeof level === 'undefined') {
+
+            return;
+        }
+
+        const layer = level
+        .layerInstances.find(($current) => ($current.__identifier === $layer));
+
+        if (typeof layer === 'undefined') {
+
+            return;
+        }
+
+        const definition = this.$data.defs.layers
+        .find(($current) => ($current.identifier === $layer));
+
+        if (typeof definition === 'undefined') {
+
+            return;
+        }
+
+        return {
+
+            $data: [...layer.intGridCsv],
+            $definitions: new Map(definition.intGridValues.map(($definition) => ([$definition.value, $definition.identifier]))),
+            $cell: new Vector2(layer.__gridSize, layer.__gridSize),
+            $width: layer.__cWid,
+            $height: layer.__cHei,
+            $position: new Vector2(level.pxWid / 2, level.pxHei / 2)
+        };
+    }
+
+    /**
+     * Gets the LDTK JSON data layer grid from the given level on the given layer.
+     * @param {Object} $parameters The given parameters.
+     * @param {string} $parameters.$layer The layer of the grid to get.
+     * @param {string} $parameters.$level The level of the grid to get.
+     * @returns {typeldtklayer}
+     * @public
+     */
+    getGridData({$layer, $level}) {
+
+        const level = this.$data.levels
+        .find(($current) => ($current.identifier === $level));
+
+        if (typeof level === 'undefined') {
+
+            return;
+        }
+
+        const layer = level
+        .layerInstances.find(($current) => ($current.__identifier === $layer));
+
+        if (typeof layer === 'undefined') {
+
+            return;
+        }
+
+        return window.structuredClone(layer);
+    }
+}
+
+export {
+
+    Ldtk
+};
+
+export default Ldtk;