Update Cubism Components (SDK for Cocos Creator)

Updated: 03/14/2023

This page is for Cubism version 4.2 or earlier. Click here for the latest version.

This section describes how to replace a project that has been created in “Import SDK” with the latest package.

Summary

There are two ways to obtain the Cubism SDK: from a package or from GitHub.

The package contains the latest Core libraries and CubismComponents at the time of its release, as well as samples that make use of them.

To apply Cubism SDK updates from GitHub to your Cocos Creator project, follow the steps described below.

If you are not yet familiar with Cocos Creator, please make a backup of your project before updating.

TIPS
The SDK is updated by opening the latest zip and overwriting it to the location where the SDK is installed, e.g., in Explorer. The SDK installation location for the project is [Cocos Creator project path]/extensions/live2d_cubismsdk_cocoscreator/. After overwriting the SDK, be sure to open the Extension Manager from the Extension menu of Cocos Creator and perform a Reload.

Get the Latest Package

Obtain the latest package from the Cubism SDK download page.

Apply the Latest Package to Your Cocos Creator Project

When overwriting an existing Cocos Creator project, it may not be possible to continue using Cubism Core on the Cocos Creator side and update it.

In this case, follow the procedure below to update.

  1. Save all currently used scenes.
  2. After saving is complete, create a new scene using “Ctrl + N” or similar.
  3. Restart Cocos Creator with the new scene created.
  4. Once Cocos Creator starts, overwrite the latest package.

If no compile errors occur after overwriting, the Cubism SDK update for the Cocos Creator project is complete.

If a compile error occurs at this point, the following causes are possible.

  • The classes themselves included in the package are customized
  • A class with the same name as a class added to the package already exists in the project
Was this article helpful?
YesNo
Please let us know what you think about this article.