Welcome to the open components of the Cubism SDK for Unreal Engine.
It is used in conjunction with the Live2D Cubism Core.
Go here if you're looking for the download page of the SDK package.
This product is "Pre-release Software".
The Pre-release Software is not Live2D’s commercial product and may include bugs, errors, and other deficiencies which may arise system errors or data loss.
For more details, please read the license.
Please read the license before use.
Please read the notices before use.
This SDK is compatible with Cubism 5.
For SDK compatibility with new features in Cubism 5 Editor, please refer to here.
For compatibility with previous versions of Cubism SDK, please refer to here.
The components are grouped by their role, and this grouping is reflected in both the folder structure and namespaces.
Components and classes in this group provide additional functionality like lip-syncing, as well as integration of "foreign" Cubism files with Unreal Engine. All the framework code is located in ./Source/Live2DCubismFramework.
Components and classes in this group provide the functionality for rendering Cubism models using Unreal Engine functionality and are located in ./Source/Live2DCubismFramework/Public/Rendering and ./Source/Live2DCubismFramework/Private/Rendering.
Unreal Engine Editor extensions are located in ./Source/Live2DCubismFrameworkEditor.
Turning Cubism files into uasset file are located in ./Source/Live2DCubismFrameworkImporter.
Resources like shaders and other assets are located in ./Content/Materials.
| Unreal Engine | Version |
|---|---|
| Unreal Editor 5.4 | 5.4.4 |
| Unreal Editor 5.3 | 5.3.2 |
| Unreal Editor 5.2 | 5.2.1 |
| Library / Tool | Version |
|---|---|
| Visual Studio 2022 | 17.11.5 |
| Windows SDK | 10.0.22621.0 |
| Platform | Version |
|---|---|
| Windows 11 | 23H2 |
If you're looking for the latest features and/or fixes, all development takes place in the develop branch.
The master branch is brought into sync with the develop branch once for every official SDK release.
Create the Unreal project in C++, and after creating a Plugins folder under the Unreal project, copy the package folder into the created Plugins folder and restart Unreal Engine.
For more details, please refer to the official manual.
There are many ways to contribute to the project: logging bugs, submitting pull requests on this GitHub, and reporting issues and making suggestions in Live2D CommUnreal Engine.
We very much appreciate your pull requests, whether they bring fixes, improvements, or even new features. To keep the main repository as clean as possible, create a personal fork and feature branches there as needed.
We are regularly checking issue-reports and feature requests at Live2D CommUnreal Engine. Before filing a bug report, please do a search in Live2D CommUnreal Engine to see if the issue-report or feature request has already been posted. If you find your issue already exists, make relevant comments and add your reaction.
We're also interested in your feedback for the future of the SDK. You can submit a suggestion or feature request at Live2D CommUnreal Engine. To make this process more effective, we're asking that you include more information to help define them more clearly.
We adhere to the official Unreal Engine coding standard. Coding Standard
If you have any questions, please join the official Live2D forum and discuss with other users.