Skip to content

Live2D/CubismJavaSamples

Repository files navigation

English / 日本語


Cubism Java Samples

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

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

License

Please check the license before using this SDK.

Directory structure

.
├─ Core             # Directory containing Live2D Cubism Core Java
├─ Framework        # Directory containing source code for rendering and animation functions
└─ Samples
   ├─ full      # Full version of sample application
   ├─ main      # Common code for full and minimum
      └─ assets # Directory containing resources such as model files and images
   ├─ minimum   # Sample application with reduced and simplified functions

Cubism Java Framework

Provides various functions for displaying and manipulating the model.

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

Live2D Cubism Core for Java

A library for loading the model. Live2D Cubism Core for Java 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.

How to build

This sample uses Gradle as the build tool. Please build the entire project after opening it in any IDE.

It is recommended to open and build the project in Android Studio. Other IDEs do not generate a 'local.properties' file, so you will need to create it yourself.

SDK manual

Cubism SDK Manual

Changelog

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

Development environment

Development Tools Version
Android Studio Flamingo 2022.2.1 Patch 1
IntelliJ IDEA 2023.1.1
CMake 3.1.0
Gradle 6.9

Android

Android SDK tools Version
Android NDK 21.4.7075529
Android SDK 33.0.0
CMake 3.1.0

Operation environment

Java

This sample application runs with Java SE 6 or higher Java versions.

Android

Version Device Tegra
13 Pixel 6a
7.1.1 Nexus 9 ✔︎
4.1 Pixel 5

This sample application runs with Android API 16 or higher Android versions.

Contributing

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.

Forking And Pull Requests

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.

Bugs

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.

Suggestions

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.

Community

If you would like to make suggestions or ask questions about how to use Cubism SDK among users, please use the community.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published