Cubism 4 SDK for Web R1 이상으로의 업데이트에 따른 주의사항

업데이트： 2020/01/30

개요

Cubism 4 SDK for Web R1에서 이전 베타 버전 후 정식 버전이 출시됨에 따라 편의성 향상을 위해 패키지 및 리포지토리의 구조 변경이 이루어졌습니다.
이 변경은 Cubism 4 SDK for Native와 구조를 바꾸지 않고 운용이 이루어지는 외에, 유저의 관리가 불필요한 파일이 혼재하는 것을 피하는 것이 이유입니다.

구조 변경점

패키지

Cubism 4 SDK for Web beta2 이하에서는 [패키지 루트 폴더]/Framework/[Framework 소스 그룹]으로 구성되었지만 Cubism 4 SDK for Web R1 이상에서는 [패키지 루트 폴더]/Framework/src/[Framework 소스 그룹]과 같이 Framework 소스를 관리하는 구조를 src 폴더를 끼워 1단 낮추고 Cubism 4 SDK for Native의 Framework 구성과 같은 구조에 맞추었습니다.

이 변경에 따라 Sample 측의 각 소스가 Framework 의 소스를 참조하고 있는 장소를 변경했습니다.

GitHub 리포지토리

Live2D GitHub의 CubismWebSamples 리포지토리에서 패키지 변경 외에도 Cubism 4 SDK for Web beta2 이하의 리포지토리는

• CubismWebSamples
  • Core
  • Framework(소스 그룹이 들어 있는 디렉토리)
  • Sample

전용으로 관리되었지만 Cubism 4 SDK for Web R1 이상에서는,

• CubismWebFramework
  • src(Framework의 소스 그룹이 들어 있는 디렉토리)
• CubismWebSamples
  • Core
  • Framework(서브 모듈)
  • Samples

이와 같이 Cubism 4 SDK for Native와 동일한 리포지토리 관리가 되었습니다.

이 변경에 따라 CubismWebSamples는 CubismWebFramework를 하위 모듈로 한 구조로 변경했습니다.

---

Cubism 4 SDK for Web beta2 이전 프로젝트에서 업데이트하는 방법

Cubism 4 SDK for Web beta2 이전 프로젝트에서 업데이트 할 때, 사용 중인 프로젝트에 그대로 Cubism 4 SDK for Web R1의 패키지 등을 덮어쓰면 변경이 적용되지 않고 오류가 발생하여 동작하지 않는 경우 등이 있을 수 있습니다.

이 항목에서는 Cubism 4 SDK for Web beta2 이전 프로젝트를 사용하는 사용자가 Cubism 4 SDK for Web R1을 사용할 수 있도록 업데이트하는 방법을 안내합니다.

패키지를 이용하는 경우

Cubism 4 SDK for Web beta2 이전 패키지를 다운로드하여 사용하는 사용자가 Cubism 4 SDK for Web R1 이상 SDK로 교체하여 사용하고 싶다면, 각 경우에 다음 절차가 필요합니다.

Framework의 구조를 변경하지 않고 사용하는 경우

1. Framework 구조를 「Framework/src」라는 구성으로 변경할지 여부를 결정합니다.

• 변경하는 경우 구조를 변경한 후 Cubism 4 SDK for Web R1의 Framework 폴더를 덮어씁니다.
• 변경하지 않는 경우 그 구조에 맞춘 Framework 소스와 같은 이름의 파일에 대해 차분을 취해 갱신해 주세요.

2. 【Framework의 구조를 「Framework/src」라는 구성으로 변경한 경우만】

• Framework를 참조하는 위치를 올바른 위치로 변경합니다.

Sample을 그대로 사용하지 않고 Framework의 구조나 소스를 변경해 사용하고 있는 경우

• 각각 사용하고 있는 Framework의 소스와 동명의 파일에 대해 차분을 취해 갱신해 주세요.

※ Sample을 그대로 사용하고 있는 경우 Framework를 참조하고 있는 각 소스의 부분을 변경하거나, Cubism 4 SDK for Web R1과 같은 운용을 실시해 주세요.
※ 환경에 따라서 상기의 순서를 수행해도 갱신이 적용되지 않는 경우가 있으므로, 프로젝트의 환경에 맞춘 변경을 실시해 주세요.

Live2D GitHub 리포지토리에서 복제하여 사용하는 경우

Cubism 4 SDK for Web beta2 이전 리포지토리(CubismWebSamples)를 사용하여 프로젝트를 만드는 사용자가 Cubism 4 SDK for Web R1 이상 SDK로 대체하여 사용하려는 경우 환경에 따라 일정한 절차를 밟을 수 없지만, 갱신할 때는 이하에 주의해 갱신을 해 주세요.

• 프로젝트가 Framework를 참조하는 위치에 문제가 없습니까?
  • Framework 소스 관리는 Framework/src에 있습니다.
• git submodule update로 서브 모듈을 업데이트하고 있습니까?
  • Framework(CubismWebFramework)는 CubismWebSamples의 서브 모듈이므로, Sample과 함께 사용하는 경우 등은 반드시 서브 모듈의 갱신을 해 주세요.