Welcome to the Unity-based Cubism 3 do-it-yourself viewer. Came here looking for the official Live2D homepage? Go here.
Instead of providing a complete solution like the 2.x viewers did, this project aims to serve as a starting point and to provide common functionality for making it easy to create a viewer tailored to your needs.
Want to preview models easily without access to Unity? Create a viewer with built-in functionality.
Need model related data in your app that you can't create in Cubism itself? Customize the viewer to create just the data you need.
The viewer itself basically is a single MonoBehaviour.
You customize the viewer by attaching other MonoBehaviours to it.
As Plugin is a somewhat reserved term in Unity (and because I like Ruby),
let's call such custom behaviours gems.
This project contains a few gems to get you started.
This gem allows you to move the canvas and zoom-in.
Hotkeys default to Spacebar + Left Mouse Button + Drag for navigating the canvas, and
Mouse Wheel Scroll Up/Down for zooming.
This gem allows you to play back a single animation at a time.
This gem allows you to quickly theme the viewer using a 2 color theme.
The background color will be set to the primary color of the theme.
You can register any number of UI elements you want themed, too, through the Inspector.
Hotkey defaults to Left Control + T for switching between themes.
First, you have to download a few files and get them into a Unity project:
- Download the latest SDK and import it into your project.
- Make sure to restart Unity.
- Download the latest Components for Unity into your project. Overwrite any previous SDK files with the new ones.
- Download/Clone this repository into your project.
- Copy the Mono
System.Windows.Forms.dllinto your project. (Check out./Assets/Live2D/Cubism/Viewer/Plugins/System.Windows.Forms.txtfor instructions). - Set
API Compability Levelto .NET 2.0 (default is .NET 2.0 Subset) in the Player Settings.
From here things are easy because you do the rest completely inside the Unity Editor:
- Create an empty GameObject and add the
CubismViewercomponent to it. - Assign the
Main Camerain your scene to theCubismViewerthrough the Inspector. - Create an UI button and add the
CubismViewer.ShowFileDialogmethod of theCubismViewerobject toOn Click (). - Hit play, click the UI button. A file dialog should open.
- Select a
model3.jsonfile via the file dialog. The model should be displayed. - Add gems to the
CubismViewerobject for additional functionality.
Wrote a cool gem? We're looking forward to it. You can either submit its source code or a link (as Live2D Community or as pull requests).
Besides that, there are many other ways to contribute to the project, too: logging bugs, submitting pull requests on this GitHub, and reporting issues and making suggestions at Live2D Community.
We very appreciate your pull requests whether they bring fixes, improvements, or even new features.
Note, however, that the wrapper is designed to be as lightweight and shallow as possible and
should therefore only be subject to bug fixes and memory/performance improvements.
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.
Please limit the discussion to English and keep it professional and things on topic.
If you plan on using this project or parts of it for non-personal or non-in-house use, make sure to read the license carefully. Otherwise, you shouldn't have to worry to much as the license that applies to the source code in this project allows you to modify all sources without the need to submit any changes you made.