Package Exports

@melonjs/spine-plugin
@melonjs/spine-plugin/dist/@melonjs/spine-plugin.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@melonjs/spine-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

melonJS Spine Plugin

a Spine 4.1 plugin implementation for melonJS 2

melonjs-spine-gif

Note: although functional, this plugin is still a work in progress. Feedback and especially contributions are welcome!

Installation

this plugin is already bundled with the required Spine 4.x runtime, so there is no need to install it separately.

Note: this plugin requires melonJS version 15.10 or higher.

To install the plugin using npm :

$ [sudo] npm install @melonjs/spine-plugin

Then import and use the plugin in your project. For example:

import * as Spine from '@melonjs/spine-plugin';
import * as me from 'melonjs';

// 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"
    },
]

// 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 folder

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, but we can still also find the previous one here
Chat: come and chat with us on discord, or gitter
we tried to keep our wikipage up-to-date with useful links, tutorials, and anything related melonJS.