Note for updating to Cubism 4 SDK for Web R1 or later

[Last updated : 01/30/2020]

 

Summary

With the release of the official version of Cubism 4 SDK for Web R1 from the previous beta version, the package and repository structure has been changed to improve convenience.
The reason for this change is to avoid mixing files that require unnecessary user management, in addition to operating without changing the structure from Cubism 4 SDK for Native.

 

Structural Changes

Package

Prior to Cubism 4 SDK for Web beta2, it was configured

[package root folder]/Framework/[Framework sources]

but in Cubism 4 SDK for Web R1 and later, it changed to

[package root folder]/Framework/src/[Framework sources]

Therefore, structure for managing the Framework source code has been moved down one level across the src folder to a structure similar to the Framework structure of Cubism 4 SDK for Native.

This change changes the location of references to the Framework source in each source on the Sample side.

 

GitHub Repository

In addition to the package changes in the CubismWebSamples repository on the Live2D GitHub, the Cubism 4 SDK for Web beta2 and earlier repositories have been managed only by

  • CubismWebSamples
    • Core
    • Framework (directory containing sources)
    • Sample

However, in Cubism 4 SDK for Web R1 and later,

  • CubismWebFramework
    • src (directory containing Framework sources)
  • CubismWebSamples
    • Core
    • Framework (sub-module)
    • Samples

As above, the repository management is now similar to that of Cubism 4 SDK for Native.

With this change, CubismWebSamples is now structured as a sub-module of CubismWebFramework.

 

How to update from projects prior to Cubism 4 SDK for Web beta2

When updating from a project prior to Cubism 4 SDK for Web beta2,
if you overwrite your project with Cubism 4 SDK for Web R1 package, the changes will not be applied, or errors will occur and the project will not work.

This section will guide users of Cubism 4 SDK for Web beta2 or earlier projects on how to update their projects to be able to use Cubism 4 SDK for Web R1.

 

If you are using a package

For users who have downloaded the Cubism 4 SDK for Web beta2 or earlier packages and wish to replace them with the Cubism 4 SDK for Web R1 or later,
in each case, the following steps are required.

  • If the Framework structure is used without modification
    1. Decide whether or not to change the structure of the Framework to a “Framework/src” configuration.
      • If you wish to make changes, overwrite the Framework folder of Cubism 4 SDK for Web R1 after modifying the structure.
      • If you do not change it, please update it with a diff against the file of the same name as the Framework source for that structure.
    2. [Only when the structure of Framework is changed to the “Framework/src” configuration]
         Change references to Framework to the correct location.
  • If you are not using the Sample as-is and have modified the structure or source of the Framework
    • Please update the source files with the same name as the source files of the Framework you are using.

* If you are using Sample as it is, please change the part of each source that refers to Framework, or use the same operation as Cubism 4 SDK for Web R1.
* The above procedure may not apply to some environments, so please make changes according to the project environment.

 

If you are using a clone from the Live2D GitHub repository

For users who have created projects using the Cubism 4 SDK for Web beta2 or earlier repository (CubismWebSamples) and wish to replace it with the Cubism 4 SDK for Web R1 or later,
although there is no set procedure depending on the environment, please note the following when updating the software.

  • Is the project referencing the Framework in the correct place?
    • Framework sources are managed in Framework/src.
  • Are you updating submodules with git submodule update?
    • Framework(CubismWebFramework) is a sub-module of CubismWebSamples, so be sure to update the sub-module when using it with Sample.

© 2010 - 2022 Live2D Inc.