Add-ons/Player Quest System Engine (PQS)/Using quests

Lua add-on documentation: Player Quest System Engine (PQS) overview · Add-on hub · Contribute or update documentation

Using quests

PQS supplies the interface and progress engine for separately installed quest libraries. Everything is client-side: a quest can react to supported information but cannot change the game world, grant real items, award game experience, or make an NPC respond.

Install playable content

1. Install PQS, SES, and at least one compatible quest-library package through /addons.
2. Enable Run for all three layers. PQS itself contains no quests.
3. Select the PQS tray icon. It lights and can play a soft sound when something new needs attention.
4. Open the Quests browser to enable, disable, or reset an installed quest.

Disabling a quest stops its processing without uninstalling its library. Resetting deliberately discards that quest's local progress and reapplies its starting state; use the browser's confirmation rather than treating reset as routine troubleshooting.

Journal

The Journal keeps unread entries visually prominent and unfinished work above completed material. Depending on the quest, an entry may show a live timer, cooldown, gathered-item count, kill counter, or another author-defined progress line. Orange indicates continuing progress and green can indicate a satisfied or ready state.

Conversations and items

Conversations preserve a local transcript and show currently available responses. A quest author may gate a response with supported criteria, so choices can change with scene, quest variables, virtual items, or other observed state.

The Items window contains virtual quest items created by the library. They are PQS state, not objects in the character's game inventory. New or changed counts are marked until viewed.

Progress recognition

PQS evaluates quests about once per second and processes large quest collections across frames. Libraries can respond to scenes, location, health, inventory observations, buffs, party state, game time, chat/combat information, timers, cooldowns, random chance, virtual quest variables/items, and prior journal or dialog state. Gather and defeat goals can update live when the necessary supported event is available.

Because progress comes from observable client data, translated or changed chat text can affect criteria that depend on parsing. A library should state its language and exact supported objective names.

Convenience commands

The current package recognizes !pqsjournal to open the attention-aware journal view and !pqsquests to toggle the quest browser. The !pqsdebug family is intended for author diagnostics; ordinary players should use the windows.

See also

• PQS overview
• Quest libraries
• Configuration and troubleshooting