@theatrejs/loader-aseprite 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,81 @@
+[![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/loader-aseprite/blob/master/LICENSE) [![Bundle Size (Gzipped)](https://img.shields.io/bundlejs/size/@theatrejs/loader-aseprite@latest)](https://www.npmjs.com/package/@theatrejs/loader-aseprite/v/latest) [![NPM Version](https://img.shields.io/npm/v/@theatrejs/loader-aseprite/latest)](https://www.npmjs.com/package/@theatrejs/loader-aseprite/v/latest)
+
+# Aseprite Webpack Loader
+
+> *⚙️ A Webpack Loader for Aseprite files.*
+
+## Installation
+
+#### `dependencies`
+
+```shell
+npm install @theatrejs/plugin-aseprite --save
+```
+
+```shell
+npm install @theatrejs/loader-aseprite --save-dev
+```
+
+#### `webpack configuration`
+
+```javascript
+{
+    'module': {
+        'rules': [
+            ...
+            {
+                'test': /\.aseprite$/,
+                'use': [
+                    {
+                        'loader': '@theatrejs/loader-aseprite',
+                        'options': {
+                            'aseprite': <path-to-aseprite-executable>
+                        }
+                    }
+                ]
+            }
+            ...
+        ]
+    }
+}
+```
+
+## Quick Start
+
+> *⚠️ This example does not include the preloading of assets.*
+
+```javascript
+import {Actor} from '@theatrejs/theatrejs';
+
+import spritesheetHero from './hero-16x16.aseprite';
+
+class Hero extends Actor {
+    onCreate() {
+        this.$timeline = spritesheetHero.createTimeline({$actor: this, $framerate: 8, $loop: true, $tag: 'idle'});
+    }
+    onTick($timetick) {
+        this.$timeline.tick($timetick);
+    }
+}
+```
+
+## With Preloading
+
+```javascript
+import {FACTORIES} from '@theatrejs/theatrejs';
+
+import * as PLUGINASEPRITE from '@theatrejs/plugin-aseprite';
+
+import spritesheetHero from './hero-16x16.aseprite';
+
+class Hero extends FACTORIES.ActorWithPreloadables([PLUGINASEPRITE.FACTORIES.PreloadableAseprite(spritesheetHero)]) {
+    onCreate() {
+        this.$timeline = spritesheetHero.createTimeline({$actor: this, $framerate: 8, $loop: true, $tag: 'idle'});
+    }
+    onTick($timetick) {
+        this.$timeline.tick($timetick);
+    }
+}
+```
+
+## [API](https://theatrejs.github.io/loader-aseprite/index.html)

package/package.json

@@ -0,0 +1,44 @@
+{
+    "author": "Alexandre Blondeau",
+    "description": "⚙️ A Webpack Loader for Aseprite files.",
+    "engines": {
+        "node": "16.13.0",
+        "npm": "8.1.0"
+    },
+    "files": [
+        "sources/"
+    ],
+    "homepage": "https://github.com/theatrejs/loader-aseprite",
+    "keywords": [
+        "2d",
+        "aseprite",
+        "canvas",
+        "engine",
+        "game",
+        "game-engine",
+        "html",
+        "html5",
+        "javascript",
+        "pixel-art",
+        "loader",
+        "theatrejs",
+        "theatrejs-loader",
+        "webgl",
+        "webgl2",
+        "webpack",
+        "webpack-loader"
+    ],
+    "license": "MIT",
+    "main": "./sources/index.js",
+    "name": "@theatrejs/loader-aseprite",
+    "peerDependencies": {
+        "@theatrejs/plugin-aseprite": ">= 1.0.0",
+        "webpack": ">= 5.94.0"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/theatrejs/loader-aseprite.git"
+    },
+    "type": "commonjs",
+    "version": "1.0.0"
+}

package/sources/aseprite.loader.js

@@ -0,0 +1,83 @@
+const subprocess = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+const webpack = require('webpack');
+
+/**
+ * @type {webpack.RawLoaderDefinition}
+ */
+module.exports = function loader() {
+
+    /**
+     * @typedef {Object} typeoptions Options for the loader.
+     * @property {(string | undefined)} typeoptions.aseprite The path of the Aseprite executable.
+     * @private
+     */
+
+    const context = /** @type {webpack.LoaderContext<typeoptions>} */(this);
+
+    const file = context.resourcePath;
+    const options = context.getOptions();
+    const aseprite = options.aseprite;
+
+    try {
+
+        require.resolve('@theatrejs/plugin-aseprite');
+    }
+
+    catch (error) {
+
+        throw error;
+    }
+
+    if (typeof aseprite === 'undefined') {
+
+        throw new Error('Aseprite executable path is missing in the loader options.');
+    }
+
+    if (fs.existsSync(aseprite) === false) {
+
+        throw new Error('Aseprite executable not found reading path: ' + (typeof aseprite !== 'undefined' || aseprite !== '' ? '\'' + aseprite + '\'' : '<empty>') + '.');
+    }
+
+    const location = path.dirname(file);
+    const filename = path.basename(file, '.aseprite');
+    const png = filename + '.png';
+    const json = filename + '.json';
+
+    try {
+
+        subprocess.execSync(
+
+            'cd "' + location + '"' +
+
+            ' && "' + aseprite  + '"' +
+            ' --batch "' + file + '"' +
+            ' --sheet "' + png + '"' +
+            ' --sheet-type rows' +
+            ' --split-tags' +
+            ' --data "' + json + '"' +
+            ' --list-tags' +
+            ' --format json-array' +
+            ' --filename-format {tag}#{tagframe001}@{title}.{extension}'
+        );
+
+        return (
+
+            'import {Aseprite} from \'@theatrejs/plugin-aseprite\';' +
+
+            'import texture from \'./' + png + '\';' +
+            'import data from \'./' + json + '\';' +
+
+            'export default new Aseprite(texture, data);'
+        );
+    }
+
+    catch (error) {
+
+        throw error;
+    }
+};
+
+module.exports.raw = true;

package/sources/index.js

@@ -0,0 +1,3 @@
+const loader = require('./aseprite.loader.js');
+
+module.exports = loader;