[ts][player] Updated docs.

spine-ts/README.md

@@ -7,7 +7,7 @@ up into multiple modules:
 1. **WebGL**: `webgl/`, a self-contained WebGL backend, build on the core classes
 1. **Canvas**: `canvas/`, a self-contained Canvas backend, build on the core classes
 1. **THREE.JS**: `threejs/`, a self-contained THREE.JS backend, build on the core classes
-1. **Widget**: `widget/`, a self-contained widget to easily display Spine animations on your website, build on core classes & WebGL backend.
+1. **Player**: `player/`, a self-contained player to easily display Spine animations on your website, build on core classes & WebGL backend.
 
 While the source code for the core library and backends is written in TypeScript, all code is compiled to easily consumable JavaScript.
 
@@ -20,7 +20,7 @@ The Spine Runtimes are developed with the intent to be used with data exported f
 
 spine-ts works with data exported from Spine 3.6.xx.
 
-spine-ts WebGL & Widget backends supports all Spine features.
+spine-ts WebGL & players backends supports all Spine features.
 
 spine-ts Canvas does not support color tinting, mesh attachments and clipping. Only the alpha channel from tint colors is applied. Experimental support for mesh attachments can be enabled by setting `spine.canvas.SkeletonRenderer.useTriangleRendering` to true. Note that this method is slow and may lead to artifacts on some browsers.
 
