@melonjs/spine-plugin 1.3.0 → 1.5.0

package/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Changelog
 
-## 1.3.0 - 2023-08-28å
+## 1.5.0 - 2023-09-23
+
+- fix the `addAnimation()` method not returning the corresponding set TrackEntry
+- fix the base renderable `flip[X/Y]` method when used/applied to the Spine renderable
+- add a `isCurrentAnimation()` method that returns true if the given name is corresponding to the current track current animation
+- expose the `currentTrack` property to access the corresponding current animation track entry
+- clarify in the readme that the current plugin support both the 4.1 and 4.2-beta Spine runtime versions
+- the spine-plugin now requires to be properly registered using `me.plugin.register(SpinePlugin);`
+- the spine-plugin now requires melonJS v15.12.0 or higher
+- add check for minimum melonJS version when the plugin is registered
+- restructure code to adhere to the updated plugin API and get a proper reference to the melonjs renderer instance
+
+## 1.4.0 - 2023-09-05
+
+- add support for loading spine assets through the melonJS preloader (see README)
+- add inline documentation for the Spine class, properties and methods
+- console now display both the plugin and spine runtime versions
+
+## 1.3.0 - 2023-08-28
 
 - add support for Mesh Attachement
 - added more examples under the test folder and separated them into individual files

package/README.md

@@ -1,6 +1,6 @@
 # melonJS Spine Plugin
 
-a [Spine](http://en.esotericsoftware.com/spine-in-depth) 4.1 plugin implementation for [melonJS 2](http://www.melonjs.org)
+a [Spine](http://en.esotericsoftware.com/spine-in-depth) 4.x plugin implementation for [melonJS 2](http://www.melonjs.org)
 
 ![melonjs-spine-gif](https://github.com/melonjs/spine-plugin/assets/4033090/dc259c8e-def6-419e-83a9-cda374715686)
 
@@ -11,10 +11,10 @@ a [Spine](http://en.esotericsoftware.com/spine-in-depth) 4.1 plugin implementati
 [![jsDeliver](https://data.jsdelivr.com/v1/package/npm/@melonjs/spine-plugin/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@melonjs/spine-plugin)
 
 
-Installation
+## Installation
 -------------------------------------------------------------------------------
-this plugin is already bundled with the required Spine runtime, so there is no need to install it separately.
->Note: this plugin requires melonJS version 15.9.2 or higher.
+this plugin is already bundled with the required Spine [4.x runtime](package.json#dependencies), so there is no need to install it separately.
+>Note: this plugin requires melonJS version 15.12 or higher.
 
 To install the plugin using npm :
 
@@ -22,24 +22,59 @@ To install the plugin using npm :
 
 Then import and use the plugin in your project. For example:
 ```JavaScript
-import * as Spine from '@melonjs/spine-plugin';
-
-// load assets
-Spine.assetManager.setPrefix("data/spine/")
-Spine.assetManager.loadAsset("alien.atlas", "alien-ess.json");
-
-// create new Spine Renderable
-export default class AlienSpine extends Spine {
-    constructor(x, y, settings ){
-        super(x, y, settings);
-        ...
-    }
+import { SpinePlugin } from '@melonjs/spine-plugin';
+import * as me from 'melonjs';
+
+// register the plugin
+me.plugin.register(SpinePlugin);
+
+// prepare/declare assets for the preloader
+const DataManifest = [
+    {
+        "name": "alien-ess.json",
+        "type": "spine",
+        "src": "data/spine/alien-ess.json"
+    },
+    {
+        "name": "alien.atlas",
+        "type": "spine",
+        "src": "data/spine/alien.atlas"
+    },
+];
+
+// import default Spine class
+import Spine from '@melonjs/spine-plugin';
+
+// preload assets
+me.loader.preload(DataManifest, async function() {
+
+    // create a new Spine Renderable
+    let spineAlien = new Spine(100, 100, {atlasFile: "alien.atlas", jsonFile: "alien-ess.json"});
+
+    // set default animation
+    spineAlien.setAnimation(0, "death", true);
+
+    // add it to the game world
+    me.game.world.addChild(spineAlien);
+
 }
 ```
+>Note: use "spine" as a value for the `type` property to indicate which assets and are actual Spine assets and to be loaded using the plugin (requires version 1.4.0 or higher of the Spine plugin)
 
 for more details, see a complete usage example in the [test](test) folder
 
-Questions, need help ?
+## Compatibility
+-------------------------------------------------------------------------------
+
+below is the compatibility version matrix :
+
+| melonJS | @melonjs/spine-plugin | spine-runtime |
+|---|---|---|
+| v15.12.x (or higher) | v1.x | v4.1, v4.2-beta |
+
+>Note: the current version of the spine-plugin is bundled with the 4.2.x beta version of the Spine runtime, which is for now backward compatible with the Spine 4.1 runtime (from a player/rendering point of view). 
+
+## Questions, need help ?
 -------------------------------------------------------------------------------
 If you need technical support, you can contact us through the following channels :
 * Forums: with melonJS 2 we moved to a new discourse [forum](https://melonjs.discourse.group), but we can still also find the previous one [here](http://www.html5gamedevs.com/forum/32-melonjs/)