English / 日本語

This is a sample implementation of an application that displays models output by Live2D Cubism 4 Editor.

It is used in conjunction with Cubism Native Framework and Live2D Cubism Core.

Please check the license before using this SDK.

Please check the notices before using this SDK.

.
├─ Core             # Directory containing Live2D Cubism Core
├─ Framework        # Directory containing source code for rendering and animation functions
└─ Samples
   ├─ Cocos2d-x     # Directory containing the Cocos2d-x sample project
   ├─ D3D9          # Directory containing the DirectX 9.0c sample project
   ├─ D3D11         # Directory containing the DirectX 11 sample project
   ├─ Metal         # Directory containing the Metal sample project
   ├─ OpenGL        # Directory containing the OpenGL sample project
   └─ Resources     # Directory containing resources such as model files and images

Provides various functions for displaying and manipulating the model.

Cubism Native Framework is included as a submodule of this repository. After cloning this repository, the files will be added by cloning the submodule.

A library for loading the model. Live2D Cubism Core for Native is not included in this repository.

To download, please refer to this page. Copy the contents of the downloaded ZIP file to the Core directory of this repository and link it to the program.

The build method depends on the sample project. Please refer to the README.md included with each sample project.

In this sample, the deliverables of CMake projects except Android are generated in the bin directory.

E.g. When building a macOS project of the OpenGL sample using the make_gcc script

Demo
└─ proj.mac.cmake
   └─ build
      └─ make_gcc
         └─ bin
            └─ Demo
               ├─ Resources    # Same as Samples/Resources
               └─ Demo         # Executable applications

If the macro USE_RENDER_TARGET or USE_MODEL_RENDER_TARGET is enabled in your project, the model will be rendered to the texture. Please refer to 'LAppLive2DManager.cpp' in the sample directory for details.

Cubism SDK Manual

Please refer to CHANGELOG.md for the changelog of this repository.

*1 CentOS 8 is not supported

• Red Hat
  • mesa-libGL-devel
  • mesa-libGLU-devel
• Debian
  • libgl1-mesa-dev
  • libglu1-mesa-dev

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. 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.

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.

If you want to suggest or ask questions about how to use the Cubism SDK between users, please use the community.

• Live2D community
• Live2D 公式コミュニティ (Japanese)