diff --git a/spine-ts/README.md b/spine-ts/README.md index a2f4f33d4..375533ca1 100644 --- a/spine-ts/README.md +++ b/spine-ts/README.md @@ -1,17 +1,19 @@ # spine-ts - - The spine-ts runtime provides functionality to load and manipulate [Spine](http://esotericsoftware.com) skeletal animation data using TypeScript and JavaScript. spine-ts is split up into multiple modules: -1. **Core**: `core/`, the core classes to load and process Spine skeletons. -1. **WebGL**: `webgl/`, a self-contained WebGL backend, built on the core classes. -1. **Canvas**: `canvas/`, a self-contained Canvas backend, built on the core classes. -1. **THREE.JS**: `threejs/`, a self-contained THREE.JS backend, built on the core classes. -1. **Player**: `player/`, a self-contained player to easily display Spine animations on your website, built on core the classes and WebGL backend. +1. `spine-core/`, the core classes to load and process Spine skeletons. +1. `spine-webgl/`, a self-contained WebGL backend, built on the core classes. +1. `spine-canvas/`, a self-contained Canvas backend, built on the core classes. +1. `spine-threejs/`, a self-contained THREE.JS backend, built on the core classes. +1. `spine-player/`, a self-contained player to easily display Spine animations on your website, built on core the classes and WebGL backend. -While the source code for the core library and backends is written in TypeScript, all code is compiled to JavaScript. +In most cases, the `spine-player` module is best suited for your needs. Please refer to the [Spine Web Player documentation](https://esotericsoftware.com/spine-player) for more information. + +For documentation of the core API in `spine-core`, please refer to our [Spine Runtimes Guide](http://esotericsoftware.com/spine-runtimes-guide). + +For module specific APIs in `spine-canvas`, `spine-webgl`, and `spine-threejs`, please refer to the [Examples](#examples) in the respecitve `spine-/example` folder. For `spine-webgl` specifically, we have provided additional [demos](spine-webgl/demos), which you can also [view online](http://de.esotericsoftware.com/spine-demos). ## Licensing @@ -35,111 +37,79 @@ spine-ts THREE.JS does not support two color tinting or blend modes. The THREE.J ## 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 `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 spine-ts modules are published to [npm](http://npmjs.com) for consumption via vanilla JavaScript as well as -All `*.js` files are self-contained and include both the core and respective backend classes. - -If you write your app with TypeScript, additionally copy the corresponding `build/spine-*.d.ts` file into your project. - -**Note:** If you are using the compiled `.js` files with ES6 or other module systems, you need to add: +## Usage in vanilla JavaScript +You can include a module in your project via a ` + + + \ No newline at end of file diff --git a/spine-ts/package.json b/spine-ts/package.json index c6f62f835..a939a4ce3 100644 --- a/spine-ts/package.json +++ b/spine-ts/package.json @@ -9,7 +9,7 @@ "prepublish": "npm run clean && npm run build", "clean": "npx rimraf spine-core/dist spine-canvas/dist spine-webgl/dist spine-player/dist spine-threejs/dist", "build": "npm run clean && npm run build:modules && concurrently \"npm run build:core\" \"npm run build:canvas\" \"npm run build:webgl\" \"npm run build:player\" \"npm run build:threejs\"", - "build:modules": "tsc -b -clean && tsc -b", + "build:modules": "npx tsc -b -clean && npx tsc -b", "build:core": "npx esbuild --bundle spine-core/src/index.ts --tsconfig=spine-core/tsconfig.json --sourcemap --outfile=spine-core/dist/iife/spine-core.js --format=iife --global-name=spine", "build:canvas": "npx esbuild --bundle spine-canvas/src/index.ts --tsconfig=spine-canvas/tsconfig.json --sourcemap --outfile=spine-canvas/dist/iife/spine-canvas.js --format=iife --global-name=spine", "build:webgl": "npx esbuild --bundle spine-webgl/src/index.ts --tsconfig=spine-webgl/tsconfig.json --sourcemap --outfile=spine-webgl/dist/iife/spine-webgl.js --format=iife --global-name=spine", diff --git a/spine-ts/spine-canvas/LICENSE b/spine-ts/spine-canvas/LICENSE new file mode 100644 index 000000000..4501a611f --- /dev/null +++ b/spine-ts/spine-canvas/LICENSE @@ -0,0 +1,26 @@ +Spine Runtimes License Agreement +Last updated May 1, 2019. Replaces all prior versions. + +Copyright (c) 2013-2019, Esoteric Software LLC + +Integration of the Spine Runtimes into software or otherwise creating +derivative works of the Spine Runtimes is permitted under the terms and +conditions of Section 2 of the Spine Editor License Agreement: +http://esotericsoftware.com/spine-editor-license + +Otherwise, it is permitted to integrate the Spine Runtimes into software +or otherwise create derivative works of the Spine Runtimes (collectively, +"Products"), provided that each user of the Products must obtain their own +Spine Editor license and redistribution of the Products in any form must +include this license and copyright notice. + +THIS SOFTWARE IS PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY EXPRESS +OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN +NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, BUSINESS +INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/spine-ts/spine-canvas/README.md b/spine-ts/spine-canvas/README.md new file mode 100644 index 000000000..41308ac8a --- /dev/null +++ b/spine-ts/spine-canvas/README.md @@ -0,0 +1,3 @@ +# spine-ts Canvas + +Please see https://github.com/EsotericSoftware/spine-runtimes/blob/4.0/spine-ts/README.md for more information. \ No newline at end of file diff --git a/spine-ts/spine-canvas/package.json b/spine-ts/spine-canvas/package.json index 8687b5d96..d7c4b38fe 100644 --- a/spine-ts/spine-canvas/package.json +++ b/spine-ts/spine-canvas/package.json @@ -6,8 +6,8 @@ "types": "dist/index.d.ts", "files": [ "dist/**/*", - "../README.md", - "../LICENSE" + "README.md", + "LICENSE" ], "scripts": {}, "repository": { @@ -32,4 +32,4 @@ "dependencies": { "@esotericsoftware/spine-core": "4.0.2" } -} +} \ No newline at end of file diff --git a/spine-ts/spine-core/LICENSE b/spine-ts/spine-core/LICENSE new file mode 100644 index 000000000..4501a611f --- /dev/null +++ b/spine-ts/spine-core/LICENSE @@ -0,0 +1,26 @@ +Spine Runtimes License Agreement +Last updated May 1, 2019. Replaces all prior versions. + +Copyright (c) 2013-2019, Esoteric Software LLC + +Integration of the Spine Runtimes into software or otherwise creating +derivative works of the Spine Runtimes is permitted under the terms and +conditions of Section 2 of the Spine Editor License Agreement: +http://esotericsoftware.com/spine-editor-license + +Otherwise, it is permitted to integrate the Spine Runtimes into software +or otherwise create derivative works of the Spine Runtimes (collectively, +"Products"), provided that each user of the Products must obtain their own +Spine Editor license and redistribution of the Products in any form must +include this license and copyright notice. + +THIS SOFTWARE IS PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY EXPRESS +OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN +NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, BUSINESS +INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/spine-ts/spine-core/README.md b/spine-ts/spine-core/README.md new file mode 100644 index 000000000..546b091f7 --- /dev/null +++ b/spine-ts/spine-core/README.md @@ -0,0 +1,3 @@ +# spine-ts core + +Please see https://github.com/EsotericSoftware/spine-runtimes/blob/4.0/spine-ts/README.md for more information. \ No newline at end of file diff --git a/spine-ts/spine-core/package.json b/spine-ts/spine-core/package.json index 194ef76b0..ab2d0a8c6 100644 --- a/spine-ts/spine-core/package.json +++ b/spine-ts/spine-core/package.json @@ -6,8 +6,8 @@ "types": "dist/index.d.ts", "files": [ "dist/**/*", - "../README.md", - "../LICENSE" + "README.md", + "LICENSE" ], "scripts": {}, "repository": { @@ -29,4 +29,4 @@ "url": "https://github.com/esotericsoftware/spine-runtimes/issues" }, "homepage": "https://github.com/esotericsoftware/spine-runtimes#readme" -} +} \ No newline at end of file diff --git a/spine-ts/spine-player/LICENSE b/spine-ts/spine-player/LICENSE new file mode 100644 index 000000000..4501a611f --- /dev/null +++ b/spine-ts/spine-player/LICENSE @@ -0,0 +1,26 @@ +Spine Runtimes License Agreement +Last updated May 1, 2019. Replaces all prior versions. + +Copyright (c) 2013-2019, Esoteric Software LLC + +Integration of the Spine Runtimes into software or otherwise creating +derivative works of the Spine Runtimes is permitted under the terms and +conditions of Section 2 of the Spine Editor License Agreement: +http://esotericsoftware.com/spine-editor-license + +Otherwise, it is permitted to integrate the Spine Runtimes into software +or otherwise create derivative works of the Spine Runtimes (collectively, +"Products"), provided that each user of the Products must obtain their own +Spine Editor license and redistribution of the Products in any form must +include this license and copyright notice. + +THIS SOFTWARE IS PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY EXPRESS +OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN +NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, BUSINESS +INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/spine-ts/spine-player/README.md b/spine-ts/spine-player/README.md new file mode 100644 index 000000000..5e8c3927e --- /dev/null +++ b/spine-ts/spine-player/README.md @@ -0,0 +1,3 @@ +# spine-ts Player + +Please see https://github.com/EsotericSoftware/spine-runtimes/blob/4.0/spine-ts/README.md for more information. \ No newline at end of file diff --git a/spine-ts/spine-player/package.json b/spine-ts/spine-player/package.json index 3059473e1..1551b554d 100644 --- a/spine-ts/spine-player/package.json +++ b/spine-ts/spine-player/package.json @@ -6,8 +6,8 @@ "types": "dist/index.d.ts", "files": [ "dist/**/*", - "../README.md", - "../LICENSE" + "README.md", + "LICENSE" ], "scripts": {}, "repository": { @@ -33,4 +33,4 @@ "@esotericsoftware/spine-core": "4.0.2", "@esotericsoftware/spine-webgl": "4.0.2" } -} +} \ No newline at end of file diff --git a/spine-ts/spine-threejs/LICENSE b/spine-ts/spine-threejs/LICENSE new file mode 100644 index 000000000..4501a611f --- /dev/null +++ b/spine-ts/spine-threejs/LICENSE @@ -0,0 +1,26 @@ +Spine Runtimes License Agreement +Last updated May 1, 2019. Replaces all prior versions. + +Copyright (c) 2013-2019, Esoteric Software LLC + +Integration of the Spine Runtimes into software or otherwise creating +derivative works of the Spine Runtimes is permitted under the terms and +conditions of Section 2 of the Spine Editor License Agreement: +http://esotericsoftware.com/spine-editor-license + +Otherwise, it is permitted to integrate the Spine Runtimes into software +or otherwise create derivative works of the Spine Runtimes (collectively, +"Products"), provided that each user of the Products must obtain their own +Spine Editor license and redistribution of the Products in any form must +include this license and copyright notice. + +THIS SOFTWARE IS PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY EXPRESS +OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN +NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, BUSINESS +INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/spine-ts/spine-threejs/README.md b/spine-ts/spine-threejs/README.md new file mode 100644 index 000000000..f4b475161 --- /dev/null +++ b/spine-ts/spine-threejs/README.md @@ -0,0 +1,3 @@ +# spine-ts THREE.JS + +Please see https://github.com/EsotericSoftware/spine-runtimes/blob/4.0/spine-ts/README.md for more information. \ No newline at end of file diff --git a/spine-ts/spine-threejs/package.json b/spine-ts/spine-threejs/package.json index 45860b667..082a22bb8 100644 --- a/spine-ts/spine-threejs/package.json +++ b/spine-ts/spine-threejs/package.json @@ -6,8 +6,8 @@ "types": "dist/index.d.ts", "files": [ "dist/**/*", - "../README.md", - "../LICENSE" + "README.md", + "LICENSE" ], "scripts": {}, "repository": { diff --git a/spine-ts/spine-ts.zip b/spine-ts/spine-ts.zip deleted file mode 100644 index d534af164..000000000 Binary files a/spine-ts/spine-ts.zip and /dev/null differ diff --git a/spine-ts/spine-webgl/LICENSE b/spine-ts/spine-webgl/LICENSE new file mode 100644 index 000000000..4501a611f --- /dev/null +++ b/spine-ts/spine-webgl/LICENSE @@ -0,0 +1,26 @@ +Spine Runtimes License Agreement +Last updated May 1, 2019. Replaces all prior versions. + +Copyright (c) 2013-2019, Esoteric Software LLC + +Integration of the Spine Runtimes into software or otherwise creating +derivative works of the Spine Runtimes is permitted under the terms and +conditions of Section 2 of the Spine Editor License Agreement: +http://esotericsoftware.com/spine-editor-license + +Otherwise, it is permitted to integrate the Spine Runtimes into software +or otherwise create derivative works of the Spine Runtimes (collectively, +"Products"), provided that each user of the Products must obtain their own +Spine Editor license and redistribution of the Products in any form must +include this license and copyright notice. + +THIS SOFTWARE IS PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY EXPRESS +OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN +NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, BUSINESS +INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/spine-ts/spine-webgl/README.md b/spine-ts/spine-webgl/README.md new file mode 100644 index 000000000..1fe077a66 --- /dev/null +++ b/spine-ts/spine-webgl/README.md @@ -0,0 +1,3 @@ +# spine-ts WebGL + +Please see https://github.com/EsotericSoftware/spine-runtimes/blob/4.0/spine-ts/README.md for more information. \ No newline at end of file diff --git a/spine-ts/spine-webgl/package.json b/spine-ts/spine-webgl/package.json index a58e65831..281975c18 100644 --- a/spine-ts/spine-webgl/package.json +++ b/spine-ts/spine-webgl/package.json @@ -6,8 +6,8 @@ "types": "dist/index.d.ts", "files": [ "dist/**/*", - "../README.md", - "../LICENSE" + "README.md", + "LICENSE" ], "scripts": {}, "repository": { @@ -32,4 +32,4 @@ "dependencies": { "@esotericsoftware/spine-core": "4.0.2" } -} +} \ No newline at end of file