drincs-productions/nqtr

nqtr-activity

Use when creating NQTR activities (actions the player can take, linked to rooms/locations/maps) — ActivityBaseModel, RegisteredActivities, linking at init (activities in the room constructor) vs at runtime (room.addActivity / " add activity X in room"), unl…

Zobacz źródło

Jak używać

  1. Skopiuj polecenie instalacji i sprawdź źródła przed instalacją we własnym środowisku agenta.
  2. W oryginale sprawdź wymagane narzędzia, dane dostępowe i obsługiwane środowiska.
  3. Opisz dane wejściowe i oczekiwany rezultat; porównaj wynik ze źródłami.
npx skills add https://github.com/drincs-productions/nqtr --skill nqtr-activity

Przed rozpoczęciem

  • Instalacja nie obejmuje subskrypcji modelu, limitu API ani uprawnień do plików.
  • Gwiazdki i instalacje pokazują aktywność, a nie niezależny test jakości lub bezpieczeństwa.
Oryginalny dokument Skill

Treść z repozytorium z zachowaniem nagłówków, przykładów, kodu, tabel, linków i obrazów.

NQTR activities

Official docs: pixi-vn.com/nqtr/activity. Index: nqtr. Ink commands: nqtr-ink.

An activity is an action the player can take (sleep in the bed, order a product, ...) linked to a navigation element (rooms/locations/maps). How it is shown and triggered (button, icon, sprite) is up to your UI.

Initialize

new ActivityBaseModel(id, onRun, props); register with RegisteredActivities.add(...) (required). onRun(activity, props) receives the OnRunProps; typically navigate to the narration screen, then jump to the story label/knot. When the story is written in ink, jump to the ink knot with the same name.

ts
import { ActivityBaseModel, RegisteredActivities, timeTracker } from "@drincs/nqtr";
import { narration } from "@drincs/pixi-vn";

export const bed = new ActivityBaseModel(
    "bed",
    async (_, props) => {
        await props.navigate({ to: "/game/narration" });
        await narration.jump(timeTracker.nowIsBetween(5, 22) ? "nap" : "sleep", props);
    },
    { name: "bed" },
);

RegisteredActivities.add(bed);
ink
=== nap ===
mc: A short nap.
# wait 2
-> DONE

ActivityProps: name, timeSlot ({ from, to? }, active only in that time range), dateScheduling ({ from, to? }, active only in that date range), disabled / hidden (boolean or a Pixi'VN flag name), renderIcon.

Link (many-to-many)

An activity is only available when linked to a navigation element.

  1. At initialization — activities: ["bed"] in the room/location/map constructor. Not saved with the game, so you can change it between versions without migrations.
  2. During the game — saved with the game; for temporary activities.
ink
# add activity order_product in mc_room
ts
mcRoom.addActivity("order_product"); // or the activity instance

Unlink

Only activities linked at runtime can be removed:

ink
# remove activity order_product from mc_room
ts
mcRoom.removeActivity("order_product");

Init-time links cannot be removed; use disabled/hidden or timeSlot/dateScheduling to control them.

Get

RegisteredActivities.get(id) and RegisteredActivities.values(). activity.isActive(options?) tells whether it is available for the current time/date; activity.expired whether its date range has passed.

Custom class

Extend ActivityStoredClass and implement ActivityInterface; augment the interface in nqtr.d.ts with name, disabled, hidden, sprite?, icon?. Constructor: super(id, onRun, props) with ActivityStoredClassProps (timeSlot, dateScheduling). Persist disabled/hidden via getStorageProperty/setStorageProperty. Override isActive to return false when hidden, and run to refresh the UI after running (await runProps.invalidateInterfaceData()), as the templates do.

Pitfalls

  • Forgetting RegisteredActivities.add.
  • Linking by id before the activity is registered: register activities before use, or rely on the id lists/Vite plugin for validation.
  • Prefer a stable id: ink commands use it.
z tego samego repozytorium

Więcej Skills

Wszystkie Skills
drincs-productions
Społeczność

nqtr

Index and entry point of the NQTR skill set — start here for any task on a project using @drincs/nqtr (Navigation Quest Time Routine), then follow the skill map to the right skill (navigation, time, activity, routine, quest, ink). Use when installing/configuring @drincs/nqtr, wiring vitePluginNqtr, overriding OnRunProps or the Interface types in nqtr.d.ts, writing custom Room/Location/Map/Activity/Commitment/Quest classes, or deciding whether to write NQTR logic in ink or TypeScript.

Instalacje / 1h
3
GitHub Stars
2
Aktualizacja
17 lis
drincs-productions
Społeczność

nqtr-ink

Use when writing .ink files in a Pixi'VN project that uses @drincs/nqtr — every NQTR hashtag command ( enter room, set time, set date, wait, add/remove activity, add/remove routine, start/continue quest) and the quest state variables (questIdstarted, completed, failed, currentStageIndex), plus createNqtrHandler setup and options. Prefer this over TypeScript labels whenever ink is configured.

Instalacje / 1h
3
GitHub Stars
2
Aktualizacja
17 lis
drincs-productions
Społeczność

nqtr-navigation

Use when defining or navigating NQTR rooms, locations and maps — RoomBaseModel/LocationBaseModel/MapBaseModel, RegisteredRooms/RegisteredLocations/RegisteredMaps, navigator.currentRoom, " enter room" in ink, entrance rooms, and custom Room/Location/Map classes. Navigation is the base of NQTR; activities and routines attach to it.

Instalacje / 1h
3
GitHub Stars
2
Aktualizacja
17 lis
drincs-productions
Społeczność

nqtr-quest

Use when creating or driving NQTR quests — QuestBaseModel with StageBaseModel stages (onStart, deltaDateRequired, flags, questsRequired), RegisteredQuests, start/continue/advanceIfCompleted, failing a quest, state queries (started, completed, failed, currentStageIndex) and the ink commands " start quest", " continue quest" with the questIdstarted / currentStageIndex variables.

Instalacje / 1h
3
GitHub Stars
2
Aktualizacja
17 lis