@drincs/nqtr 1.0.3 → 1.1.2

package/README.md

@@ -1,6 +1,6 @@
 # Navigation Quest Time Routine (NQTR)
 
-![cover](https://github.com/user-attachments/assets/9b514c5c-8243-4cdd-9129-ca5e45caec62)
+![cover](https://github.com/user-attachments/assets/bf362f78-ea75-4b91-8dcb-4f8e7dbf9e9f)
 
 <p align="center">
   <a href="https://www.npmjs.com/package/@drincs/nqtr" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/nqtr?label=version" alt="npm version"></a>
@@ -22,6 +22,16 @@ To install the NQTR package in an existing JavaScript project, use one of the fo
 npm install @drincs/nqtr
 ```
 
+## Development
+
+Use Node.js 20.19.0 or newer to run the tests and use Vite 8. The release build uses `tsup@9` and requires Node.js 22.18.0 or newer. Package metadata does not enforce these versions.
+
+```sh
+npm ci
+npm test
+npm run build
+```
+
 ## Features
 
 NQTR provides the following features (the order is important):
@@ -31,3 +41,39 @@ NQTR provides the following features (the order is important):
 3. [Activity](https://pixi-vn.com/nqtr/activity)
 4. [Routine](https://pixi-vn.com/nqtr/routine)
 5. [Quest system](https://pixi-vn.com/nqtr/quest)
+
+## Agent Skills
+
+NQTR ships a set of [Agent Skills](https://www.skills.sh/) that teach AI coding assistants how to correctly use each part of the library. When a project uses Pixi’VN with ink, the skills prefer ink (hashtag commands such as `# enter room`, `# wait`, `# start quest`) over TypeScript labels.
+
+> In LM Studio Bionic, ask the agent to install skills from `https://github.com/DRincs-Productions/nqtr`, or add the skill files in **Settings → Skills**. To reuse skills installed for Codex or Claude Code, enable **Settings → Skills → Use skills found in other apps**.
+
+**Codex**:
+
+```npm
+npx skills@latest add DRincs-Productions/nqtr@latest --skill '*' --agent codex -g -y
+```
+
+**Claude Code**:
+
+```npm
+npx skills@latest add DRincs-Productions/nqtr@latest --skill '*' --agent claude-code -g -y
+```
+
+**Other agents**:
+
+```npm
+npx skills@latest add DRincs-Productions/nqtr@latest --all -y
+```
+
+Available skills:
+
+- `getting-started` (skill `nqtr`) — the index of the skill set: skill map, installation, registries, the Vite plugin, `OnRunProps`, custom classes
+- `ink` — every NQTR hashtag command and quest variable for `.ink` files
+- `navigation` — rooms, locations, maps and `navigator`
+- `time` — `timeTracker`, time slots, `wait`
+- `activity` — player actions linked to rooms
+- `routine` — character commitments (schedules)
+- `quest` — quests, stages and state queries
+
+Install them together with the [Pixi’VN](https://github.com/DRincs-Productions/pixi-vn) and [Pixi’VN ink](https://github.com/DRincs-Productions/pixi-vn-ink) skills.

package/dist/{StageInterface-BN_O8nDA.d.mts → StageInterface-DzhX29F-.d.mts}

@@ -43,6 +43,25 @@ interface ActiveScheduling {
 
 type ExecutionType = "automatic" | "interaction";
 
+/** biome-ignore-all lint/suspicious/noEmptyInterface: <explanation> */
+/**
+ * Object passed to the functions triggered by the system (e.g. {@link OnRunEvent}),
+ * allowing you to customize and access properties inside them.
+ *
+ * By default it is an empty interface. You can override it in your `.d.ts` file
+ * (module augmentation) to specify the required properties.
+ *
+ * @example
+ * ```ts title="nqtr.d.ts"
+ * import "@drincs/nqtr";
+ *
+ * declare module "@drincs/nqtr" {
+ *     interface OnRunProps {
+ *         navigate: (route: string) => void;
+ *     }
+ * }
+ * ```
+ */
 interface OnRunProps {
 }
 /**
@@ -360,4 +379,4 @@ interface StageBaseInternalInterface {
     readonly questsRequired: QuestsRequiredType[];
 }
 
-export type { ActivityInterface as A, CommitmentInterface as C, DateSchedulingInterface as D, ExecutionType as E, LocationInternalInterface as L, MapInterface as M, NavigationAbstractInterface as N, OnRunEvent as O, QuestInterface as Q, RoomInterface as R, StageInterface as S, TimeSchedulingInterface as T, QuestsRequiredType as a, ActivityBaseInternalInterface as b, ActiveScheduling as c, OnRunAsyncFunction as d, CommitmentBaseInternalInterface as e, OnRunProps as f, MapBaseInternalInterface as g, LocationInterface as h, RoomBaseInternalInterface as i, QuestBaseInternalInterface as j, StageBaseInternalInterface as k, OnRunFunction as l };
+export type { ActivityInterface as A, CommitmentInterface as C, DateSchedulingInterface as D, ExecutionType as E, LocationInternalInterface as L, MapInterface as M, NavigationAbstractInterface as N, OnRunEvent as O, QuestInterface as Q, RoomInterface as R, StageInterface as S, TimeSchedulingInterface as T, QuestsRequiredType as a, OnRunProps as b, ActivityBaseInternalInterface as c, ActiveScheduling as d, OnRunAsyncFunction as e, CommitmentBaseInternalInterface as f, MapBaseInternalInterface as g, LocationInterface as h, RoomBaseInternalInterface as i, QuestBaseInternalInterface as j, StageBaseInternalInterface as k, OnRunFunction as l };

package/dist/{StageInterface-BN_O8nDA.d.ts → StageInterface-DzhX29F-.d.ts}

@@ -43,6 +43,25 @@ interface ActiveScheduling {
 
 type ExecutionType = "automatic" | "interaction";
 
+/** biome-ignore-all lint/suspicious/noEmptyInterface: <explanation> */
+/**
+ * Object passed to the functions triggered by the system (e.g. {@link OnRunEvent}),
+ * allowing you to customize and access properties inside them.
+ *
+ * By default it is an empty interface. You can override it in your `.d.ts` file
+ * (module augmentation) to specify the required properties.
+ *
+ * @example
+ * ```ts title="nqtr.d.ts"
+ * import "@drincs/nqtr";
+ *
+ * declare module "@drincs/nqtr" {
+ *     interface OnRunProps {
+ *         navigate: (route: string) => void;
+ *     }
+ * }
+ * ```
+ */
 interface OnRunProps {
 }
 /**
@@ -360,4 +379,4 @@ interface StageBaseInternalInterface {
     readonly questsRequired: QuestsRequiredType[];
 }
 
-export type { ActivityInterface as A, CommitmentInterface as C, DateSchedulingInterface as D, ExecutionType as E, LocationInternalInterface as L, MapInterface as M, NavigationAbstractInterface as N, OnRunEvent as O, QuestInterface as Q, RoomInterface as R, StageInterface as S, TimeSchedulingInterface as T, QuestsRequiredType as a, ActivityBaseInternalInterface as b, ActiveScheduling as c, OnRunAsyncFunction as d, CommitmentBaseInternalInterface as e, OnRunProps as f, MapBaseInternalInterface as g, LocationInterface as h, RoomBaseInternalInterface as i, QuestBaseInternalInterface as j, StageBaseInternalInterface as k, OnRunFunction as l };
+export type { ActivityInterface as A, CommitmentInterface as C, DateSchedulingInterface as D, ExecutionType as E, LocationInternalInterface as L, MapInterface as M, NavigationAbstractInterface as N, OnRunEvent as O, QuestInterface as Q, RoomInterface as R, StageInterface as S, TimeSchedulingInterface as T, QuestsRequiredType as a, OnRunProps as b, ActivityBaseInternalInterface as c, ActiveScheduling as d, OnRunAsyncFunction as e, CommitmentBaseInternalInterface as f, MapBaseInternalInterface as g, LocationInterface as h, RoomBaseInternalInterface as i, QuestBaseInternalInterface as j, StageBaseInternalInterface as k, OnRunFunction as l };

package/dist/handlers.cjs

@@ -1 +1 @@
-'use strict';var storage=require('@drincs/pixi-vn/storage'),registries=require('@drincs/nqtr/registries'),core=require('@drincs/pixi-vn/core');var m="___nqtr-time_manager_data___",h="___nqtr-current_room_memory___",b="___nqtr-last_event_memory___";function f(u){storage.storage.set(b,u);}var a;(n=>(n.log=(o,...i)=>console.log(`[NQTR] ${o}`,...i),n.warn=(o,...i)=>console.warn(`[NQTR] ${o}`,...i),n.error=(o,...i)=>console.error(`[NQTR] ${o}`,...i),n.info=(o,...i)=>console.info(`[NQTR] ${o}`,...i)))(a||={});var p=class{get rooms(){return registries.RegisteredRooms.values()}get locations(){return registries.RegisteredLocations.values()}get maps(){return registries.RegisteredMaps.values()}get currentRoomId(){return storage.storage.get(h)}get currentRoom(){let e=this.currentRoomId;if(!e){a.error("The current room has not yet been set");return}let t=registries.RegisteredRooms.get(e);if(!t){a.error(`Current room ${e} not found`);return}return t}set currentRoom(e){if(typeof e!="string"&&(e=e.id),!registries.RegisteredRooms.get(e)){a.error(`The room ${e} is not registered, so it can't be set as current room`);return}let r=storage.storage.get(h);r!==e&&(f({type:"editroom",prev:r,value:e}),storage.storage.set(h,e));}get currentLocation(){return this.currentRoom?.location}get currentMap(){return this.currentRoom?.location.map}clearExpiredActivities(){registries.RegisteredRooms.values().forEach(e=>{e.clearExpiredActivities();});}};var g=class{get quests(){return registries.RegisteredQuests.values()}get startedQuests(){return this.quests.filter(e=>e.started)}get inProgressQuests(){return this.quests.filter(e=>e.inProgress)}get completedQuests(){return this.quests.filter(e=>e.completed)}get failedQuests(){return this.quests.filter(e=>e.failed)}get notStartedQuests(){return this.quests.filter(e=>!e.started)}find(e){return registries.RegisteredQuests.get(e)}async startsStageMustBeStarted(e){let t=this.quests.map(r=>r.currentStageMustStart?r.startCurrentStage(e):Promise.resolve());await Promise.all(t);}};var E="___nqtr-temporary_commitment___",y=class{get temporaryRoutine(){let e=storage.storage.get(E);if(e){if(Array.isArray(e)){if(e.length>0)throw new core.PixiError("obsolete_save","The save you loaded is not compatible with the current version of NQTR. Please delete the save and start a new game.");return {}}}else return {};return e}get commitmentsIds(){return [...registries.fixedCommitments.keys(),...Object.keys(this.temporaryRoutine)]}add(e,t,r={}){Array.isArray(e)||(e=[e]);let n=this.temporaryRoutine;e.forEach(o=>{let i=typeof o=="string"?o:o.id;n[i]={id:i,roomId:t,...r};}),storage.storage.set(E,n);}find(e){return registries.RegisteredCommitments.get(e)}remove(e,t){typeof e!="string"&&(e=e.id);let r=this.temporaryRoutine;r[e]?(!t||r[e].roomId===t)&&delete r[e]:a.warn(`The commitment ${e} was not found in the temporary routine, so it will be ignored. If you want to remove a fixed commitment, you can add it to the temporary routine with a same character.`),storage.storage.set(E,r);}clearExpiredRoutine(){registries.RegisteredCommitments.values().forEach(e=>{e.expired&&this.remove(e);});}get characterCommitments(){let e=this.temporaryRoutine;return this.commitmentsIds.reduce((t,r)=>{let n=registries.RegisteredCommitments.get(r),o=e[r],i=o?.roomId||registries.fixedCommitments.get(r);return i&&n?.isActive(o)&&(n.characters.length>0?n.characters.every(c=>!t[c.id]||n.priority>t[c.id][0].priority)&&n.characters.forEach(c=>{t[c.id]=[n,i];}):a.error(`The commitment ${n.id} has no characters assigned`)),t},{})}get currentRoutine(){return Object.values(this.characterCommitments).map(([e])=>e)}get roomCommitments(){return Object.values(this.characterCommitments).reduce((e,t)=>{let r=t[1];return e[r]||(e[r]=[]),e[r].push(t[0]),e},{})}getCommitmentByCharacter(e){let t=typeof e=="string"?e:e.id;return this.currentRoutine.find(r=>{if(r.characters.map(n=>n.id).includes(t))return r})}};var M={dayStartTime:0,dayEndTime:24,defaultTimeSpent:1,timeSlots:[],weekLength:7,weekendStartDay:6,getDayName:void 0},s=M;var l=class{initialize(e){let{dayStartTime:t=0,dayEndTime:r=24,defaultTimeSpent:n=1,timeSlots:o=[],weekLength:i=7,weekendStartDay:I=i-1,getDayName:c}=e;s.dayStartTime=t,s.dayEndTime=r,s.defaultTimeSpent=n,s.timeSlots=o,s.weekLength=i,I>=s.weekLength?console.warn(`[NQTR] Weekend start day should be less than week length ${i}, so will be ignored`):s.weekendStartDay=I,s.getDayName=c;}get dayStartTime(){return s.dayStartTime}get dayEndTime(){return s.dayEndTime}get defaultTimeSpent(){return s.defaultTimeSpent}get timeSlots(){return s.timeSlots}get weekLength(){return s.weekLength}get weekendStartDay(){return s.weekendStartDay}get getDayName(){return s.getDayName}get currentTime(){let e=storage.storage.get(m)||{};return Object.hasOwn(e,"currentTime")&&typeof e.currentTime=="number"?e.currentTime:this.dayStartTime}set currentTime(e){let t=storage.storage.get(m)||{},r={...t};typeof e=="number"?r.currentTime=e:delete r.currentTime,f({type:"edittime",prev:t,value:r}),storage.storage.set(m,r);}get currentDate(){let e=storage.storage.get(m)||{};return Object.hasOwn(e,"currentDate")&&typeof e.currentDate=="number"?e.currentDate:0}set currentDate(e){let t=storage.storage.get(m)||{},r={...t};typeof e=="number"?r.currentDate=e:delete r.currentDate,f({type:"edittime",prev:t,value:r}),storage.storage.set(m,r);}get isWeekend(){return this.currentWeekDayNumber>=this.weekendStartDay}get currentWeekDayNumber(){return this.currentDate%this.weekLength+1}get currentDayName(){return this.getDayName?this.getDayName(this.currentWeekDayNumber-1):(console.warn("[NQTR] Week days names are not defined, so currentDayName will be empty"),"")}get currentTimeSlot(){if(this.timeSlots.length===0)return console.warn("[NQTR] Time slots are not defined"),0;for(let e=0;e<this.timeSlots.length;e++){let t=this.timeSlots[e];if(this.timeSlots.length>e+1&&this.nowIsBetween(t.startTime,this.timeSlots[e+1].startTime))return e}return this.timeSlots.length-1}increaseTime(e=this.defaultTimeSpent){let t=this.currentTime+e;return t>=this.dayEndTime&&(this.increaseDate(),t=this.dayStartTime+(t-this.dayEndTime)),this.currentTime=t,this.currentTime}increaseDate(e=1,t=this.dayStartTime){let r=this.currentDate+e;return this.currentDate=r,this.currentTime=t,this.currentDate}nowIsBetween(e,t){e===void 0&&(e=this.dayStartTime-1),t===void 0&&(t=this.dayEndTime+1);let r=this.currentTime;return e<t?r>=e&&r<t:r>=e||r<t}};var se=new l,ae=new p,me=new y,ue=new g;exports.navigator=ae;exports.questsNotebook=ue;exports.routine=me;exports.timeTracker=se;
+'use strict';var storage=require('@drincs/pixi-vn/storage'),registries=require('@drincs/nqtr/registries'),core=require('@drincs/pixi-vn/core');var m="___nqtr-time_manager_data___",T="___nqtr-current_room_memory___",v="___nqtr-last_event_memory___";function f(u){storage.storage.set(v,u);}var s;(n=>(n.log=(a,...i)=>console.log(`[NQTR] ${a}`,...i),n.warn=(a,...i)=>console.warn(`[NQTR] ${a}`,...i),n.error=(a,...i)=>console.error(`[NQTR] ${a}`,...i),n.info=(a,...i)=>console.info(`[NQTR] ${a}`,...i)))(s||={});var p=class{get rooms(){return registries.RegisteredRooms.values()}get locations(){return registries.RegisteredLocations.values()}get maps(){return registries.RegisteredMaps.values()}get currentRoomId(){return storage.storage.get(T)}get currentRoom(){let e=this.currentRoomId;if(!e){s.error("The current room has not yet been set");return}let t=registries.RegisteredRooms.get(e);if(!t){s.error(`Current room ${e} not found`);return}return t}set currentRoom(e){if(typeof e!="string"&&(e=e.id),!registries.RegisteredRooms.get(e)){s.error(`The room ${e} is not registered, so it can't be set as current room`);return}let r=storage.storage.get(T);r!==e&&(f({type:"editroom",prev:r,value:e}),storage.storage.set(T,e));}get currentLocation(){return this.currentRoom?.location}get currentMap(){return this.currentRoom?.location.map}clearExpiredActivities(){registries.RegisteredRooms.values().forEach(e=>{e.clearExpiredActivities();});}};var l=class{get quests(){return registries.RegisteredQuests.values()}get startedQuests(){return this.quests.filter(e=>e.started)}get inProgressQuests(){return this.quests.filter(e=>e.inProgress)}get completedQuests(){return this.quests.filter(e=>e.completed)}get failedQuests(){return this.quests.filter(e=>e.failed)}get notStartedQuests(){return this.quests.filter(e=>!e.started)}find(e){return registries.RegisteredQuests.get(e)}async startsStageMustBeStarted(e){let t=this.quests.map(r=>r.currentStageMustStart?r.startCurrentStage(e):Promise.resolve());await Promise.all(t);}};var E="___nqtr-temporary_commitment___",g=class{get temporaryRoutine(){let e=storage.storage.get(E);if(e){if(Array.isArray(e)){if(e.length>0)throw new core.PixiError("obsolete_save","The save you loaded is not compatible with the current version of NQTR. Please delete the save and start a new game.");return {}}}else return {};return e}get commitmentsIds(){return [...registries.fixedCommitments.keys(),...Object.keys(this.temporaryRoutine)]}add(e,t,r={}){Array.isArray(e)||(e=[e]);let n=this.temporaryRoutine;e.forEach(a=>{let i=typeof a=="string"?a:a.id;n[i]={id:i,roomId:t,...r};}),storage.storage.set(E,n);}find(e){return registries.RegisteredCommitments.get(e)}remove(e,t){typeof e!="string"&&(e=e.id);let r=this.temporaryRoutine;r[e]?(!t||r[e].roomId===t)&&delete r[e]:s.warn(`The commitment ${e} was not found in the temporary routine, so it will be ignored. If you want to remove a fixed commitment, you can add it to the temporary routine with a same character.`),storage.storage.set(E,r);}clearExpiredRoutine(){registries.RegisteredCommitments.values().forEach(e=>{e.expired&&this.remove(e);});}get characterCommitments(){let e=this.temporaryRoutine;return this.commitmentsIds.reduce((t,r)=>{let n=registries.RegisteredCommitments.get(r),a=e[r],i=a?.roomId||registries.fixedCommitments.get(r);return i&&n?.isActive(a)&&(n.characters.length>0?n.characters.every(c=>!t[c.id]||n.priority>t[c.id][0].priority)&&n.characters.forEach(c=>{t[c.id]=[n,i];}):s.error(`The commitment ${n.id} has no characters assigned`)),t},{})}get currentRoutine(){return Object.values(this.characterCommitments).map(([e])=>e)}get roomCommitments(){return Object.values(this.characterCommitments).reduce((e,t)=>{let r=t[1];return e[r]||(e[r]=[]),e[r].push(t[0]),e},{})}getCommitmentByCharacter(e){let t=typeof e=="string"?e:e.id;return this.currentRoutine.find(r=>{if(r.characters.map(n=>n.id).includes(t))return r})}};var M={dayStartTime:0,dayEndTime:24,defaultTimeSpent:1,timeSlots:[],weekLength:7,weekendStartDay:6,getDayName:void 0},o=M;var y=class{initialize(e){let{dayStartTime:t=0,dayEndTime:r=24,defaultTimeSpent:n=1,timeSlots:a=[],weekLength:i=7,weekendStartDay:I=i-1,getDayName:c}=e;o.dayStartTime=t,o.dayEndTime=r,o.defaultTimeSpent=n,o.timeSlots=a,o.weekLength=i,I>=o.weekLength?console.warn(`[NQTR] Weekend start day should be less than week length ${i}, so will be ignored`):o.weekendStartDay=I,o.getDayName=c;}get dayStartTime(){return o.dayStartTime}get dayEndTime(){return o.dayEndTime}get defaultTimeSpent(){return o.defaultTimeSpent}get timeSlots(){return o.timeSlots}get weekLength(){return o.weekLength}get weekendStartDay(){return o.weekendStartDay}get getDayName(){return o.getDayName}get currentTime(){let e=storage.storage.get(m)||{};return Object.hasOwn(e,"currentTime")&&typeof e.currentTime=="number"?e.currentTime:this.dayStartTime}set currentTime(e){let t=storage.storage.get(m)||{},r={...t};typeof e=="number"?r.currentTime=e:delete r.currentTime,f({type:"edittime",prev:t,value:r}),storage.storage.set(m,r);}get currentDate(){let e=storage.storage.get(m)||{};return Object.hasOwn(e,"currentDate")&&typeof e.currentDate=="number"?e.currentDate:0}set currentDate(e){let t=storage.storage.get(m)||{},r={...t};typeof e=="number"?r.currentDate=e:delete r.currentDate,f({type:"edittime",prev:t,value:r}),storage.storage.set(m,r);}get isWeekend(){return this.currentWeekDayNumber>=this.weekendStartDay}get currentWeekDayNumber(){return this.currentDate%this.weekLength+1}get currentDayName(){return this.getDayName?this.getDayName(this.currentWeekDayNumber-1):(console.warn("[NQTR] Week days names are not defined, so currentDayName will be empty"),"")}get currentTimeSlot(){if(this.timeSlots.length===0)return console.warn("[NQTR] Time slots are not defined"),0;for(let e=0;e<this.timeSlots.length;e++){let t=this.timeSlots[e];if(this.timeSlots.length>e+1&&this.nowIsBetween(t.startTime,this.timeSlots[e+1].startTime))return e}return this.timeSlots.length-1}increaseTime(e=this.defaultTimeSpent){let t=this.currentTime+e;return t>=this.dayEndTime&&(this.increaseDate(),t=this.dayStartTime+(t-this.dayEndTime)),this.currentTime=t,this.currentTime}increaseDate(e=1,t=this.dayStartTime){let r=this.currentDate+e;return this.currentDate=r,this.currentTime=t,this.currentDate}nowIsBetween(e,t){e===void 0&&(e=this.dayStartTime-1),t===void 0&&(t=this.dayEndTime+1);let r=this.currentTime;return e<t?r>=e&&r<t:r>=e||r<t}};var oe=new y,se=new p,me=new g,ue=new l;exports.navigator=se;exports.questsNotebook=ue;exports.routine=me;exports.timeTracker=oe;

package/dist/handlers.d.mts

@@ -1,5 +1,5 @@
-export { n as navigator, q as questsNotebook, r as routine, t as timeTracker } from './index-D0T0L2IE.mjs';
-import './StageInterface-BN_O8nDA.mjs';
+export { n as navigator, q as questsNotebook, r as routine, t as timeTracker } from './index-CT-JfKIo.mjs';
+import './StageInterface-DzhX29F-.mjs';
 import '@drincs/pixi-vn/storage';
 import '@drincs/nqtr/registries';
 import '@drincs/pixi-vn';

package/dist/handlers.d.ts

@@ -1,5 +1,5 @@
-export { n as navigator, q as questsNotebook, r as routine, t as timeTracker } from './index-CtxMgD9N.js';
-import './StageInterface-BN_O8nDA.js';
+export { n as navigator, q as questsNotebook, r as routine, t as timeTracker } from './index-DehHTT06.js';
+import './StageInterface-DzhX29F-.js';
 import '@drincs/pixi-vn/storage';
 import '@drincs/nqtr/registries';
 import '@drincs/pixi-vn';

package/dist/handlers.mjs

@@ -1 +1 @@
-import {storage}from'@drincs/pixi-vn/storage';import {RegisteredRooms,RegisteredLocations,RegisteredMaps,RegisteredQuests,fixedCommitments,RegisteredCommitments}from'@drincs/nqtr/registries';import {PixiError}from'@drincs/pixi-vn/core';var m="___nqtr-time_manager_data___",h="___nqtr-current_room_memory___",b="___nqtr-last_event_memory___";function f(u){storage.set(b,u);}var a;(n=>(n.log=(o,...i)=>console.log(`[NQTR] ${o}`,...i),n.warn=(o,...i)=>console.warn(`[NQTR] ${o}`,...i),n.error=(o,...i)=>console.error(`[NQTR] ${o}`,...i),n.info=(o,...i)=>console.info(`[NQTR] ${o}`,...i)))(a||={});var p=class{get rooms(){return RegisteredRooms.values()}get locations(){return RegisteredLocations.values()}get maps(){return RegisteredMaps.values()}get currentRoomId(){return storage.get(h)}get currentRoom(){let e=this.currentRoomId;if(!e){a.error("The current room has not yet been set");return}let t=RegisteredRooms.get(e);if(!t){a.error(`Current room ${e} not found`);return}return t}set currentRoom(e){if(typeof e!="string"&&(e=e.id),!RegisteredRooms.get(e)){a.error(`The room ${e} is not registered, so it can't be set as current room`);return}let r=storage.get(h);r!==e&&(f({type:"editroom",prev:r,value:e}),storage.set(h,e));}get currentLocation(){return this.currentRoom?.location}get currentMap(){return this.currentRoom?.location.map}clearExpiredActivities(){RegisteredRooms.values().forEach(e=>{e.clearExpiredActivities();});}};var g=class{get quests(){return RegisteredQuests.values()}get startedQuests(){return this.quests.filter(e=>e.started)}get inProgressQuests(){return this.quests.filter(e=>e.inProgress)}get completedQuests(){return this.quests.filter(e=>e.completed)}get failedQuests(){return this.quests.filter(e=>e.failed)}get notStartedQuests(){return this.quests.filter(e=>!e.started)}find(e){return RegisteredQuests.get(e)}async startsStageMustBeStarted(e){let t=this.quests.map(r=>r.currentStageMustStart?r.startCurrentStage(e):Promise.resolve());await Promise.all(t);}};var E="___nqtr-temporary_commitment___",y=class{get temporaryRoutine(){let e=storage.get(E);if(e){if(Array.isArray(e)){if(e.length>0)throw new PixiError("obsolete_save","The save you loaded is not compatible with the current version of NQTR. Please delete the save and start a new game.");return {}}}else return {};return e}get commitmentsIds(){return [...fixedCommitments.keys(),...Object.keys(this.temporaryRoutine)]}add(e,t,r={}){Array.isArray(e)||(e=[e]);let n=this.temporaryRoutine;e.forEach(o=>{let i=typeof o=="string"?o:o.id;n[i]={id:i,roomId:t,...r};}),storage.set(E,n);}find(e){return RegisteredCommitments.get(e)}remove(e,t){typeof e!="string"&&(e=e.id);let r=this.temporaryRoutine;r[e]?(!t||r[e].roomId===t)&&delete r[e]:a.warn(`The commitment ${e} was not found in the temporary routine, so it will be ignored. If you want to remove a fixed commitment, you can add it to the temporary routine with a same character.`),storage.set(E,r);}clearExpiredRoutine(){RegisteredCommitments.values().forEach(e=>{e.expired&&this.remove(e);});}get characterCommitments(){let e=this.temporaryRoutine;return this.commitmentsIds.reduce((t,r)=>{let n=RegisteredCommitments.get(r),o=e[r],i=o?.roomId||fixedCommitments.get(r);return i&&n?.isActive(o)&&(n.characters.length>0?n.characters.every(c=>!t[c.id]||n.priority>t[c.id][0].priority)&&n.characters.forEach(c=>{t[c.id]=[n,i];}):a.error(`The commitment ${n.id} has no characters assigned`)),t},{})}get currentRoutine(){return Object.values(this.characterCommitments).map(([e])=>e)}get roomCommitments(){return Object.values(this.characterCommitments).reduce((e,t)=>{let r=t[1];return e[r]||(e[r]=[]),e[r].push(t[0]),e},{})}getCommitmentByCharacter(e){let t=typeof e=="string"?e:e.id;return this.currentRoutine.find(r=>{if(r.characters.map(n=>n.id).includes(t))return r})}};var M={dayStartTime:0,dayEndTime:24,defaultTimeSpent:1,timeSlots:[],weekLength:7,weekendStartDay:6,getDayName:void 0},s=M;var l=class{initialize(e){let{dayStartTime:t=0,dayEndTime:r=24,defaultTimeSpent:n=1,timeSlots:o=[],weekLength:i=7,weekendStartDay:I=i-1,getDayName:c}=e;s.dayStartTime=t,s.dayEndTime=r,s.defaultTimeSpent=n,s.timeSlots=o,s.weekLength=i,I>=s.weekLength?console.warn(`[NQTR] Weekend start day should be less than week length ${i}, so will be ignored`):s.weekendStartDay=I,s.getDayName=c;}get dayStartTime(){return s.dayStartTime}get dayEndTime(){return s.dayEndTime}get defaultTimeSpent(){return s.defaultTimeSpent}get timeSlots(){return s.timeSlots}get weekLength(){return s.weekLength}get weekendStartDay(){return s.weekendStartDay}get getDayName(){return s.getDayName}get currentTime(){let e=storage.get(m)||{};return Object.hasOwn(e,"currentTime")&&typeof e.currentTime=="number"?e.currentTime:this.dayStartTime}set currentTime(e){let t=storage.get(m)||{},r={...t};typeof e=="number"?r.currentTime=e:delete r.currentTime,f({type:"edittime",prev:t,value:r}),storage.set(m,r);}get currentDate(){let e=storage.get(m)||{};return Object.hasOwn(e,"currentDate")&&typeof e.currentDate=="number"?e.currentDate:0}set currentDate(e){let t=storage.get(m)||{},r={...t};typeof e=="number"?r.currentDate=e:delete r.currentDate,f({type:"edittime",prev:t,value:r}),storage.set(m,r);}get isWeekend(){return this.currentWeekDayNumber>=this.weekendStartDay}get currentWeekDayNumber(){return this.currentDate%this.weekLength+1}get currentDayName(){return this.getDayName?this.getDayName(this.currentWeekDayNumber-1):(console.warn("[NQTR] Week days names are not defined, so currentDayName will be empty"),"")}get currentTimeSlot(){if(this.timeSlots.length===0)return console.warn("[NQTR] Time slots are not defined"),0;for(let e=0;e<this.timeSlots.length;e++){let t=this.timeSlots[e];if(this.timeSlots.length>e+1&&this.nowIsBetween(t.startTime,this.timeSlots[e+1].startTime))return e}return this.timeSlots.length-1}increaseTime(e=this.defaultTimeSpent){let t=this.currentTime+e;return t>=this.dayEndTime&&(this.increaseDate(),t=this.dayStartTime+(t-this.dayEndTime)),this.currentTime=t,this.currentTime}increaseDate(e=1,t=this.dayStartTime){let r=this.currentDate+e;return this.currentDate=r,this.currentTime=t,this.currentDate}nowIsBetween(e,t){e===void 0&&(e=this.dayStartTime-1),t===void 0&&(t=this.dayEndTime+1);let r=this.currentTime;return e<t?r>=e&&r<t:r>=e||r<t}};var se=new l,ae=new p,me=new y,ue=new g;export{ae as navigator,ue as questsNotebook,me as routine,se as timeTracker};
+import {storage}from'@drincs/pixi-vn/storage';import {RegisteredRooms,RegisteredLocations,RegisteredMaps,RegisteredQuests,fixedCommitments,RegisteredCommitments}from'@drincs/nqtr/registries';import {PixiError}from'@drincs/pixi-vn/core';var m="___nqtr-time_manager_data___",T="___nqtr-current_room_memory___",v="___nqtr-last_event_memory___";function f(u){storage.set(v,u);}var s;(n=>(n.log=(a,...i)=>console.log(`[NQTR] ${a}`,...i),n.warn=(a,...i)=>console.warn(`[NQTR] ${a}`,...i),n.error=(a,...i)=>console.error(`[NQTR] ${a}`,...i),n.info=(a,...i)=>console.info(`[NQTR] ${a}`,...i)))(s||={});var p=class{get rooms(){return RegisteredRooms.values()}get locations(){return RegisteredLocations.values()}get maps(){return RegisteredMaps.values()}get currentRoomId(){return storage.get(T)}get currentRoom(){let e=this.currentRoomId;if(!e){s.error("The current room has not yet been set");return}let t=RegisteredRooms.get(e);if(!t){s.error(`Current room ${e} not found`);return}return t}set currentRoom(e){if(typeof e!="string"&&(e=e.id),!RegisteredRooms.get(e)){s.error(`The room ${e} is not registered, so it can't be set as current room`);return}let r=storage.get(T);r!==e&&(f({type:"editroom",prev:r,value:e}),storage.set(T,e));}get currentLocation(){return this.currentRoom?.location}get currentMap(){return this.currentRoom?.location.map}clearExpiredActivities(){RegisteredRooms.values().forEach(e=>{e.clearExpiredActivities();});}};var l=class{get quests(){return RegisteredQuests.values()}get startedQuests(){return this.quests.filter(e=>e.started)}get inProgressQuests(){return this.quests.filter(e=>e.inProgress)}get completedQuests(){return this.quests.filter(e=>e.completed)}get failedQuests(){return this.quests.filter(e=>e.failed)}get notStartedQuests(){return this.quests.filter(e=>!e.started)}find(e){return RegisteredQuests.get(e)}async startsStageMustBeStarted(e){let t=this.quests.map(r=>r.currentStageMustStart?r.startCurrentStage(e):Promise.resolve());await Promise.all(t);}};var E="___nqtr-temporary_commitment___",g=class{get temporaryRoutine(){let e=storage.get(E);if(e){if(Array.isArray(e)){if(e.length>0)throw new PixiError("obsolete_save","The save you loaded is not compatible with the current version of NQTR. Please delete the save and start a new game.");return {}}}else return {};return e}get commitmentsIds(){return [...fixedCommitments.keys(),...Object.keys(this.temporaryRoutine)]}add(e,t,r={}){Array.isArray(e)||(e=[e]);let n=this.temporaryRoutine;e.forEach(a=>{let i=typeof a=="string"?a:a.id;n[i]={id:i,roomId:t,...r};}),storage.set(E,n);}find(e){return RegisteredCommitments.get(e)}remove(e,t){typeof e!="string"&&(e=e.id);let r=this.temporaryRoutine;r[e]?(!t||r[e].roomId===t)&&delete r[e]:s.warn(`The commitment ${e} was not found in the temporary routine, so it will be ignored. If you want to remove a fixed commitment, you can add it to the temporary routine with a same character.`),storage.set(E,r);}clearExpiredRoutine(){RegisteredCommitments.values().forEach(e=>{e.expired&&this.remove(e);});}get characterCommitments(){let e=this.temporaryRoutine;return this.commitmentsIds.reduce((t,r)=>{let n=RegisteredCommitments.get(r),a=e[r],i=a?.roomId||fixedCommitments.get(r);return i&&n?.isActive(a)&&(n.characters.length>0?n.characters.every(c=>!t[c.id]||n.priority>t[c.id][0].priority)&&n.characters.forEach(c=>{t[c.id]=[n,i];}):s.error(`The commitment ${n.id} has no characters assigned`)),t},{})}get currentRoutine(){return Object.values(this.characterCommitments).map(([e])=>e)}get roomCommitments(){return Object.values(this.characterCommitments).reduce((e,t)=>{let r=t[1];return e[r]||(e[r]=[]),e[r].push(t[0]),e},{})}getCommitmentByCharacter(e){let t=typeof e=="string"?e:e.id;return this.currentRoutine.find(r=>{if(r.characters.map(n=>n.id).includes(t))return r})}};var M={dayStartTime:0,dayEndTime:24,defaultTimeSpent:1,timeSlots:[],weekLength:7,weekendStartDay:6,getDayName:void 0},o=M;var y=class{initialize(e){let{dayStartTime:t=0,dayEndTime:r=24,defaultTimeSpent:n=1,timeSlots:a=[],weekLength:i=7,weekendStartDay:I=i-1,getDayName:c}=e;o.dayStartTime=t,o.dayEndTime=r,o.defaultTimeSpent=n,o.timeSlots=a,o.weekLength=i,I>=o.weekLength?console.warn(`[NQTR] Weekend start day should be less than week length ${i}, so will be ignored`):o.weekendStartDay=I,o.getDayName=c;}get dayStartTime(){return o.dayStartTime}get dayEndTime(){return o.dayEndTime}get defaultTimeSpent(){return o.defaultTimeSpent}get timeSlots(){return o.timeSlots}get weekLength(){return o.weekLength}get weekendStartDay(){return o.weekendStartDay}get getDayName(){return o.getDayName}get currentTime(){let e=storage.get(m)||{};return Object.hasOwn(e,"currentTime")&&typeof e.currentTime=="number"?e.currentTime:this.dayStartTime}set currentTime(e){let t=storage.get(m)||{},r={...t};typeof e=="number"?r.currentTime=e:delete r.currentTime,f({type:"edittime",prev:t,value:r}),storage.set(m,r);}get currentDate(){let e=storage.get(m)||{};return Object.hasOwn(e,"currentDate")&&typeof e.currentDate=="number"?e.currentDate:0}set currentDate(e){let t=storage.get(m)||{},r={...t};typeof e=="number"?r.currentDate=e:delete r.currentDate,f({type:"edittime",prev:t,value:r}),storage.set(m,r);}get isWeekend(){return this.currentWeekDayNumber>=this.weekendStartDay}get currentWeekDayNumber(){return this.currentDate%this.weekLength+1}get currentDayName(){return this.getDayName?this.getDayName(this.currentWeekDayNumber-1):(console.warn("[NQTR] Week days names are not defined, so currentDayName will be empty"),"")}get currentTimeSlot(){if(this.timeSlots.length===0)return console.warn("[NQTR] Time slots are not defined"),0;for(let e=0;e<this.timeSlots.length;e++){let t=this.timeSlots[e];if(this.timeSlots.length>e+1&&this.nowIsBetween(t.startTime,this.timeSlots[e+1].startTime))return e}return this.timeSlots.length-1}increaseTime(e=this.defaultTimeSpent){let t=this.currentTime+e;return t>=this.dayEndTime&&(this.increaseDate(),t=this.dayStartTime+(t-this.dayEndTime)),this.currentTime=t,this.currentTime}increaseDate(e=1,t=this.dayStartTime){let r=this.currentDate+e;return this.currentDate=r,this.currentTime=t,this.currentDate}nowIsBetween(e,t){e===void 0&&(e=this.dayStartTime-1),t===void 0&&(t=this.dayEndTime+1);let r=this.currentTime;return e<t?r>=e&&r<t:r>=e||r<t}};var oe=new y,se=new p,me=new g,ue=new l;export{se as navigator,ue as questsNotebook,me as routine,oe as timeTracker};

package/dist/index-CT-JfKIo.d.mts

@@ -0,0 +1,367 @@
+import { R as RoomInterface, h as LocationInterface, M as MapInterface, C as CommitmentInterface, d as ActiveScheduling, Q as QuestInterface } from './StageInterface-DzhX29F-.mjs';
+import { RoomIdType, CommitmentIdType } from '@drincs/nqtr/registries';
+import { CharacterInterface, CharacterIdType } from '@drincs/pixi-vn';
+import { OnRunProps } from '@drincs/nqtr';
+
+type TimeSlotInterface = {
+    name: string;
+    startTime: number;
+};
+/**
+ * Time Settings, which can be set using {@link timeTracker.editSettings}
+ */
+type TimeSettings = {
+    /**
+     * Minimum time of the day
+     * @default 0
+     */
+    dayStartTime?: number;
+    /**
+     * Maximum time of the day
+     * @default 24
+     */
+    dayEndTime?: number;
+    /**
+     * Default time spent
+     * @default 1
+     */
+    defaultTimeSpent?: number;
+    /**
+     * Time slots
+     * @default []
+     * @example
+     * ```ts
+     * [
+     *   { name: 'Morning', startTime: 5 },
+     *   { name: 'Afternoon', startTime: 12 },
+     *   { name: 'Evening', startTime: 18 },
+     *   { name: 'Night', startTime: 22 }
+     * ]
+     */
+    timeSlots?: TimeSlotInterface[];
+    /**
+     * Week length
+     * @default 7
+     */
+    weekLength?: number;
+    /**
+     * Weekend start day. For example, if the real life weekend starts on Saturday, then the value should be 6
+     * @default weekLength - 1
+     */
+    weekendStartDay?: number;
+    /**
+     * Week days name
+     * @param weekDayNumber The current week day number (from: 0 - to: {@link weekLength} - 1).
+     * @returns The name of the week day.
+     * @example
+     * ```ts
+     * (weekDayNumber: number) => {
+     *     const weekDaysNames = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'];
+     *     return weekDaysNames[weekDayNumber];
+     * }
+     * ```
+     */
+    getDayName?: (weekDayNumber: number) => string;
+};
+
+/**
+ * Handler that manages the navigation system: it gives access to all the registered
+ * rooms, locations and maps, and keeps track of the room where the player currently is.
+ */
+interface NavigatorHandlerInterface {
+    /**
+     * All the registered rooms.
+     */
+    readonly rooms: RoomInterface[];
+    /**
+     * All the registered locations.
+     */
+    readonly locations: LocationInterface[];
+    /**
+     * All the registered maps.
+     */
+    readonly maps: MapInterface[];
+    /**
+     * The id of the room where the player currently is, read from the game storage.
+     * It is `undefined` if the current room has not been set yet.
+     */
+    readonly currentRoomId: string | undefined;
+    /**
+     * The room where the player currently is.
+     * Getting it returns `undefined` (and logs an error) if the current room has not been set
+     * or if it is not registered.
+     *
+     * Setting it accepts a room or a room id. If the room is not registered, an error is logged
+     * and nothing changes. If it is already the current room, nothing happens; otherwise
+     * the change is stored and tracked as the last event.
+     */
+    get currentRoom(): RoomInterface | undefined;
+    set currentRoom(room: RoomInterface | RoomIdType);
+    /**
+     * The location that contains the current room, or `undefined` if there is no current room.
+     */
+    readonly currentLocation: LocationInterface | undefined;
+    /**
+     * The map that contains the current location, or `undefined` if there is no current room.
+     */
+    readonly currentMap: MapInterface | undefined;
+    /**
+     * Clear all the expired activities from every registered room.
+     */
+    clearExpiredActivities(): void;
+}
+
+/**
+ * Handler that manages the routine of the characters: the commitments (fixed or added during the
+ * game session) and the rooms where they take place.
+ */
+interface RoutineHandlerInterface {
+    /**
+     * The ids of all the commitments: the fixed ones and the ones added during the game session.
+     */
+    readonly commitmentsIds: string[];
+    /**
+     * The commitments that are currently active, grouped by character id.
+     * Each value is a tuple with the commitment and the id of the room where it takes place.
+     * If a character has two or more commitments at the same time, only the one with the highest priority is kept.
+     */
+    readonly characterCommitments: {
+        [character: string]: [CommitmentInterface, string];
+    };
+    /**
+     * The current commitments. The hidden commitments are not included.
+     * In case there is a character who has two or more commitments at the same time, will be selected the commitment with the highest priority.
+     * Higher priority commitments are calculated using the following steps:
+     * 1. The commitments that have Commitments BaseModel.priority set to a higher value will be selected first.
+     * 2. If there are commitments with the same priority, the commitments that are not fixed will be selected first.
+     * 3. If there are commitments with the same priority and the same fixed status, priority will be given to the commitment with a lower index.
+     */
+    readonly currentRoutine: CommitmentInterface[];
+    /**
+     * The current commitments grouped by the id of the room where they take place.
+     */
+    readonly roomCommitments: {
+        [roomId: string]: CommitmentInterface[];
+    };
+    /**
+     * Add commitments during the game session.
+     * @param commitment The commitment or commitments (or their ids) to add.
+     * @param roomId The id of the room where the commitment is.
+     * @param options The scheduling options of the commitment (e.g. when it starts and ends).
+     */
+    add(commitment: (CommitmentInterface | CommitmentIdType)[] | CommitmentInterface | CommitmentIdType, roomId: string, options?: ActiveScheduling): void;
+    /**
+     * Get a registered commitment by its id.
+     * @param id The id of the commitment.
+     * @returns The commitment or undefined if not found.
+     */
+    find(id: string): CommitmentInterface | undefined;
+    /**
+     * Remove a commitment added during the game session. Fixed commitments can't be removed.
+     * @param commitment The commitment or commitment id to remove.
+     * @param roomId If set, the commitment is removed only if it was added to this room.
+     */
+    remove(commitment: CommitmentInterface | CommitmentIdType, roomId?: string): void;
+    /**
+     * Clear all the expired commitments.
+     */
+    clearExpiredRoutine(): void;
+    /**
+     * Get the current commitment of a character.
+     * @param character The character or the character id.
+     * @returns The commitment or undefined if not found.
+     */
+    getCommitmentByCharacter(character: CharacterInterface | CharacterIdType): CommitmentInterface | undefined;
+}
+
+/**
+ * Handler that manages the quests registered in the game.
+ */
+interface QuestHandlerInterface {
+    /**
+     * The quests registered in the game.
+     */
+    readonly quests: QuestInterface[];
+    /**
+     * The quests that are started, so they are in progress or completed or failed.
+     */
+    readonly startedQuests: QuestInterface[];
+    /**
+     * The quests that are in progress.
+     */
+    readonly inProgressQuests: QuestInterface[];
+    /**
+     * The quests that are completed.
+     */
+    readonly completedQuests: QuestInterface[];
+    /**
+     * The quests that are failed.
+     */
+    readonly failedQuests: QuestInterface[];
+    /**
+     * The quests that are not started.
+     */
+    readonly notStartedQuests: QuestInterface[];
+    /**
+     * Get the quest by the id.
+     * @param id The id of the quest.
+     * @returns The quest with the id, or `undefined` if not found.
+     */
+    find(id: string): QuestInterface | undefined;
+    /**
+     * Start the current stage of every quest whose current stage must be started automatically.
+     * @param props The props passed to the functions triggered by the stages. See {@link OnRunProps}.
+     */
+    startsStageMustBeStarted(props: OnRunProps): Promise<void>;
+}
+
+/**
+ * Handler that manages the time of the game: the current time and date, the day/week structure
+ * and the time slots.
+ */
+interface TimeHandlerInterface {
+    /**
+     * Set the time settings. Omitted values fall back to their defaults.
+     * @param settings The time settings.
+     */
+    initialize(settings: TimeSettings): void;
+    /**
+     * The time at which a day starts.
+     */
+    readonly dayStartTime: number;
+    /**
+     * The time at which a day ends. When the time reaches it, the date increases.
+     */
+    readonly dayEndTime: number;
+    /**
+     * The default time spent by {@link increaseTime} when no delta is given.
+     */
+    readonly defaultTimeSpent: number;
+    /**
+     * The time slots of a day (e.g. morning, afternoon, evening).
+     */
+    readonly timeSlots: TimeSlotInterface[];
+    /**
+     * The number of days in a week.
+     */
+    readonly weekLength: number;
+    /**
+     * The week day (starting from 0) from which the weekend starts.
+     */
+    readonly weekendStartDay: number;
+    /**
+     * Week days name
+     * @param weekDayNumber The current week day number (from: 0 - to: {@link weekLength} - 1).
+     * @returns The name of the week day.
+     * @example
+     * ```ts
+     * (weekDayNumber: number) => {
+     *     const weekDaysNames = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'];
+     *     return weekDaysNames[weekDayNumber];
+     * }
+     * ```
+     */
+    readonly getDayName: ((weekDayNumber: number) => string) | undefined;
+    /**
+     * The current time. Time is a numeric variable used to determine and manage time during a day/date.
+     * It's recommended to use currentTime as if it were the current time. If you also want to manage minutes, you can use a float value.
+     * Setting it to `undefined` resets it to {@link dayStartTime}.
+     */
+    get currentTime(): number;
+    set currentTime(value: number | undefined);
+    /**
+     * The current date. Date is a numeric variable used to determine and manage the number of days passed.
+     * It's recommended to use currentDate as if it were the current day.
+     * Setting it to `undefined` resets it to 0.
+     */
+    get currentDate(): number;
+    set currentDate(value: number | undefined);
+    /**
+     * If the current day is greater than or equal to the weekend start day, then it will return true.
+     */
+    readonly isWeekend: boolean;
+    /**
+     * The current week day number (from: 1 - to: {@link weekLength}).
+     * For example, if the week length is 7 and the current day is 10, then the result will be 4.
+     */
+    readonly currentWeekDayNumber: number;
+    /**
+     * The current week day name. If the week days names are not defined, then it will return an empty string.
+     * For example, if the week days names are ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'] and the current day is 10, then the result will be 'Thursday'.
+     * @default ""
+     */
+    readonly currentDayName: string;
+    /**
+     * The index of the current time slot in {@link timeSlots}.
+     * You can use this property to create "Image that changes based on the time period":
+     * @example
+     * ```tsx
+     * import { timeTracker } from '@drincs/nqtr';
+     *
+     * function changeBackground() {
+     *     return (
+     *         <img src={`background-${timeTracker.currentTimeSlot}.png`} />
+     *     )
+     * }
+     * ```
+     */
+    readonly currentTimeSlot: number;
+    /**
+     * Increase the current time by the given time spent.
+     * If the new time is greater than or equal to {@link dayEndTime}, then it will increase the day and set the new time.
+     * @param delta The time spent (default: {@link defaultTimeSpent}).
+     * @returns The new current time.
+     */
+    increaseTime(delta?: number): number;
+    /**
+     * Increase the current date by the given delta.
+     * @param delta The number of days to increase (default: 1).
+     * @param time The time of the new day (default: {@link dayStartTime}).
+     * @returns The new current date.
+     */
+    increaseDate(delta?: number, time?: number): number;
+    /**
+     * Check if the current time is between the given times.
+     * @param fromTime The starting time. If the {@link currentTime} is equal to this time, the function will return true. If undefined, the day start is used.
+     * @param toTime The ending time. If undefined, the day end is used.
+     * @returns true if the current time is between the given times, otherwise false.
+     */
+    nowIsBetween(fromTime: number | undefined, toTime: number | undefined): boolean;
+}
+
+/**
+ * The global time manager instance. It handles the current time and date, the week structure
+ * (week length, weekend, day names) and the time slots of the day.
+ */
+declare const timeTracker: TimeHandlerInterface;
+/**
+ * The global navigator instance. It gives access to the registered maps, locations and rooms,
+ * and it keeps track of the room where the player currently is (saved and restored with the game state).
+ */
+declare const navigator: NavigatorHandlerInterface;
+/**
+ * The global routine manager instance. It handles the commitments of the characters (fixed or added
+ * during the game session), the rooms where they take place and the current routine of each character.
+ */
+declare const routine: RoutineHandlerInterface;
+/**
+ * The global quests manager instance. It gives access to the registered quests, filtered by their
+ * state (not started, in progress, completed, failed), and it starts the stages that must start automatically.
+ */
+declare const questsNotebook: QuestHandlerInterface;
+
+declare const handlers_navigator: typeof navigator;
+declare const handlers_questsNotebook: typeof questsNotebook;
+declare const handlers_routine: typeof routine;
+declare const handlers_timeTracker: typeof timeTracker;
+declare namespace handlers {
+  export {
+    handlers_navigator as navigator,
+    handlers_questsNotebook as questsNotebook,
+    handlers_routine as routine,
+    handlers_timeTracker as timeTracker,
+  };
+}
+
+export { handlers as h, navigator as n, questsNotebook as q, routine as r, timeTracker as t };
+export type { NavigatorHandlerInterface as N, QuestHandlerInterface as Q, RoutineHandlerInterface as R, TimeSlotInterface as T, TimeHandlerInterface as a, TimeSettings as b };