Spine-Unity 4.2 to 4.3 Upgrade Guide

Harald

There have been some more breaking changes on the 4.3-beta branch since last posting for spine-csharp and spine-unity. From the CHANGELOG.md:

spine-csharp:

Skin.SkinEntry.Name was intermediately renamed to PlaceholderName which has now been changed to Skin.SkinEntry.Placeholder.
MeshAttachment.ParentMesh renamed to MeshAttachment.SourceMesh
AttachmentLoader methods NewRegionAttachment, NewMeshAttachment, NewBoundingBoxAttachment, NewClippingAttachment, NewPathAttachment, and NewPointAttachment now take an additional string placeholder parameter. Update any custom AttachmentLoader implementations accordingly.

The topmost posting has been updated as well, now containing the previously missing entries of the last update posting, updating items 11. - 17.

BottaDev

Hi,

We accidentally upgraded our Spine project from 4.2 to 4.3. The issue is that I couldn’t find the Git URL or package link to install the non-beta Spine Unity 4.3 package.

When I try to update the 4.2 package from Unity’s Package Manager, it does not update to 4.3.

We now need to update the Unity runtime because after saving the project in Spine 4.3, importing it into Unity with the 4.2 runtime gives us a version compatibility error.

Could you please point me to the correct Git URL or download link for the stable/non-beta spine-unity 4.3 package?

Thanks!

Harald

BottaDev You could just have used 4.3-beta, the last beta version and first stable 4.3 branch versions are the same.

The 4.3 branch has now been updated, the spine-unity download page was updated accordingly as well, and all packages released for version 4.3.

If you are using Unity Package Manager with Add package from git URL, the probably easiest way is to edit the file Packages/manifest.json in your project top directory and replace 4.3-beta with 4.3. Then when switching to Unity, the packages should be reloaded automatically.

BottaDev Could you please point me to the correct Git URL or download link for the stable/non-beta spine-unity 4.3 package?

In general the git URLs follow the simple naming scheme of having just the branch name like #4.3 or #4.3-beta as suffix. There is nothing special.

Fattori

hi guys, question here:

are the 4.3.95 beta assets compatible with 4.3.00? i just saw you guys updated it, idk if unity runtime was also updated, if so, would it be compatible with the beta assets from 4.3.95, can i keep those files like that or should i update all my assets to 4.3.00?

i could update spine itself to the new release for later assets but the old ones will work properly if i dont touch them?

Harald

Fattori are the 4.3.95 beta assets compatible with 4.3.00? i just saw you guys updated it, idk if unity runtime was also updated, if so, would it be compatible with the beta assets from 4.3.95, can i keep those files like that or should i update all my assets to 4.3.00?

The 4.3.95 beta assets are compatible with the spine-unity 4.3 stable release, there is no immediate need to update, unless you need any of the recent bugfixes from the Spine Editor Changelog.

chrisoshea

Hi
Is there a summary somewhere of the new features/improvements going from 4.2 to 4.3? Other than reading every item in the chanelog? What are the headline changes?

We are using runtime 4.2 in the project but I just realised the artist is using editor 4.3. They seem to work in Unity, but should they be working? Docs suggest you need 4.3 runtime.

Thanks
Chris

chrisoshea

chrisoshea Artist is using Spine 4.3.03. I tried updating the plugin and it says its a 4.2 skeleton

Misaki

chrisoshea We're currently working on a blog post summarizing the changes from version 4.2 to 4.3, but we apologize for the delay in publishing it. However, all the changes to spine-unity are listed in this thread.

Artist is using Spine 4.3.03. I tried updating the plugin and it says its a 4.2 skeleton

I’m not entirely sure why this happened, but you can determine whether the skeleton data was actually exported in version 4.3 by opening the .json or .skel.bytes file in a text editor and checking the version number listed at the beginning. If it actually shows version 4.2, it’s possible that the artist updated their editor but didn’t complete the re-export of the skeleton data, or perhaps they accidentally shared a file from a different folder.

The main API changes are mentioned in the“spine-unity 4.3 Split Component Upgrade Guide” on GitHub, but please be sure to also check the very first post in this thread. Reading both will give you the full information.
The instructions in this guide should be quite detailed, but if you get stuck on a particular step, please let us know the step number so we can offer specific advice.

Harald

chrisoshea We are using runtime 4.2 in the project but I just realised the artist is using editor 4.3. They seem to work in Unity, but should they be working? Docs suggest you need 4.3 runtime.

Skeletons exported with version 4.3 can't be imported in spine-unity 4.2, see the documentation. The spine-unity runtime would log an error message if the version does not match, so I doubt that's the case. If you have verified that the skeleton contains version 4.3 in it but still opens on a 4.2 spine-unity runtime, please do let us know.

chrisoshea

Sorry some more questions. I've deleted 4.3 from package manager and gone back to 4.2. The latest version it will update to is 4.2.37 csharp, 4.2.118 unity.

I'd like to do the 2 step process described here
EsotericSoftware/spine-runtimesblob/4.3/spine-unity/Assets/Spine/Documentation/4.3-split-component-upgrade-guide.md

would the api changes be in the versions listed above?

when i try to add this git url in package manager it fails
EsotericSoftware/spine-runtimes.git?path=spine-csharp/src#a07b1de

its also not clear which version of the unity runtime i should be adding.

when I upgraded to 4.3, this fails:
skeletonAnimation.Skeleton.SetSlotsToSetupPose();

however on the latest 4.2 I try this:
skeletonAnimation.Skeleton.SetupPoseSlots();

