Cubism 4 SDK for Web R1 以降へのアップデートに伴う注意

最終更新： 2020年1月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とともに使用する場合などは必ずサブモジュールの更新をしてください。