https://github.com/Arisego/UnrealLive2D

UE4 plugin for live2d model
https://github.com/Arisego/UnrealLive2D

Last synced: about 1 month ago
JSON representation

UE4 plugin for live2d model

• Host: GitHub
• URL: https://github.com/Arisego/UnrealLive2D
• Owner: Arisego
• License: mit
• Created: 2019-12-29T11:38:09.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-25T07:03:18.000Z (8 months ago)
• Last Synced: 2024-08-02T16:30:50.160Z (4 months ago)
• Language: C++
• Size: 23.5 MB
• Stars: 134
• Watchers: 9
• Forks: 24
• Open Issues: 6
• Metadata Files:
  • Readme: ReadMe.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-unreal - UnrealLive2D - UE4 plugin for live2d model (Plugin)
• awesome-game-security - UE4 plugin for live2d model

README

        
# UnRealLive2D

Unreal Engine plugin for Live2D model.

![Screen Shot](Docs/Image/ScreenShot.GIF?raw=true)

The model logic part is based on [CubismNativeFramework](https://github.com/Live2D/CubismNativeFramework/). 

The render part take advantage of the [global shader plugin system](https://docs.unrealengine.com/en-US/Programming/Rendering/ShaderInPlugin/QuickStart/index.html). 

## Usage

1. Put this plugin in your project's Plugin folder

2. Download [Cubism Native SDK](https://www.live2d.com/en/download/cubism-sdk/download-native/) and copy `lib` and `include` to [CubismLibrary](https://github.com/Arisego/Live2DTest/tree/master/Plugins/UnrealLive2D/Source/ThirdParty/CubismLibrary) folder

> A sample of the plugin usage can be found [here](https://github.com/Arisego/Live2DTest).

You must donwload the corresponding version of [Cubism Native SDK](https://www.live2d.com/en/download/cubism-sdk/download-native/), or someting may not work as expected.

After plugin is compiled and installed, you can find *CubismMap* in plugin content folder. That's the sample map showing how model is rendered to RenderTarget and then displayed in UMG and World.

If you want to package game with the models in plugin folder, remeber to add `../Plugins/UnrealLive2D/Content/Samples` to your package copy path.

## Notice

This plugin was tested on __Win64__ envrioment only, it was supposed to work on all the platform that Cubism Native SDK supported, but some additional work might be needed. You can start with configuring `UnrealLive2D.Build.cs`.

Render result is only tested with *Hiyori* and *Mark*.

Some of the logic is not linked to blueprint and the control of the model logic is a bit dirty, this plugin is intend to be a good start for project that want to use Live2D model in Unreal Engine.

There will be **NO** Edtior part for this plugin.