Welcome to the open components of the Cubism SDK for Unity.
It is used in conjunction with the Live2D Cubism Core.
Go here if you're looking for the download page of the SDK package.
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 are a shim layer for wrapping the unmanaged Cubism core library to C# and Unity and are located in ./Assets/Live2D/Cubism/Core.
Components and classes in this group provide additional functionality like lip-syncing, as well as integration of "foreign" Cubism files with Unity. Turning Cubism files into Prefabs and AnimationClips is done here. All the framework code is located in ./Assets/Live2D/Cubism/Framework.
Components and classes in this group provide the functionality for rendering Cubism models using Unity functionality and are located in ./Assets/Live2D/Cubism/Rendering.
Unity Editor extensions are located in ./Assets/Live2D/Cubism/Editor.
Resources like shaders and other assets are located in ./Assets/Live2D/Cubism/Rendering/Resources.
| Unity | Version |
|---|---|
| Latest | 2023.2.14f1 (*1) |
| LTS | 2022.3.21f1 |
| LTS | 2021.3.36f1 |
*1 ARMv7 Android is not supported.
| Library / Tool | Version |
|---|---|
| Android SDK / NDK | *2 |
| Visual Studio 2022 | 17.9.3 |
| Windows SDK | 10.0.22621.0 |
| Xcode | 15.3 |
*2 Use libraries embedded with Unity or recommended.
| HarmonyOS NEXT Supported Tools | Version |
|---|---|
| Tuanjie | 1.0.1 |
| DevEco Studio *3 | 4.0 |
*3 Builds for HarmonyOS NEXT outside of China must be built through DevEco.
Build using Roslyn or mcs compiler supported by Unity 2018.4 and above.
Note: The mcs compiler is deprecated and we only check the build.
Please refer to the following official documentation for the versions of C# you can use.
https://docs.unity3d.com/ja/2018.4/Manual/CSharpCompiler.html
| Platform | Version |
|---|---|
| Android | 14 |
| iOS | 17.4 |
| iPadOS | 17.4 |
| Ubuntu | 20.04.6 |
| macOS | 14.4 |
| Windows 11 | 23H2 |
| Google Chrome | 122.0.6261.129 |
| Chrome OS 64bit (x86_64) | 122.0.6261.118 |
| Chrome OS 32bit (ARMv8) (*3) | 122.0.6261.118 |
| HarmonyOS NEXT | 4.0.0.66 |
*3 This is a confirmation of operation with APK files for Android.
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.
Simply copy all files under ./Assets into the folder where the Live2D Cubism SDK is located in your Unity project.
The Core wrapper requires unsafe code blocks to be allowed, and the C# project Unity creates is patched accordingly. If unsafe code isn't an option for you, currently the best way is to compile the components and drop that dll into your Unity project.
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 Community.
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 Community. Before filing a bug report, please do a search in Live2D Community 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 Community. To make this process more effective, we're asking that you include more information to help define them more clearly.
Try to stick to the Microsoft guidelines whenever possible. We name private fields in lower-camelcase starting with an underscore.
- In Unity Editor extension, try to write expressive code with LINQ and all the other fancy stuff.
- Stay away from LINQ and prefer
foroverforeachanywhere else. - Try to be explicit. Prefer
private void Update()overvoid Update().
If you have any questions, please join the official Live2D forum and discuss with other users.
