Interface: VitePluginNqtrOptions

Defined in: src/vite/index.ts:61

Options for vitePluginNqtr.

Properties

activities?

> optional activities?: string | string[]

Defined in: src/vite/index.ts:69

Glob / path of module(s) whose side effects register activities via RegisteredActivities.add(...).

Examples

"./src/activities.ts"

"./src/activities/*.ts"

commitments?

> optional commitments?: string | string[]

Defined in: src/vite/index.ts:77

Glob / path of module(s) whose side effects register commitments via RegisteredCommitments.add(...).

Example

"./src/commitments.ts"

locations?

> optional locations?: string | string[]

Defined in: src/vite/index.ts:85

Glob / path of module(s) whose side effects register locations via RegisteredLocations.add(...).

Example

"./src/locations.ts"

maps?

> optional maps?: string | string[]

Defined in: src/vite/index.ts:93

Glob / path of module(s) whose side effects register maps via RegisteredMaps.add(...).

Example

"./src/maps.ts"

quests?

> optional quests?: string | string[]

Defined in: src/vite/index.ts:102

Glob / path of module(s) whose side effects register quests via RegisteredQuests.add(...).

Examples

"./src/quests.ts"

"./src/*.quest.ts"

rooms?

> optional rooms?: string | string[]

Defined in: src/vite/index.ts:110

Glob / path of module(s) whose side effects register rooms via RegisteredRooms.add(...).

Example

"./src/rooms.ts"

typeFilePath?

> optional typeFilePath?: string

Defined in: src/vite/index.ts:132

Path to the auto-generated TypeScript file that contains both:

• as const runtime arrays of all currently known entity IDs (e.g. nqtrActivityIds, nqtrRoomIds, …) — import these into createNqtrHandler for runtime validation of Ink hashtag commands.
• a declare module augmentation of the six Nqtr*Ids interfaces in @drincs/nqtr/registries — gives compile-time–safe ID types once the file is included in the project's TypeScript compilation.

When provided, the plugin generates (or overwrites) this file:

• after all content modules have been loaded at startup,
• after every hot-reload of a watched content file.

The generated file is excluded from HMR so that regenerating it never triggers a full-page reload.

The path may be absolute or relative to Vite root.

Example

"./src/nqtr.keys.gen.ts"