Interface AdvConfig

Hierarchy

  • AdvConfig

Properties

aspectRatio assets bgm canvasWidth cdn characters favicon features pages remote selectable showCharacterAvatar theme themeConfig title

Properties

aspectRatio

aspectRatio: number

Aspect ratio for game should be like 16/9 or 1:1

Default

'16/9'

assets

assets: { audio: Record<string, string>; background: Record<string, string>; images: Record<string, string> }

Type declaration

  • audio: Record<string, string>

    audio url

  • background: Record<string, string>

    background url

  • images: Record<string, string>

    other images

bgm

bgm: { autoplay: boolean; collection: Music[] }

Type declaration

  • autoplay: boolean

    auto play first bgm

  • collection: Music[]

canvasWidth

canvasWidth: number

The actual width for canvas. unit in px.

Default

'980'

cdn

cdn: { enable: boolean; prefix?: string }

Type declaration

  • enable: boolean
  • Optional prefix?: string

characters

characters: Character[]

all characters appear in the game

favicon

favicon: string

Default

'/favicon.svg'

features

features: AdvFeatureFlags

pages

pages: { start: { bg: string; darkBg?: string } }

global game config

Type declaration

  • start: { bg: string; darkBg?: string }

    Start Page

    • bg: string

      Path or URL

      Description

      :zh-CN 背景

    • Optional darkBg?: string

      Path or URL

      Description

      :zh-CN 暗色模式背景

Optional remote

remote?: boolean

selectable

selectable: boolean

Controls whether texts in slides are selectable

Default

false when debug is true

showCharacterAvatar

showCharacterAvatar: boolean

是否显示人物头像

Default

false

theme

theme: string

Theme to use for the advjs

Default

'default'

themeConfig

themeConfig: any

Default

title

title: string

Default

'ADV.JS'

Settings

Member Visibility

Theme

Generated using TypeDoc