@advjs/monorepo / @advjs/types / AdvConfig

Interface: AdvConfig<ThemeConfig>

Defined in: packages/types/src/config/adv.ts:11

游戏应用级别的配置

• 游戏内容位于 game.config.ts 中

Type Parameters

ThemeConfig

ThemeConfig = AdvThemeConfig

Properties

aspectRatio

aspectRatio: number

Defined in: packages/types/src/config/adv.ts:68

Zh

画面宽高比 Aspect ratio for game should be like 16/9 or 1:1

Default

'16/9'

---

canvasWidth

canvasWidth: number

Defined in: packages/types/src/config/adv.ts:75

The actual width for canvas. unit in px.

Default

'1920'

---

cdn

cdn: object

Defined in: packages/types/src/config/adv.ts:111

enable

enable: boolean

prefix?

optional prefix?: string

---

features

features: AdvFeatureFlags

Defined in: packages/types/src/config/adv.ts:58

Zh

特性开关

---

format

format: "fountain" | "flow"

Defined in: packages/types/src/config/adv.ts:41

游戏解析格式

• fountain(markdown): 以 Markdown 文本编辑为核心体验的解析方式
• flow(json): 以节点编辑器为开发工作流的节点解析方式

Default

'fountain'

---

gameConfig

gameConfig: Partial<AdvGameConfig>

Defined in: packages/types/src/config/adv.ts:141

gameConfig

---

logLevel

logLevel: LogLevel

Defined in: packages/types/src/config/adv.ts:18

consola 日志级别 (浏览器控制台)

use LogLevels.debug for debug

Default

'LogLevels.info'

---

pages

pages: object

Defined in: packages/types/src/config/adv.ts:87

global game config

start

start: object

Start Page

start.bg

bg: string

Path or URL

Zh

背景

start.darkBg?

optional darkBg?: string

Path or URL

Zh

暗色模式背景

---

plugins

plugins: AdvPlugin[]

Defined in: packages/types/src/config/adv.ts:156

---

preload?

optional preload?: boolean | { background?: boolean; type: "all" | "chapter"; }

Defined in: packages/types/src/config/adv.ts:119

开始游戏时是否预加载当前章节资源

Union Members

boolean

---

Type Literal

{ background?: boolean; type: "all" | "chapter"; }

background?

optional background?: boolean

是否在背后预加载

Default

true

type

type: "all" | "chapter"

预加载类型

• 'all': 预加载所有章节资源
• 'chapter': 仅预加载当前章节资源

Default

'chapter'

---

remote?

optional remote?: boolean

Defined in: packages/types/src/config/adv.ts:43

---

root?

optional root?: string

Defined in: packages/types/src/config/adv.ts:31

adv root

Zh

adv 根目录

• /<rootDir>/setups
• /<rootDir>/locales
• /<rootDir>/components
• /<rootDir>/layouts
• /<rootDir>/pages
• /<rootDir>/styles

---

runtimeConfig

runtimeConfig: object

Defined in: packages/types/src/config/adv.ts:152

DO NOT MODIFY THIS

canvasHeight

canvasHeight: number

Zh

运行时生成

---

selectable

selectable: boolean

Defined in: packages/types/src/config/adv.ts:81

Controls whether texts in slides are selectable

Default

false when debug is true

---

showCharacterAvatar

showCharacterAvatar: boolean

Defined in: packages/types/src/config/adv.ts:109

是否显示人物头像

Default

false

---

theme

theme: string

Defined in: packages/types/src/config/adv.ts:53

Theme to use for the advjs

Zh

UI 主题

Default

'default'

pnpm add @advjs/theme-default

---

themeConfig

themeConfig: ThemeConfig

Defined in: packages/types/src/config/adv.ts:146

Zh

主题配置 (取决于 theme)

Default

{}