API > AdvConfig

Interface: AdvConfig

Contents

• 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'

Source

packages/types/src/config/index.ts:36

---

assets

assets: object

Type declaration

audios

audios: Record<string, string>

audio url

background

background?: Record<string, string>

background url

images

images: Record<string, string>

other images

Source

packages/types/src/config/index.ts:98

---

bgm

bgm: object

Type declaration

autoplay

autoplay: boolean

auto play first bgm

collection

collection: Music[]

Source

packages/types/src/config/index.ts:90

---

canvasWidth

canvasWidth: number

The actual width for canvas. unit in px.

Default

'980'

Source

packages/types/src/config/index.ts:43

---

cdn

cdn: object

Type declaration

enable

enable: boolean

prefix

prefix?: string

Source

packages/types/src/config/index.ts:80

---

characters

characters: Character[]

all characters appear in the game

Source

packages/types/src/config/index.ts:88

---

favicon

favicon: string

Default

'/favicon.svg'

Source

packages/types/src/config/index.ts:16

---

features

features: AdvFeatureFlags

Source

packages/types/src/config/index.ts:27

---

pages

pages: object

global game config

Type declaration

start

start: object

Start Page

start.bg

start.bg: string

Path or URL @description:zh-CN 背景

start.darkBg

start.darkBg?: string

Path or URL @description:zh-CN 暗色模式背景

Source

packages/types/src/config/index.ts:56

---

remote

remote?: boolean

Source

packages/types/src/config/index.ts:7

---

selectable

selectable: boolean

Controls whether texts in slides are selectable

Default

false when debug is true

Source

packages/types/src/config/index.ts:49

---

showCharacterAvatar

showCharacterAvatar: boolean

是否显示人物头像

Default

false

Source

packages/types/src/config/index.ts:78

---

theme

theme: string

Theme to use for the advjs

Default

'default'

Source

packages/types/src/config/index.ts:21

---

themeConfig

themeConfig: any

Default

{}

Source

packages/types/src/config/index.ts:25

---

title

title: string

Default

'ADV.JS'

Source

packages/types/src/config/index.ts:12

---

Generated using typedoc-plugin-markdown and TypeDoc