@galacean/effects-plugin-spine 0.0.0-experimental-downgrade624-20240904

package/LICENSE

@@ -0,0 +1,22 @@
+MIT LICENSE
+
+Copyright (c) 2019-present Ant Group Co., Ltd. https://www.antgroup.com/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,116 @@
+# Galacean Effects Spine Plugin
+
+## Usage
+
+### Simple Import
+
+``` ts
+import { Player } from '@galacean/effects';
+import '@galacean/effects-plugin-spine';
+```
+
+### Get Spine Resource List
+
+``` ts
+import type { SpineResource } from '@galacean/effects-plugin-spine';
+
+const comp = await player.play(scene);
+const spineData: SpineResource[] = comp.loaderData.spineDatas;
+```
+
+### Get Animation List / Skin List
+
+1. Get using functions
+
+``` ts
+const comp = await new Player().loadScene(scene);
+const item = comp.getItemByName(name)
+const { skeletonData } = item.spineDataCache;
+const animationList = getAnimationList(skeletonData);
+const skinList = getSkinList(skeletonData);
+```
+
+2. Get from the `spineDatas` array
+
+``` ts
+const comp = await new Player().loadScene(scene);
+const { skinList, animationList } = comp.loaderData.spineDatas[index];
+```
+
+### Get Duration of a Specific Animation
+
+``` ts
+const animationDuration = getAnimationDuration(skeletonData, animationName);
+```
+
+### Get Texture Creation Options
+``` ts
+import { getTextureOptions } from '@galacean/effects-plugin-spine';
+
+const { magFilter, minFilter, wrapS, wrapT, pma } = getTextureOptions(atlasBuffer);
+```
+
+### Set Animation Mix Duration
+
+1. Set default mix duration for an animation (should be called before `player.play`)
+
+``` ts
+const comp = await new Player().loadScene(scene);
+const item = comp.getItemByName(name);
+
+item.setDefaultMixDuration(mix);
+```
+
+2. Set mix duration for a specific transition (should be called before `player.play`)
+
+``` ts
+const comp = await new Player().loadScene(scene);
+const item = comp.getItemByName(name);
+
+item.setMixDuration(animationOut, animationIn, mix);
+```
+
+### Set Playback Speed
+
+``` ts
+const comp = await new Player().loadScene(scene);
+const item = comp.getItemByName(name);
+
+item.setSpeed(speed);
+```
+
+### Set Animation
+
+1. Set a single animation
+
+``` ts
+const comp = await new Player().loadScene(scene);
+const item = comp.getItemByName(name);
+
+item.setAnimation(animationName, speed);
+```
+
+2. Set a group of animations
+
+``` ts
+const comp = await new Player().loadScene(scene);
+const item = comp.getItemByName(name);
+const animationList = [animationName1, animationName2, animationName3];
+
+item.setAnimation(animationList, speed);
+```
+
+## Development
+
+### Getting Started
+
+``` bash
+# demo
+pnpm --filter @galacean/effects-plugin-spine dev
+```
+
+> Open in browser: http://localhost:8081/demo/
+
+## Frame Comparison Testing
+
+> Open in browser: http://localhost:8081/test/