Documentation / tutorials for JavaScript runtime?

TheMug

Hello,

I'm new to spine and want to learn how to use it with JavaScript. However, I can't seem to find any documentation or information on using the JS runtime files.

Can someone point me in the right direction, or is it just a matter of looking at the source code in the github examples and "figuring it out"??? :wonder:

TheMug

Mario

The spine-ts runtime works like all the other runtimes. As such, you can find the general runtimes documentation here Spine Runtime Documentation. This will explain the general concepts and APIs.

For spine-ts specifics, the README in the repository the examples demonstrate how to set things up. Plus you can always ask here!

TheMug

So in other words, it is basically a matter of looking at the source code in the github examples and "figuring it out"?

The README file only instructs how to setup the project and display a "spine widget" in a div element, nothing more. It doesn't provide API documentation. I want to be able to import spine assets into a HTML5 WebGL canvas.

It's really pretty poor documentation. One shouldn't be expected to search through code examples and try and apply it to a "general API" that's written in a different language.

Mario

You are right, and we'll be reworking the runtime specifics docs throughout the coming months. Sorry for the inconvenience.

TheMug

Thats okay, thanks for the quick response. 🙂

I don't mind that much "figuring it out", I just didn't want to go to that effort if there was better documentation that I was missing.

Thanks for your help.

stephensaw

I'm just started with Spine, and I'm integrating it with my existing game, while using the spine-canvas.js runtime, but is there a better documentation somewhere that explain how to use it, for example, setting position on runtime, add or remove the animation on runtime etc, I have spent some times trying out in debugger, it would be nice if I have something to refer to instead figuring out in debugger.

Thanks.

Mario

The general Spine Runtimes documentation applies to the TypeScript/JavaScript runtime and should give you all the API info you need for your tasks at hand: Spine: Runtime Documentation

That said, we are working on language specific documentation, however that will take a bit to be completed.

djmisterjon

you have very little spine js doc here.
https://github.com/pixijs/pixi-spine/blob/master/examples/index.md

but true, we need a full docs for each language.
I also want a full docs for js.