The “nizima model specification” is a common specification that allows Live2D models (mainly moc3 and model3.json ) to respond to taps and flicks and change facial expressions on various applications by making simple settings.
We are currently working on specifications that will allow characters to move attractively on various applications, aiming for a wide range of uses, not limited to works on nizima.
Note: Please note that version 0.4 is a beta specification and may be modified in the future.
Update History
version 0.4 2020/11/2
Supported Apps
nizima Preview
Live2D work previews on the nizima service are compatible with the nizima model specification.
nizimas [nizima Desktop Mascot] alpha version
Live2D desktop mascot application provided by the Live2D nizima team.
Only the Win version has been released. the Mac version is in preparation.
My Live2D Clock
Live2D alarm app for smartphones from Karakuri-ism .Inc and nizima team of Live2D Inc.
Live wallpaper can also be set. iOS and Android versions have already been released.
Scheduled Supported Apps
July 2020 As of
Clarification of nizima model specification support
For models made in accordance with the “nizima model specification v0.4,” please state “nizima model specification compliant” in the work details, tags, etc., and describe which version (v0.4, etc.) and to what extent the model is compliant in the detailed description.
nizima model specification setting type
event motion
Define motions generated by user operations such as taps (clicks) and events such as timers.
Expression Setting
This will be a common specification to standardize emotional settings such as laughing, angry, sad, etc., and to be used as the character’s emotional expression in adventure games, etc.
Note: As of December 2019, there are no applications with full-scale support. nizima preview allows switching between expressions.
Facial (emotional) motion (under consideration)
We are currently discussing setting up motions to express emotions such as laughing, anger, etc.
event motion
Motion generated by user operations such as tapping (clicking) or events such as timers can be specified.
In Cubism Viewer (for OW), simply relate the motion ( motion3.json ) and specify the “group name” of each motion according to the following rules.
Event Name (Group Name) Rules
Idle (required)
When idling. Movement when there are no events.
Note: Three or more should be set up.
Start ( recommended ) *Added in v0.4
Motion played back when the character is displayed
Played at any time of the day
If “Start#Morning” or “Start#Night” is set, only that is played during that time period
Note: Specifications will be released in November 2020. The application will be supported in stages.
Start#Morning (optional)
Start#Night (optional)
Note: Added in v0.4
Motion played when the character is displayed and matches the specified time period.
This is used when you want to change the lines for the morning, afternoon, and evening appearances.
Specify the time of day with the following rules
Start#Morning Morning hours ( AM 04:00 – AM 11:00 )
Start#Night Night time ( PM 6:00 – AM 04:00 )
Start is played during other times than the above.
Note: Specifications will be released in November 2020. The application will be supported in stages.
Tap (recommended)
At one tap.
Note: When not in a touchable environment, at click
Tap@area (recommended)
When the specified area is tapped
Flick (recommended)
At one flick
The direction of the flick can be Any direction
Flick@area (recommended)
If ” @area” is added, it reacts when a flick is started from the specified area.
FlickUp (recommended)
FlickDown (recommended)
FlickLeft (recommended)
FlickRight (recommended)
Up: Flick from bottom to top
Down: Flick from top to bottom
Left: Flick from right to left
Right: Flick from left to right
FlickUp@area (recommended)
FlickDown@area (recommended)
FlickLeft@area (recommended)
FlickRight@area (recommended)
If ” @area” is added, it reacts when a flick is started from the specified area.
Example: Used for flipping goodwill upward, etc.
Flick3 (recommended)
Flick right, left, right, etc. 3 or more times
Example: movement equivalent to patting (currently under consideration for change in v0.4)
Flick3@area (recommended)
If ” @area” is added, it reacts when a flick is started from the specified area.
Shake (optional)
When you shake the smartphone
When you shake the window
Example: drunken movements when shaken, etc.
PinchIn (optional)
when scaled down
PinchOut (optional)
when scaled up
Alarm (under consideration)
Alarm
Hourly (under consideration)
time signal
Remarks: v1 is in the study phase (need specs for changing audio at different times, etc.)
Focus (under consideration)
Version v1.0 is in the consideration stage
FocusLost (under consideration)
Version v1.0 is in the consideration stage
How to set up event motion
The event motion setup for the “nizima model specification” will be set up for model3.json.
Note: model3.json is generated when exporting a model for built-in use ( moc3 ).
Note: If the export type is “nizima”, model3.json can be edited by extracting export.zip and preview.zip.
Setup on Cubism Viewer (for OW) installed with Cubism Editor for model3.json.
When you post your work to nizima
When uploading to nizima, you must set up both export.zip and preview.zip.
Normally, the only difference between export.zip and preview.zip is the texture resolution, so you can extract and set up export.zip, then reduce the texture resolution to preview.zip.
Note: Since there is a lot of work involved, in the future, we are considering the possibility of directly processing export.zip on Cubism Viewer and generating preview.zip from the Viewer, etc.
Event Motion Related
Set this as the group name for each motion when setting up model3.json in Cubism Viewer (for OW) so that it will respond to events on the corresponding application.
About area designation (Tap@area, etc.)
When Tap or Flick,
Tap@Body
Flick@Head
By specifying an area in this way, you can specify that the display will be triggered only when the area is tapped.
Note: The area name (e.g. Body) corresponds to the “Hit Area Name” of the hitAreas (hit areas) on Cubism Viewer.
How to set the hit area
If the art mesh is HitAreaHead when modeling, it is automatically extracted and becomes a hit area called Head. See the following for more details.
https://docs.live2d.com/cubism-sdk-manual/hitarea
Other Specifications
If the same event name (group name) is set for multiple motions, one of them will be played at random.
Idling (Idle), in particular, becomes more natural and attractive when three or more settings are used, repeating various movements.
Motion in Cubism Viewer (for OW) can include audio, so if audio is bind, it will be played.
Expression Setting
If your app is designed to give the character a state or emotion, you can set the expression by setting the name of exp3.json in expressions (expression settings) on Cubism Viewer (for OW) as follows, and exporting model3.json.
Click here to learn how to use the expression settings.
In Cubism Viewer as of Cubism 4.0.2, the file name is used as it is for facial expression names, so you need to create scene names such as Normal, Smile, etc. (exp3.json is not necessary) in advance when creating animation in Cubism Editor.
In Cubism Viewer 4.0.3 or later, expression names can be entered.
On applications that support the nizima model specification, implement the same recognition regardless of whether or not the extension of the expression name is present.
example: an expression name of “Smile” or “Smile.exp3.json” will work as a Smile expression.
| expression name (exp3.json Name) | Support in apps 対応 | Expression |
|---|---|---|
| Normal Normal.exp3.json | optional | usually |
| Smile Smile.exp3.json | optional | smile |
| Angry Angry.exp3.json | optional | angry |
| Sad Sad.exp3.json | optional | sad |
| Hungry Hungry.exp3.json | optional | hungry |
| Tired Tired.exp3.json | optional | tired |
| Surprised Surprised.exp3.json | optional | surprised |
| Scared Scared.exp3.json | optional | scared |
| Insane Insane.exp3.json | optional | insane |
| Blushing Blushing.exp3.json | optional | blush with embarrassment |