Skip to content

Latest commit

 

History

History
74 lines (57 loc) · 4.49 KB

README_zh.md

File metadata and controls

74 lines (57 loc) · 4.49 KB
Raw

valaxy-addon-live2d

NPM version English documents

主题开发者可以通过将其作为依赖使用，以快速集成 live2d 看板娘组件。

Usage

pnpm install valaxy-addon-live2d

主题使用者

启用 live2d 看板娘

import { defineValaxyConfig } from 'valaxy'
import { addonLive2d } from 'valaxy-addon-live2d'

export default defineValaxyConfig({
  // 设置 valaxy-addon-live2d 配置项
  addons: [addonLive2d({})],
})

配置选项

export interface Live2dOptions {
  global?: boolean

  apiPath?: string
  cdnPath?: string
  live2dPath?: {
    baseUrl?: string | 'online' | 'local'
    live2dJS?: string
    waifuCSS?: string
    waifuTipsJS?: string
    waifuTipsJson?: string
  }
  tools?: Array<'hitokoto' | 'asteroids' | 'switch-model' | 'switch-texture' | 'photo' | 'info' | 'quit'>
}
配置项 描述 默认值
apiPath (可选) 用于指定 Live2D 模型API的基础路径 https://live2d.fghrsh.net/api/
cdnPath (可选) 用于指定 Live2D 模型资源的CDN基础路径 https://cdn.jsdelivr.net/gh/fghrsh/live2d_api/
live2dPath (可选) 用于指定 Live2D 模型和相关资源的配置项
live2dPath.baseUrl (可选) 设置'online'使用在线版的 Live2D 模型和相关资源、设置为'local'时会启用本地版的 Live2D 模型和相关资源，可自定义的 Live2D URL 路径前缀设置 https://fastly.jsdelivr.net/gh/stevenjoezhang/live2d-widget@latest/
live2dPath.live2dJS (可选) 用于指定存储 Live2D 核心文件的路径 https://fastly.jsdelivr.net/gh/stevenjoezhang/live2d-widget@latest/live2d.min.js
live2dPath.waifuCSS (可选) 用于指定存储 Live2D 样式表文件的路径 https://fastly.jsdelivr.net/gh/stevenjoezhang/live2d-widget@latest/waifu.css
live2dPath.waifuTipsJS (可选) 用于指定存储 Live2D 模型交互扩展的 JS 文件的路径 https://fastly.jsdelivr.net/gh/stevenjoezhang/live2d-widget@latest/waifu-tips.js
live2dPath.waifuTipsJson (可选) 用于指定存储 Live2D 模型交互提示语的 JSON 文件的路径 https://fastly.jsdelivr.net/gh/stevenjoezhang/live2d-widget@latest/waifu-tips.json
  • 当apiPath和cdnPath都填入的时候默认启用apiPath
  • live2dPath.baseUrl 设置了live2dPath中所有配置项的基本前缀路径。如果为单独的配置项（如live2dJS、waifuCSS等）指定了具体路径，则这些配置项将使用指定的路径，从而覆盖由baseUrl派生的默认路径设置

自定义 Live2D 文件

live2d.js                       // Live2D 核心
waifu.css                       // Live2D 看板娘 样式表
waifu-tips.js                   // Live2D 看板娘 交互扩展
waifu-tips.json                 // Live2D 看板娘 提示语

其他