but it won't let me, so I assume the api changes aren't in that version.

thanks

chrisoshea

Thanks for the reply. I'm stuck on the step number 3, update your code. I want to follow the "Optional Two-Step Migration from 4.2"

Unity when I try to add the csharp git link with src#a07b1de on the end in Unity package manager, it says there is an error adding. It's also not clear which git link to use to for the unity runtime.

This is so I can get the updated api, update my code and then delete the package, install 4.3 packages

Harald

@chrisoshea Sorry for the troubles!

My fault, Unity Package Manager does not support short-form git URLs like a07b1de, it has to be the long a07b1de9ce972d4e38898ccf2cc84de16ff66c9b hash. The correct URL is therefore:

https://github.com/EsotericSoftware/spine-runtimes.git?path=spine-csharp/src#a07b1de9ce972d4e38898ccf2cc84de16ff66c9b

We've updated the upgrade guide .md files in the repository accordingly.

chrisoshea

Harald Thank you Harald.

If I'm importing from git that particular commit ofr the csharp runtime via package manager, which version of the unity runtime should i be using for it to match that commit above?

Harald

chrisoshea You would normally use the same commit hash at the spine-unity URL as well.

[Edit: added:] This is because the spine-unity runtime will always receive the required changes in the same commit if the spine-csharp runtime commit contains a breaking commit.

chrisoshea

So the way the reference animation files are created has changes, from a folder of multiples to a single asset. Is it worth deleting the old ones and making the new styles ones, if this is the way going fowards?

Harald

chrisoshea So the way the reference animation files are created has changes, from a folder of multiples to a single asset. Is it worth deleting the old ones and making the new styles ones, if this is the way going fowards?

For an existing project which already uses existing AnimationReferenceAssets, please do not delete the old assets and re-generate them, or you end up with broken references at your scenes or prefabs. The old assets can exist alongside the new ones without any issues. You can of course delete them if you want your project uniform and are happy to do some additional work with the re-assignment of animation assets.

gunspike

안녕하세요, Spine 팀.

최근 Unity 프로젝트의 Spine Unity 런타임을 4.2에서 4.3으로 업그레이드했습니다.

업그레이드 후 Spine Editor 4.3.04에서 모든 Spine skeleton 파일을 다시 내보내기 했고, Unity에서 다시 임포트했습니다. 이전에 발생하던 버전 불일치 오류는 해결되었으며, 현재 Unity 콘솔에는 import 관련 오류나 다른 에러가 표시되지 않습니다.

하지만 Unity에서 애니메이션이 재생되지 않는 문제가 있습니다.

환경:

Unity 버전: [Unity 버전 6.4]
Spine Editor 버전: 4.3.04
spine-unity 런타임 버전: 4.3
Export 형식: Binary .skel
플랫폼: [Editor / Windows / Android / iOS 등]

진행한 작업:

Unity 프로젝트의 spine-unity 런타임을 4.3으로 업그레이드했습니다.
Spine Editor 4.3.04에서 skeleton 데이터를 다시 export했습니다.
Unity에서 Spine asset들을 다시 import했습니다.
기존 scene/prefab을 열었고, Spine Unity 4.3 업그레이드 알림이 표시되었습니다.
해당 알림에는 Skeleton 관련 컴포넌트가 animation component와 rendering component로 분리되었다는 내용이 있었습니다.
이후 Unity 콘솔에는 별도의 오류가 표시되지 않습니다.

기대 결과:

업그레이드 전과 동일하게 Unity에서 Spine 애니메이션이 정상적으로 재생되어야 합니다.

실제 결과:

skeleton 파일은 정상적으로 import됩니다.
Unity 콘솔에 오류는 표시되지 않습니다.
하지만 애니메이션이 재생되지 않습니다.

추가 정보:

이 프로젝트는 기존에 Spine Unity 4.2를 사용하던 기존 Unity 프로젝트입니다.
문제는 Spine Unity 4.3 업그레이드 및 Spine 4.3 재export 이후 발생했습니다.
Import 자체는 성공하지만 runtime에서 애니메이션 재생이 시작되지 않는 상태로 보입니다.
Spine Unity 4.3에서 SkeletonAnimation, SkeletonMecanim, SkeletonGraphic 등이 animation component와 rendering component로 분리된 구조 변경과 관련이 있을 수 있다고 생각하고 있습니다.

Spine Unity 4.3의 split-component 업그레이드 이후 기존 prefab이나 scene에서 반드시 확인해야 할 항목이 있을까요?

또한 기존 스크립트에서 SkeletonAnimation, SkeletonRenderer, SkeletonGraphic, AnimationState 등을 참조하고 있는 경우 필요한 마이그레이션 절차가 있는지도 안내 부탁드립니다.

감사합니다.

Misaki

gunspike From the situation you described, it sounds possible that some of the required upgrade steps may have been missed. The main post in this thread explains the upgrade procedure, and when upgrading from 4.2 to 4.3, it is important to follow the steps described there carefully. Since there were quite a few significant changes between Spine 4.2 and 4.3, please make sure to review the guide first if you haven’t already.

In particular, please be sure to read the 4.3 Split Component Upgrade Guide linked from the main post.

Also, separately from the upgrade procedure itself, Spine Editor 4.3.04 had a critical issue where incoming curve handles were not being saved for non-Bézier keys. Because of this, we recommend re-exporting all skeleton data files using Spine 4.3.06 instead. We apologize for the inconvenience.

lxs

zf3d 重新导出好几十个动画 :

Harald

@lxs Did you accidentally cut off your text, or is there an image missing?

« Previous Page