suppayami / pixijs-live2d

PIXI.js 5 + Live2D Cubism 4

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pixijs-live2d

PIXI.js 5 + Live2D Cubism 4

How to build

  • Download the Cubism SDK for Web: https://www.live2d.com/en/download/cubism-sdk/
  • Copy all contents of SDK to cubism-sdk folder in root
  • Go to cubism-sdk/Framework and run npm i && npm run build
  • Go to root project, run npm i && npm run build

How to run demo

  • Download the Cubism SDK for Web: https://www.live2d.com/en/download/cubism-sdk/
  • Copy all contents of SDK to cubism-sdk folder in root
  • Go to cubism-sdk/Framework and run npm i && npm run build
  • Go to root project, run npm i && npm run start

How to use

  • Build the library and import the dist/pixi_live2d.browser.js into your project
  • See demo/main.ts to see basic how to use
  • Read all Public API section in src/live2d_model.ts for more functions

About

PIXI.js 5 + Live2D Cubism 4

License:MIT License


Languages

Language:TypeScript 85.5%Language:JavaScript 14.5%