# Interface: VitePluginNqtrOptions (/nqtr/vite/interfaces/VitePluginNqtrOptions)



Defined in: [src/vite/index.ts:61](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L61)

Options for [vitePluginNqtr](/nqtr/vite/functions/vitePluginNqtr).

## Properties [#properties]

### activities? [#activities]

\> `optional` **activities?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:69](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L69)

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

#### Examples [#examples]

```ts
"./src/activities.ts"
```

```ts
"./src/activities/*.ts"
```

***

### commitments? [#commitments]

\> `optional` **commitments?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:77](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L77)

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

#### Example [#example]

```ts
"./src/commitments.ts"
```

***

### locations? [#locations]

\> `optional` **locations?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:85](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L85)

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

#### Example [#example-1]

```ts
"./src/locations.ts"
```

***

### maps? [#maps]

\> `optional` **maps?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:93](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L93)

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

#### Example [#example-2]

```ts
"./src/maps.ts"
```

***

### quests? [#quests]

\> `optional` **quests?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:102](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L102)

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

#### Examples [#examples-1]

```ts
"./src/quests.ts"
```

```ts
"./src/*.quest.ts"
```

***

### rooms? [#rooms]

\> `optional` **rooms?**: `string` | `string`\[]

Defined in: [src/vite/index.ts:110](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L110)

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

#### Example [#example-3]

```ts
"./src/rooms.ts"
```

***

### typeFilePath? [#typefilepath]

\> `optional` **typeFilePath?**: `string`

Defined in: [src/vite/index.ts:132](https://github.com/DRincs-Productions/nqtr/blob/db22fe9e7612d547ff25befcc444cf095348917d/src/vite/index.ts#L132)

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 [#example-4]

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