Liver

About

Live2D¹ model viewer with support for animation.

Inspired by Azur Lane Live2D viewer².

Made possible with incredible wrapper³ for Cubism SDK.

Note

The whole library is copied to this project instead of a dependency in a Cargo.toml due to two necessary changes that had to be made in order for models I use to work:

• Motions in my models are under the "" key in model3.json, so the wrapper did not parse them in motion_references
• Restricted Beziers in motion3.json files
• Added support for getting screen and multiply colors

Installation

First refer to cubism-rs documentation to place Live2DCubismCore library appropriately. I added a helper file to not provide environment variable every time you wish to run cargo <action> command.

After that it is just as usual for rust projects:

cargo install --path .
liver waifu.model3.json

Optionally install provided liver.desktop file:

desktop-file-install --dir=$HOME/.local/share/applications ~/liver.desktop

Configuration

Place your config.toml in ~/.config/liver/ (or wherever the config folder on your system is generated, refer to confy documentation⁴).

Command-line arguments are supported. Short description is available via liver -help.

Config and its default parameters are as follows:

[window]
size = [800, 600]
title = 'Liver'
fit = 'Cover'

[window.bg]
variant = 'Color'
color = [0.0, 0.0, 0.0, 0.0]
image = ''

[model]
file = ''

[model.motions]
open = []
idle = ''

Window

Size

Logical size of initially created window. "Logical" means that your DPI is taken into account. I.e. if size is 800x600 with DPI 2 (192 in X11 terms), the actual size in pixels will be 1600x1200.

Command line configuration allows specifying size. Omitting height results in it being equal to width

Title

The only usage for it now (as it seems to me) is to add window to exceptions of your window manager by title.

Fit

Fit mode represents how the canvas will fit in the window. Currently two modes are supported:

• Cover: scaled and clipped, takes all the window
• Contain: scaled so that all the canvas is shown

Background

Two values for variant supported: Image and Color. Color is defined by color setting, which is an array of float RGBA values (four entries, 0.0 to 1.0). Image is set as a relative path image from configuration directory.

Both image and color are optional. Setting variant: 'Image' will fail with no image. Setting variant: 'Color' with no color with be clear transparent background equivalet to the following:

color = [0.0, 0.0, 0.0, 0.0]

Command line (unlike config file) allows specifying color as RGBA value. Alpha is optional, omitting results in opaque color (RRGGBBff).

Note

Background image is not affected by fit setting and always works as with Cover setting.

Model

File

Specifying file of model config file (`model3.json) to use.

Motions

Configuration of motions that will be played at the program start (open, can be an array), a motion fallback (idle) when motion queue is empty.

Specified as a 2-size array, as Live2D motions have classes. So, for example, if your model has the following motion file references:

{
  "FileReferences": {
    "Motions": {
      "Idle": [
        {
          "Name": "Idle",
          "File": "motions/Idle.motion3.json",
          "Weight": 1
        }
      ],
      "Tap": [
        {
          "Name": "Anim",
          "File": "motions/Anim_1.motion3.json",
          "Weight": 1
        }
      ]
    }
  }
}

Then configuring these motions should be done as follows:

[model.motions]
open = [
    ["Tap", "Anim_1"],
]
idle = ["Idle", "Idle"]

Note

Currently filenames are used for motion identification, not the Name field

Usage

Launch the app with liver, optionally provide command line arguments. Window with your model should open, unless you forgot to set it in configuration.

Playback can be controlled via bleed. The following argumets are accepted:

• set [class] <motion>: Sets the motion from the class with that name, if available. Class can be omitted, in that case it will be treated as ""
• queue [class] <motion>: Queues the motion from the class with that name, if available. Class can be omitted, in that case it will be treated as ""
• pause, play, toggle: self-explanatory
• exit: tells the program that you want to quit

Note

Queue differs from setting in a sense that setting starts motion immediately, potentially breaking animation, if triggered with bad timing, while queue always waits for the current animation to finish.

Xsecurelock⁵ is supported. Appropriate mode is launched based on a presence of XSCREENSAVER_WINDOW environment variable. Symlink app to the appropriate location with appropriate name (e.g. saver_liver), and it should work automagically.

Footnotes

1. https://www.live2d.com/en/ ↩

2. https://l2d.algwiki.moe/ ↩

3. Veykril/cubism-rs ↩

4. https://crates.io/crates/confy ↩

5. https://github.com/google/xsecurelock ↩