@@ -31,10 +31,10 @@ spine-ts does not yet support loading the binary format.
 ## Usage
 1. Download the Spine Runtimes source using [git](https://help.github.com/articles/set-up-git) or by downloading it as a zip via the download button above.
 2. To use only the core library without rendering support, include the `build/spine-core.js` file in your project.
-3. To use the WebGL backend, include the `spine-webgl.js` file in your project.
-3. To use the Canvas backend, include the `spine-canvas.js` file in your project.
-4. To use the Widget, include `spine-widget.js` file in your project.
-5. To use the THREE.JS backend, include the `spine-threejs.js` file in your project. THREE.JS must be loaded first.
+3. To use the WebGL backend, include the `build/spine-webgl.js` file in your project.
+3. To use the Canvas backend, include the `build/spine-canvas.js` file in your project.
+4. To use the Player, include `build/spine-player.js` and `player/css/spine-player.css` file in your project.
+5. To use the THREE.JS backend, include the `build/spine-threejs.js` file in your project. THREE.JS must be loaded first.
 
 All `*.js` files are self-contained and include both the core and respective backend classes.
 
@@ -60,7 +60,7 @@ cd spine-ts
 python -m SimpleHTTPServer
 ```
 
-Then open `http://localhost:8000/webgl/example`, `http://localhost:8000/canvas/example`, `https://localhost:8000/threejs/example` or `http://localhost:8000/widget/example` in your browser.
+Then open `http://localhost:8000/webgl/example`, `http://localhost:8000/canvas/example`, `https://localhost:8000/threejs/example` or `http://localhost:8000/player/example` in your browser.
 
 ## WebGL Demos
 The spine-ts WebGL demos load their image, atlas, and JSON files from our webserver and so can be run directly, without needing a webserver. The demos can be viewed [all on one page](http://esotericsoftware.com/spine-demos/) or in individual, standalone pages which are easy for you to explore and edit. See the [standalone demos source code](webgl/demos) and view the pages here:
@@ -92,7 +92,7 @@ setup a development environment, follow these steps.
   * **WebGL**: `tsc -w -p tsconfig.webgl.json`, builds `core/src` and `webgl/src`, outputs `build/spine-webgl.js|d.ts|js.map`
   * **Canvas**: `tsc -w -p tsconfig.canvas.json`, builds `core/src` and `canvas/src`, outputs `build/spine-canvas.js|d.ts|js.map`
   * **THREE.JS**: `tsc -w -p tsconfig.threejs.json`, builds `core/src` and `threejs/src`, outputs `build/spine-threejs.js|d.ts|js.map`
-  * **Widget**: `tsc -w -p tsconfig.widget.json`, builds `core/src` and `widget/src`, outputs `build/spine-widget.js|d.ts|js.map`
+  * **Player**: `tsc -w -p tsconfig.player.json`, builds `core/src` and `player/src`, outputs `build/spine-player.js|d.ts|js.map`
 6. Open the `spine-ts` folder in Visual Studio Code. VS Code will use the `tsconfig.json` file all source files from core and all
 backends for your development pleasure. The actual JavaScript output is still created by the command line TypeScript compiler process from the previous step.
 
@@ -104,7 +104,7 @@ cd spine-ts
 python -m SimpleHTTPServer
 ```
 
-Then navigate to `http://localhost:8000/webgl/example`, `http://localhost:8000/canvas/example`, `http://localhost:8000/threejs/example` or `http://localhost:8000/widget/example`
+Then navigate to `http://localhost:8000/webgl/example`, `http://localhost:8000/canvas/example`, `http://localhost:8000/threejs/example` or `http://localhost:8000/player/example`
 
 ### Spine-ts WebGL backend
 By default, the spine-ts WebGL backend supports two-color tinting. This has a neglible effect on performance, as more per vertex data has to be submitted to the GPU, and the fragment shader has to do a few more arithmetic operations.
@@ -124,98 +124,5 @@ var skeletonRenderer = new spine.SkeletonRenderer(gl, false);
 var shader = Shader.newColoredTextured();
 ```
 
-### Using the Widget
-To easily display Spine animations on your website, you can use the spine-ts Widget backend.
-
-1. Export your Spine animation with a texture atlas and put the resulting `.json`, `.atlas` and `.png` files on your server.
-2. Copy the `build/spine-widget.js` file to your server and include it on your website `<script src="spine-widget.js"></script>`, adjusting the src to match the location of the file on your server.
-3. Add HTML elements, e.g. a `<div>`, with the class `spine-widget` to your website, specifying its configuration such as the location of the files, the animation to display, etc.
-
-You can configure a HTML element either directly via HTML, or using JavaScript. At a minimum, you need to specify the location of the
-`.json` and `.atlas` file as well as the name of the animation to play back.
-
-#### HTML configuration
-To specify the configuration of a Spine Widget via HTML, you can use these HTML element attributes:
-
-  * `data-json`: required, path to the `.json` file, absolute or relative, e.g. "assets/animation.json"
-  * `data-atlas`: required, path to the `.atlas` file, absolute or relative, e.g. "assets/animation.atlas"
-  * `data-animation`: required, the name of the animation to play back
-  * `data-images-path`: optional, the location of images on the server to load atlas pages from. If omitted, atlas `.png` page files are loaded relative to the `.atlas` file.
-  * `data-skin`: optional, the name of the skin to use. Defaults to `default` if omitted.
-  * `data-loop`: optional, whether to loop the animation or not. Defaults to `true` if omitted.
-  * `data-scale`: optional, the scaling factor to apply when loading the `.json` file. Defaults to `1` if omitted. Irrelevant if `data-fit-to-canvas` is `true`.
-  * `data-x`: optional, the x-coordinate to display the animation at. The origin is in the bottom left corner. Defaults to `0` if omitted. Irrelevant if `data-fit-to-canvas` is `true`.
-  * `data-y`: optional, the y-coordinate to display the animation at. The origin is in the bottom left corner with the y-axis pointing upwards. Defaults to `0` if omitted. Irrelevant if `data-fit-to-canvas` is `true`.
-  * `data-fit-to-canvas`: optional, whether to fit the animation to the canvas size or not. Defaults to `true` if omitted, in which case `data-scale`, `data-x` and `data-y` are irrelevant. This setting calculates the setup pose bounding box using the specified skin to center and scale the animation on the canvas.
-  * `data-background-color`: optional, the background color to use. Defaults to `#000000` if omitted.
-  * `data-premultiplied-alpha`: optional, whether the atlas pages use premultiplied alpha or not. Defaults to `false` if omitted.
-  * `data-debug`: optional, whether to show debug information such as bones, attachments, etc. Defaults to `false` if omitted.
-
-You can specify these as attribuets on the HTML element like this:
-
-```html
-<div class="spine-widget" data-json="assets/animation.json" data-atlas="assets/animation.atlas" data-animation="walk"></div>
-```
-
-All HTML elements with class `spine-widget` will be automatically loaded when the website is finished loading by the browser. To add
-widgets dynamically, use the JavaScript configuration described below.
-
-#### JavaScript configuration
-You can dynamically add Spine Widgets to your web page by using the JavaScript API.
-
-Create a HTML element on your website, either statically or via JavaScript:
-
-```html
-<div id="my-widget"></div>
-```
-
-Then create a new `spine.SpineWidget`, providing a [`SpineWidgetConfiguration`](widget/src/Widget.ts#L281) object, e.g.:
-
-```JavaScript
-new spine.SpineWidget("my-widget", {
-	json: "assets/spineboy.json",
-	atlas: "assets/spineboy.atlas",
-	animation: "run",
-	backgroundColor: "#000000",
-	success: function (widget) {
-		var animIndex = 0;
-		widget.canvas.onclick = function () {
-			animIndex++;
-			let animations = widget.skeleton.data.animations;
-			if (animIndex >= animations.length) animIndex = 0;
-			widget.setAnimation(animations[animIndex].name);
-		}
-	}
-});
-```
-
-The configuration object has the following fields:
-
-  * `json`: required, path to the `.json` file, absolute or relative, e.g. "assets/animation.json"
-  * `jsonContent`: optional, string or JSON object holding the content of a skeleton `.json` file. Overrides `json` if given.
-  * `atlas`: required, path to the `.atlas` file, absolute or relative, e.g. "assets/animation.atlas"
-  * `atlasContent`: optional, string holding the content of an .atlas file. Overrides `atlas` if given.
-  * `animation`: required, the name of the animation to play back
-  * `imagesPath`: optional, the location of images on the server to load atlas pages from. If omitted, atlas `.png` page files are loaded relative to the `.atlas` file.
-  * `atlasPages`: optional, the list of atlas page images, e.g. `atlasPages: ["assets/page1.png", "assets/page2.png"]` when using code, or `data-atlas-pages="assets/page1.png,assets/page2.png"` on case of HTML instantiation. Use this if you have a multi-page atlas. If ommited, only one atlas page image is loaded based on the atlas file name, replacing `.atlas` with `.png`.
-  * `atlasPagesContent`: optional, the list of atlas page images as data URIs. If given, `atlasPages` must also be given.
-  * `skin`: optional, the name of the skin to use. Defaults to `default` if omitted.
-  * `loop`: optional, whether to loop the animation or not. Defaults to `true` if omitted.
-  * `scale`: optional, the scaling factor to apply when loading the `.json` file. Defaults to `1` if omitted. Irrelevant if `data-fit-to-canavs` is `true`.
-  * `x`: optional, the x-coordinate to display the animation at. The origin is in the bottom left corner. Defaults to `0` if omitted. Irrelevant if `data-fit-to-canvas` is `true`.
-  * `y`: optional, the y-coordinate to display the animation at. The origin is in the bottom left corner with the y-axis pointing upwards. Defaults to `0` if omitted. Irrelevant if `data-fit-to-canvas` is `true`.
-  * `fitToCanvas`: optional, whether to fit the animation to the canvas size or not. Defaults to `true` if omitted, in which case `data-scale`, `data-x` and `data-y` are irrelevant. This setting calculates the setup pose bounding box using the specified skin to center and scale the animation on the canvas.
-  * `alpha`: optional, whether to allow the canvas to be transparent. Defaults to `true`. Set the alpha channel in ``backgroundColor` to 0 as well, e.g. `#00000000`.
-  * `backgroundColor`: optional, the background color to use. Defaults to `#000000` if omitted.
-  * `premultipliedAlpha`: optional, whether the atlas pages use premultiplied alpha or not. Defaults to `false` if omitted.
-  * `debug`: optional, whether to show debug information such as bones, attachments, etc. Defaults to `false` if omitted.
-  * `success`: optional, a callback taking a `SpineWidget` called when the animation has been loaded successfully
-  * `error`: optional, a callback taking a `SpineWidget` and an error string called when the animation couldn't be loaded
-
-You can also create a HTML element with class `spine-widget` and `data-` attributes as described above and call `spine.widget.SpineWidget.loadWidget(element)` to load
-an element via JavaScript on demand.
-
-The resulting `SpineWidget` has various fields that let you modify the animation programmatically. Most notably, the `skeleton` and `state` fields
-let you modify all aspects of your animation as you wish. See the [example](widget/example/index.html#L21).
-
-You can also modify what debug information is shown by accessing `SpineWidget.debugRenderer` and set the various `drawXXX` fields to `true` or `false`.
+### Using the Player
+Please see the documentation for the [Spine Web Player](https://esotericsoftware.com/spine-player)