Live2D Official Plugin - Compatible with Cubism 4

＞＞Live2D Official

Live2D is a technology that allows 2D images to be smoothly animated.
It has recently become popular in games and with VTubers.

Get the Sample Game Project File

*The sample project does not include `live2dcubismcore.min.js`. Please refer to the instructions on this page to download and place it in the `driver` folder, otherwise the plugin will not work.

The TyranoScript engine and the Live2D plugin can be used free of charge.

This plugin uses the Live2D Cubism SDK. If you use this plugin to create a game, you must agree to the Live2D Proprietary License.
https://www.live2d.jp/terms/live2d-proprietary-software-license-agreement/

This agreement is presented when you download Cubism Core for Web during the installation process.

Also, if you plan to release a game using this plugin, you must agree to the SDK Release License.

Check the Live2D SDK Release License

As of October 2020, individuals, students, circles, and small businesses with recent sales of less than 10 million yen can release their works for free.

Moreover, the Live2D model included in this plugin can be used in accordance with Live2D’s official guidelines.

[Guidelines] https://docs.live2d.com/cubism-editor-manual/sample-model/

Get the Latest live2d_tyrano_plugin_v410 Plugin (2024/2/13)

Get live2d_tyrano_plugin_v401 Plugin (2021/1/24)

Download one of the Live2D plugins above and extract it to a suitable location.

Next, download the development library from the official Live2D site. Access the following URL:

https://www.live2d.com/download/cubism-sdk/download-web/




Copy the obtained files into the following directory inside the plugin you downloaded earlier:
live2d/driver


Next, place the entire live2d folder into your Tyrano project at:
data/others/plugin



Then, in your first.ks file, add:

[plugin name="live2d"]


Next, in your make.ks file, add:

[live2d_restore ]


With this, Live2D is ready to be used with TyranoScript.

(Note: The line in make.ks is required in order to restore the Live2D model on load.)

For more details about the available tags and how to use them, it’s recommended to download the sample game above and review its script.

Place your Live2D model data inside the folder: data/others/plugin/live2d/model.

The name of the directory is the model ID.
In the image above, the model ID is “Haru”.

Now, you can display the Live2D model simply by writing the following tags:


[live2d_new name="haru" model_id="Haru" ]

; Display the Live2D model
[live2d_show name="haru" y=-0.8 x=0 scale=2.5 ]



That’s all it takes to display the model. Simple, isn’t it?

You can control Live2D animations at any desired timing.
To play an animation, use the [live2d_motion] tag.

Check the model data in a text editor to find the available motion names. For example, if the model ID is “Haru”,
open the file Haru.model3.json in a text editor.

Inside the file, you will find sections linking to motion files.



Specify the Name in the [live2d_motion] tag to control motion playback.

In this example, motion names include “Idle”, “Idle2”, “TapBody”, and “Test”.

Note that “Idle” refers to the default standing motion.

So, to play the “TapBody” motion, use:

[live2d_motion name="haru" mtn="TapBody" ]

This will play the TapBody motion.

Also, “TapBody” may include multiple motions in an array.
By default, the first motion is played, but you can specify another one using: [live2d_motion name="haru" mtn="TapBody" no=2 ]
Setting no=2 will play the second motion in the TapBody array (index starts at 0).

You can also change facial expressions using the [live2d_expression] tag.
Specify a name that is linked under the Expression section in the JSON file.
[live2d_expression name="haru" expression="f07"]

■ About Idle Motions

The motion that plays by default when the character is standing is “Idle”.
The motions set under “Idle” are played randomly in a loop.

To change the idle motion, use the [live2d_mod] tag:

[live2d_mod name="haru" idle="Test" ]

You can animate the character’s mouth while they are speaking.
Note that the model must support lip-sync.

First, when using [live2d_new], enable the lip-sync feature and specify the character’s display name using lip="text" and jname="Haru".

[live2d_new name="haru" model_id="Haru" lip=text jname="Haru"]
Then, if the name specified in the dialogue matches the jname, the mouth will animate while speaking.

[live2d_new name="haru" model_id="Haru" lip=true jname="Haru"]
#Haru
Haru is talking now.[p]
Am I speaking clearly?[p]

You can also adjust the mouth movement speed and other parameters, so be sure to experiment.

■Lip-sync with voice audio

It is also possible to sync mouth movements to voice audio.

This feature is supported from Live2D plugin version 401 and TyranoScript version V506 and later.

When defining the model, set lip="sound".
Optionally, you can specify which audio buffer (buf) to respond to using the lip_se parameter.
[live2d_new name="haru" model_id="Haru" lip="sound" lip_se="1" jname="Haru"]

In this example, the model will respond to sounds played with [playse buf=1 storage="voice.mp3"].

⚠️ Important: Without restrictions, the model may respond to all sounds, including background music (BGM).

To prevent BGM from triggering lip-sync, write it like this:

[playbgm storage="music.mp3" html5="true"]
When html5="true" is set, the sound will be ignored by the lip-sync system. This also applies to sound effects:

[playse storage="door.mp3" html5="true"]

With this setup, sounds will not trigger lip-sync.

When the game screen is enlarged beyond its default size,
sometimes the Live2D model appears in front of the message window.

As a solution:
1. Set the game screen size to be larger.

Or

2. Edit tyrano.css.

Open the file tyrano/tyrano.css in an editor and delete the line that contains 'position: absolute;'. .tyrano_base{
-moz-user-select: none;
-webkit-user-select: none;
-khtml-user-select: none;

position: absolute;
top: 0;
left: 0;
right: 0;
bottom: 0;
margin: auto;
}
However, note that with method ②, screen centering and camera functions will no longer work. Please be aware of this limitation.