Custom Quests

The Custom Quests system adds server-defined quests with objectives and rewards, shown in an in-game quest log. It is free and always on. Players open the quest window with the O hotkey.

File Location#

Data/Plugins/Quests/

Each quest is its own .xml file in this folder. An optional Settings.xml in the same folder controls global limits. A _TEMPLATE - Quest Format Reference.xml reference file ships one level up, in Data/Plugins/, and is never loaded as a quest (see below).

Dependencies#

How Files Are Loaded#

The folder is scanned for *.xml in alphabetical order at startup.

• The quest id comes from the leading number of the filename, not from anything inside the XML. 015 - The Kundun Contract.xml becomes quest id 15. 7 - Foo.xml becomes quest id 7.
• Valid id range: 0 to 1023.
• A file whose name does not start with a number is skipped. The shipped _TEMPLATE ... reference file lives outside this folder anyway, and its leading _ would keep it from loading even if copied in. To turn it into a quest, copy it into Data/Plugins/Quests/ and rename it to NNN - Some Name.xml.
• Settings.xml is reserved and is never treated as a quest.
• If two files resolve to the same id, the first one loaded wins and later duplicates are skipped.

Quest Structure#

<Quest>
  <General .../>
  <Requirements .../>
  <Text>
    <Summary>...</Summary>
    <Description>...</Description>
  </Text>
  <Objectives>
    <Objective .../>
  </Objectives>
  <Rewards>
    <Reward .../>
  </Rewards>
</Quest>

The root <Quest> element is required or the file is ignored. Every child section is optional; a missing section uses the defaults below.

General#

Quest identity and repeat policy.

Requirements#

Level, reset, and class gating. All optional. A range bound of -1 means "no limit" for the reset and account-level fields.

Class tokens map to the base race, so each covers its evolutions:

Text#

Player-facing strings held as element text (not attributes). <Summary> is the short line in the list; <Description> is the detail-pane body and may wrap over multiple lines. Both default to empty.

Objectives#

Up to 8 objectives per quest. A 9th and beyond are ignored. Each <Objective> takes an optional Text attribute (the log line for that step). The other attributes depend on Type. Type is case-insensitive; an unrecognized value falls back to VisitMap.

Rewards#

Granted on turn-in. No hard cap on count. Type is case-insensitive; an unrecognized value falls back to UnlockQuest.

Settings.xml#

Optional file in the same folder. Absent = defaults.

<?xml version="1.0" encoding="utf-8"?>
<CustomQuest ActiveCap="5" DailyResetHour="0" WeeklyResetDay="1" RewardToInventory="0" />

Gameplay Event Hooks#

Quest objectives are driven by the GameServer's shared gameplay-event bus. The same bus feeds the paid Achievements plugin, so both systems see identical events and stay in sync.

Important Behavior#

• The quest id is the filename number, not any XML field. Renaming a file changes the quest identity and its stored progress binding.
• Item rewards do not yet apply Ancient, Durability, or Duration even though those attributes parse without error.
• After editing any file in this folder, reload the plugin or restart the GameServer for changes to take effect.

Examples#

<?xml version="1.0" encoding="utf-8"?>
<Quest>
  <General Name="Spider Cull" Category="Lorencia" Repeat="Daily" Enabled="1" />
  <Requirements MinLevel="6" MaxLevel="50" Classes="DW,DK,ELF,MG,DL,SUM,RF" />
  <Text>
    <Summary>Thin out the spiders near town.</Summary>
    <Description>The roads out of Lorencia are crawling with spiders. Clear eight of them.</Description>
  </Text>
  <Objectives>
    <Objective Type="KillMonster" MonsterClass="3" Count="8" Map="0"
               Text="Kill 8 Spiders in Lorencia" />
  </Objectives>
  <Rewards>
    <Reward Type="Zen" Amount="50000" />
    <Reward Type="Experience" Amount="10000" />
  </Rewards>
</Quest>

<?xml version="1.0" encoding="utf-8"?>
<Quest>
  <General Name="Bless Gathering" Category="Main" PrerequisiteQuestId="-1" Enabled="1" />
  <Requirements MinLevel="1" MaxLevel="400" />
  <Text>
    <Summary>Bring 10 Jewels of Bless.</Summary>
    <Description>Turn in ten Jewels of Bless to prove your worth.</Description>
  </Text>
  <Objectives>
    <Objective Type="CollectItem" ItemType="14" ItemIndex="13" Count="10" Consume="1"
               Text="Collect 10 Jewels of Bless" />
  </Objectives>
  <Rewards>
    <Reward Type="Item" ItemType="14" ItemIndex="11" Level="10" Count="1" />
    <Reward Type="UnlockQuest" QuestId="12" />
  </Rewards>
</Quest>

Common Issues#