The spine-unity runtime provides functionality to load, manipulate and render Spine skeletal animation data using Unity.
But I added some other feature in it.
Including:
-
Support Spine 3.5 to Spine 4.2 import without modification.(binary only, json still in progress).
-
Extract mihoyo / hoyoverse website and decode Spine correctly.
-
Add mihoyo / hoyoverse website spine runtime movement and hierachy rebuild.
-
The Repo is Already a workable project for Unity2020 and above. Download it and Open it with Unity, you are good to go!
(branch for Unity 2017 is also provided, but it is always recomand to use Unity in newer version.)
-
To Avoid Texture alpha looks weird, go to Edit->Preference->Spine in menu and set the Spine Editor Settings to the picture bellow. (Just Use Straight Alpha Preset)
Tips:
if you have no idea why the second step makes alpha looks good.
read the [Spine-Unity-Document](https://esotericsoftware.com/spine-unity) especially **Alpha Texture Settings** section.
- For this feature, just drag the relate Atlas Texture and Skeleton file into Unity. It should decode them correctly.
For example:
- Arknights-> Spine 3.5 (in latest, it has changed to 3.8)
- Princess Connect! Re:Dive -> Spine 3.6
- Azurlane -> Spine 3.8
- Blue Archive -> Spine 3.8
- Genshin Impact -> Spine 4.0+
- For this feature, Go to ZeroFly in menu. Click the Read Vendors Content, it should open up a new window, drag it to wherever you want.
- Enter the website url, make sure it is accesable through browser.
**Tips:** You can use this link as an example :https://act.mihoyo.com/ys/event/e20231209preview-yh731z/index.html
- Check the info on board. It should show following content:
- Zone Url
- Event Name
- Website Url
-
If every thing looks good, click the Start Decode button.
-
Wait until the program end.(It might take a while if the Spine import is really slow. I will try to improve it in future)
-
If no error occur. Check the Assets folder, a new folder wich named by Event Name should be generated.
- The spine files are stored in the folder beneath.
In many cases, the hair or tails of characters are not hard coded in Spine file, the movements are generated by runtime algorithm.
That's why you can not view the tails movement in official Spine.
- For this feature, drag the SkeletonDataAssets into the scene view.
-
Add Component Skeleton Utility.
-
Click the Spawn Hierachy -> Follow All Bones
- Hit on the Unity Play Button, you should see the movement in runtime.
-
For this feature, create an empty GameObject in the hierrachy view by right click.
-
Add Component Vendors Generator
-
For every Event Name folder, which generated by Vendors Decoder, there should be one or more json file named with suffix _Geo
-
Drag it to Geometry Json in Inspector view.
-
Click the Spawn Geometry
-
Check the generated gameobject hierachy, the first child node is always the root of scene node.
-
Use set active/inactive to show only the scene you interest
-
Hit on the Unity Play Button,you can see spine animation, particles should work as expected.
Experiment Feature:
-
For every Event Name folder, there are a child folder named otherResources, all the unknown usage files are downloaded there.
-
There might json files named like json_0_Other,json_1_Other...etc, they might be animation files, you can drag them to Animation File List,then Click the Spawn Geometry
-
You wil find animation files generated in otherResources folder.
-
Add Animation Component on the GameObject where VendorsGenerator is attached.
-
Hit on the Unity Play Button, the animation should work.
A: The decode is base on vendors.js and index.js analization. Due to the inconsitent between website content. It might failed sometimes, especially when the website is before 2021/09/28. (The first aniversary review, I have tested it works.)
Because the Mihoyo team change website js format in older version. For example, in older version, some website use bundle.js instead of index.js. The bundle.js format is really different from index.js
To support older Website bring in too much pain, it would be better to start another project to do so.
However, in newer version website, they finally come to a much stable format.
If the decode failed, feel free to write issue, remember to attach the website url and what error Unity reports.
The Website too old would not support though.
Please look at the second point in Preparation, or look at the document Spine-Unity-Document especially Alpha Texture Settings section.
Then remove the imported spine files and reimport them in Unity again.
(1) First, cloths, hair and tails might be generate by runtime scripts, not hard coded in spine file.
(2) Second, the deform animation of attachments is bring out in json hierachy, so the official spine can not read deform animation correctly. In this runtime, it just skip the wrong hierachy to get correct result. In the future there will be scripts fix the case, so that the official spine can play mihoyo spine correctly.
There are only scripts in repo. You should check the rights and avoid legal problems when using the resources get by this repo, especially usage in business!
If there are infringement in this repo. Just let me notice, I will delete relate resources as soon as possible.
The spine-unity runtime provides functionality to load, manipulate and render Spine skeletal animation data using Unity. spine-unity is based on spine-csharp.
You are welcome to evaluate the Spine Runtimes and the examples we provide in this repository free of charge.
You can integrate the Spine Runtimes into your software free of charge, but users of your software must have their own Spine license. Please make your users aware of this requirement! This option is often chosen by those making development tools, such as an SDK, game toolkit, or software library.
In order to distribute your software containing the Spine Runtimes to others that don't have a Spine license, you need a Spine license at the time of integration. Then you can distribute your software containing the Spine Runtimes however you like, provided others don't modify it or use it to create new software. If others want to do that, they'll need their own Spine license.
For the official legal terms governing the Spine Runtimes, please read the Spine Runtimes License Agreement and Section 2 of the Spine Editor License Agreement.
spine-unity works with data exported from Spine 4.1.xx.
spine-unity supports all Spine features.
Unity's physics components do not support dynamically assigned vertices so they cannot be used to mirror bone-weighted and deformed BoundingBoxAttachments. However, BoundingBoxAttachment vertices at runtime will still deform correctly and can be used to perform manual hit detection.
spine-unity is compatible with Unity 2017.1-2023.1.
- Create an empty Unity project (or use an existing project).
- Download and import the
spine-unity.unitypackage.
See the Spine Runtimes documentation on how to use the APIs and check out the spine-unity examples for demonstrations of Unity specific features.
- Create an empty Unity project
- Download and import the
spine-unity.unitypackage. - Explore the example scenes found in the
Assets/Spine Examples/Scenesfolder.
- This slightly outdated spine-unity tutorial video may still be useful.
- Atlas images should use Premultiplied Alpha when using the shaders that come with spine-unity (
Spine/SkeletonorSpine/SkeletonLit). - Texture artifacts from compression: Unity's 2D project defaults import new images added to the project with the Texture Type "Sprite". This can cause artifacts when using the
Spine/Skeletonshader. To avoid these artifacts, make sure the Texture Type is set to "Texture". spine-unity's automatic import will attempt to apply these settings but in the process of updating your textures, these settings may be reverted.