Skip to content

Live2D/CubismUnityMotionSyncComponents

Repository files navigation

English / 日本語

Cubism MotionSync Plugin for Unity

This is a Cubism SDK plugin for using the motion-sync function on the Cubism SDK for Unity.

License

Please read the license before use.

Notice

Please read the notices before use.

Structure

Dependencies

Cubism SDK for Unity

This plugin is a Cubism SDK plugin for the Cubism SDK for Unity.

The Cubism SDK for Unity package is required for use.

If you are looking for the download page of the SDK package, please go to the download page.

Live2D Cubism MotionSync Core

This library provides the motion-sync function. Live2D Cubism MotionSync Core is not included in this repository.

To download the plugin package that includes Live2D Cubism MotionSync Core, please refer to this page.

Development environment

Unity Version
Latest 2023.2.20f1 (*1)
LTS 2022.3.30f1
LTS 2021.3.38f1

*1 ARMv7 Android is not supported.

Library / Tool Version
Android SDK / NDK *1
Visual Studio 2022 17.9.7
Windows SDK 10.0.22621.0
Xcode 15.4

*1 Use libraries embedded with Unity or the recommended libraries.

C# compiler

Build using Roslyn or mcs compiler supported by Unity 2018.4 and above.

Note: The mcs compiler is deprecated, and only builds are checked.

Please refer to the following official documentation for the versions of C# you can use.

https://docs.unity3d.com/2018.4/Documentation/Manual/CSharpCompiler.html

Tested environment

Platform Version
Android 14
iOS 17.5.1
iPadOS 17.5.1
macOS 14.5
Windows 10 22H2
Google Chrome 125.0.6422.113

Cubism SDK for Unity

Cubism 5 SDK for Unity R2

Microphone samples

In this sample, the input sound is played directly through the device's sound playback system. Depending on your environment, feedback may occur. To prevent this, please mute the sample application and the device's sound playback, or move the microphone and speaker away from each other.

Branches

If you are looking for the latest features and/or fixes, please check the develop branch.

The master branch is brought into sync with the develop branch once for every official plugin release.

Usage

Copy all files under ./Assets into the folder where this plugin is located in your Unity project.

Contribution to the 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 Forum.

Forking and Pull Requests

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.

Bugs

We are regularly checking bug reports and feature requests at Live2D Forum. Before submitting a bug report, please search the Live2D Forum to see if the bug report or feature request has already been submitted. Add your comment to the relevant issue if it already exists.

Suggestions

We're also interested in your feedback for the future of the SDK. You can submit a suggestion or feature request at Live2D Forum. To make this process more effective, we're asking that you include more information to help define them more clearly.

Coding Guidelines

Naming

Try to stick to the Microsoft guidelines whenever possible. Private fields are named in lowercase, starting with an underscore.

Style

  • In the Unity Editor extension, try to write expressive code with LINQ and all the other fancy stuff.
  • Otherwise, do not use LINQ and prefer for to foreach.
  • Try to make the access modifier explicit. Use private void Update() instead of void Update().

Forum

If you have any questions, please join the official Live2D forum and discuss with other users.