Home

Live2D mascot 🪆 on your website!

Live2D Companion is a utility for webmasters like you to display your favorite live2D model on your website.

Screenshots

Features

• zip archive
• drag by mouse
• arbitary words by Json or Yaml

Technically

• use cache for faster load
• OffscreenCanvas

Usage

<!-- add some config as you need and insert it **before** the library -->
<script>
  const companionOption = {
    models: [
      "assets/models/Mao/Mao.model3.json",
      "assets/models/Hiyori/Hiyori.model3.json",
    ],
    wordsPosition: "bottom",
  };
</script>

<!-- and load the library via CDN -->
<script src="https://cdn.jsdelivr.net/gh/mo-san/live2d-companion/dist/indes.js"></script>

Config

Required property

You need to specify what to show by models property.

simple

const companionOption = {
  models: [
    "assets/models/Mao/Mao.model3.json",
    "assets/models/Hiyori/Hiyori.model3.json"
  ],
}

detailed

const companionOption = {
  models: [
    {
      path: "assets/models/Mao/Mao.zip",
      words: "assets/messages.example.yaml",
    },
    {
      path: "assets/models/Hiyori.zip",
      words: "assets/messages.example.json",
    },
  ],
}