@galacean/engine-spine 0.0.0-experimental-engine-spine-20240821 → 0.0.0-experimental-engine-spine-20241107

package/README.md

@@ -1,7 +1,6 @@
 
 
-# Galacean Engine spine runtime
-![Jun-12-2021 18-37-22.gif](https://gw.alipayobjects.com/mdn/mybank_yul/afts/img/A*am1ySYTDBQAAAAAAAAAAAAAAARQnAQ)
+# Galacean Engine Spine Runtime
 
 
 ![](https://img.shields.io/npm/v/@galacean/engine-spine#id=QfHW0&originHeight=20&originWidth=80&originalType=binary&ratio=1&status=done&style=none)
@@ -10,70 +9,95 @@
 
 ---
 
+[@galacean/engine-spine](https://www.npmjs.com/package/@galacean/engine-spine) is the Spine runtime module for the [Galacean engine](https://github.com/galacean/engine), providing efficient support for Spine animations. This package enables developers to seamlessly integrate and use Spine animations, delivering smooth skeletal animation effects optimized for both web and mobile platforms.
 
+##
+## Installation
 
-Spine runtime for [Galacean engine](https://github.com/galacean/engine).
-## 
-## Usage
+Install **@galacean/engine-spine** via npm:
 
-
-```typescript
-import { SpineAnimation } from '@galacean/engine-spine';
-
-// init oasis
-addSpine();
-
-async function addSpine() {
-	const spineEntity = await engine.resourceManager.load(
-    {
-      url: 'https://sbfkcel.github.io/pixi-spine-debug/assets/spine/spineboy-pro.json',
-      type: 'spine',
-    },
-  );
-  rootEntity.addChild(spineEntity);
-  const spineAnimation = spineEntity.getComponent(SpineAnimation);
-  spineAnimation.state.setAnimation(0, 'walk', true);
-}
+```bash
+npm install @galacean/engine-spine
 ```
 
 
-## npm
-```sh
-npm install @galacean/engine-spine
+## Quick Start
+
+Here's a simple example to get started with **@galacean/engine-spine**:
+
+```typescript
+import { SpineAnimationRenderer } from '@galacean/engine-spine';
+
+// First setup for galacean engine, get scene and create root entity.
+// Find setup code here:
+
+// And then load spine resource and instantiate a spine entity with the resource.
+const spineResource = await engine.resourceManager.load({
+  url: 'https://mdn.alipayobjects.com/huamei_kz4wfo/uri/file/as/2/kz4wfo/4/mp/yKbdfgijyLGzQDyQ/spineboy/spineboy.json',
+  type: 'spine',
+});
+const spineEntity = spineResource.instantiate();
+rootEntity.addChild(spineEntity);
 ```
 
+## API Documentation
 
+For a detailed overview of the API, including all classes, methods, and properties, please refer to the [Full API Documentation](https://galacean.antgroup.com/engine/en/docs/graphics/2D/spine/api/).
 
 
-## Version
-@galacean/engine-spine currently only supports spine version 3.8
+## Version Compatibility
 
+### Package and Spine Version Compatibility
 
-## Feature
+| Package Version | Spine Version         |
+|-----------------|-----------------------|
+| Below 4.0       | Spine 3.8             |
+| 4.0             | Spine 4.0             |
+| 4.1             | Spine 4.1             |
+| 4.2             | Spine 4.2             |
+| 4.x (e.g., 4.0, 4.1) | Corresponds to Spine x.x    |
+| 4.x.y (minor version `y`) | Independent from Spine |
 
-- Simple in usage
-- High performance.
-- Intergrated with galacean engine.
-- Component based API.
+> Note: Ensure that the package version aligns with the corresponding Spine editor version for compatibility.
 
+### Package and Galacean Engine Version Compatibility
 
+| Package Version | Galacean Engine Version |
+|-----------------|-------------------------|
+| 4.0 and above   | 1.3 and above           |
+| Below 4.0 (e.g., 1.2.0) | 1.2             |
 
-## Contributing
-Everyone is welcome to join us! Whether you find a bug, have a great feature request or you fancy owning a task from the road map feel free to get in touch.
-​
+> Note: Please verify that the versions of both the package and the Galacean Engine are compatible, as mismatched versions may cause unexpected issues.
 
-Make sure to read the [Contributing Guide](.github/HOW_TO_CONTRIBUTE.md) before submitting changes.
 
+## Building and Development
 
-## Links
+To set up the project for development and build it for production, follow these steps:
 
-- [Examples](https://oasisengine.cn/#/examples/latest/spine-animation)
-- [Documentation](https://oasisengine.cn/#/docs/latest/cn/spine)
-- [GalaceanEngine](https://oasisengine.cn/)
+1. **Install dependencies**:
+```bash
+npm install
+```
+2. **Start development environment**:
+```bash
+npm run dev
+```
+3. **Build for production**:
+```bash
+npm run build
+```
+4. **Run examples**:
+```bash
+npm run example
+```
 
 
 
-## License
+## Links
+- [Examples](https://galacean.antgroup.com/engine/en/docs/graphics/2D/spine/example/) - View usage examples for common scenarios.
+- [User Guide](https://galacean.antgroup.com/engine/en/docs/graphics/2D/spine/overview/) - Comprehensive guide for using this package within the Galacean editor and in scripts.
+- [API Reference](https://galacean.antgroup.com/engine/en/docs/graphics/2D/spine/api/) - Complete API documentation for all available classes, methods, and properties.
 
 
-The Oasis Engine is released under the [MIT](https://opensource.org/licenses/MIT) license. See LICENSE file.
+## License
+The Galacean Engine is released under the [MIT](https://opensource.org/licenses/MIT) license. See LICENSE file.