# CubismNativeSamples

**Repository Path**: Liuqq677/CubismNativeSamples

## Basic Information

- **Project Name**: CubismNativeSamples
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-13
- **Last Updated**: 2025-06-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[English](README.md) / [日本語](README.ja.md)

---

![image](logor.png)

# Cubism Native Samples

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

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


## License

Please check the [license](LICENSE.md) before using this SDK.


## Notices

Please check the [notices](NOTICE.md) before using this SDK.


## Compatibility with Cubism 5 new features and previous Cubism SDK versions

This SDK is compatible with Cubism 5.  
For SDK compatibility with new features in Cubism 5 Editor, please refer to [here](https://docs.live2d.com/en/cubism-sdk-manual/cubism-5-new-functions/).  
For compatibility with previous versions of Cubism SDK, please refer to [here](https://docs.live2d.com/en/cubism-sdk-manual/compatibility-with-cubism-5/).


## Directory structure

```
.
├─ Core             # Directory containing Live2D Cubism Core
├─ Framework        # Directory containing source code for rendering and animation functions
└─ Samples
   ├─ 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
   ├─ Vulkan        # Directory containing the Vulkan sample project
   └─ Resources     # Directory containing resources such as model files and images
```


## Cubism Native Framework

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.

[Cubism Native Framework]: (https://github.com/Live2D/CubismNativeFramework)


## Live2D Cubism Core for Native

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

To download, please refer to [this](https://www.live2d.com/download/cubism-sdk/download-native/) 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

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

### Where to generate the sample project deliverables

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


## Compile options

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.


## SDK manual

[Cubism SDK Manual](https://docs.live2d.com/cubism-sdk-manual/top/)


## Changelog

Samples : [CHANGELOG.md](CHANGELOG.md)

Framework : [CHANGELOG.md](Framework/CHANGELOG.md)

Core : [CHANGELOG.md](Core/CHANGELOG.md)


## Development environment

| Development Tool | Version |
| --- | --- |
| Android Studio | Meerkat Feature Drop 2024.3.2 |
| DevEco Studio | 5.0.5.306 |
| CMake | 3.31.7 |
| Visual Studio 2015 | Update 3 |
| Visual Studio 2017 | 15.9.73 |
| Visual Studio 2019 | 16.11.47 |
| Visual Studio 2022 | 17.14.2 |
| Xcode | 16.3 |

### Android

| Android SDK tools | Version |
| --- | --- |
| Android NDK | 26.3.11579264 |
| Android SDK | 35.0.0 |
| CMake | 3.22.1 |

### HarmonyOS

| HarmonyOS SDK tools | Version |
| --- | --- |
| HarmonyOS SDK | 5.0.1.112 |

### Linux

| System | Distribution version | Docker image | GCC |
| --- | --- | --- | --- |
| Red Hat | Amazon Linux 2 |  `amazonlinux:2` | 7.3.1 |
| Red Hat | AlmaLinux | `almalinux:latest` | 11.4.1 |
| Debian | Ubuntu 22.04.4 | `ubuntu:22.04` | 11.4.0 |
| Debian | Ubuntu 24.04.2 | `ubuntu:24.04` | 13.3.0 |

#### Mesa library

* Red Hat
  * `mesa-libGL-devel`
  * `mesa-libGLU-devel`
* Debian
  * `libgl1-mesa-dev`
  * `libglu1-mesa-dev`


## Operation environment

| Platform | Version |
| --- | --- |
| iOS / iPadOS | 18.5 |
| macOS | 15.5 |
| Windows 10 | 23H2 |
| Windows 11 | 24H2 |

### Android

| Version | Device | Tegra |
| --- | --- | --- |
| 15 | Pixel 7a | |
| 7.1.1 | Nexus 9 | ✔︎ |

### HarmonyOS

| Version | Device |
| --- | --- |
| NEXT.0.0.71 | HUAWEI Mate 60 Pro |

### Linux

| System | Distribution | Version |
| --- | --- | --- |
| Red Hat | Amazon Linux | 2 |
| Red Hat | AlmaLinux | 9 |
| Debian | Ubuntu | 24.04.2 |

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

## Forum

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

- [Live2D Creator's Forum](https://community.live2d.com/)
- [Live2D 公式クリエイターズフォーラム (Japanese)](https://creatorsforum.live2d.com/)


![image](logos.png)