rathena/doc/quest_db.txt
Atemo f6bc10bfb1
Mob quest target (#7071)
* Added functionality to select monsters that increase the quest counter
* Removed the extra conditions on Id
* Added an example in quest_db.yml for MapMobTargets
* Clean-up the docs
* Added the possibility to define "All" to Location

Thanks to @aleos89 !
2022-07-14 19:00:48 +02:00

58 lines
2.8 KiB
Plaintext

//===== rAthena Documentation ================================
//= Quest Database Structure
//===== By: ==================================================
//= rAthena Dev Team
//===== Last Updated: ========================================
//= 20220629
//===== Description: =========================================
//= Explanation of the quest_db.yml file and structure.
//============================================================
---------------------------------------
Id: Quest ID.
---------------------------------------
Title: Quest title.
---------------------------------------
TimeLimit: Amount of time before the quest expires.
Use a number followed by "d" for day(s), "h" for hour(s), "mn" for minute(s), and "s" for second(s).
Specifying with "+" will mark how long until the quest expires.
Specifying without "+" will mark the exact time the quest expires. Format: "d" (optional), [0-23]"h" (required), [0-59]"mn" (optional), [0-59]"s" (optional).
Please note the number before "d" only shifts the exact timer to the given day(s).
---------------------------------------
Targets: Quest objective target.
The target can be a combination of Mob/Count or of Id/Count and other fields.
If Mob is supplied, Count is required and the other fields are ignored.
If Id is supplied, Count is required for each new entry.
- Mob Name of monster to kill (aegis monster name).
Count Amount of monsters to kill. Set to 0 to skip the target on import.
Id Unique target index for the quest Id. Requires a positive number.
Race Monster race target. (Default: All). Valid races are Angel, Brute, DemiHuman, Demon, Dragon, Fish, Formless, Insect, Plant, Undead, All.
Size Monster size target. (Default: All). Valid sizes are Small, Medium, Large, All.
Element Monster element target. (Default: All). Valid elements are Dark, Earth, Fire, Ghost, Holy, Neutral, Poison, Undead, Water, Wind, All.
MinLevel Minimum monster level target. If not supplied but MaxLevel defined, MinLevel is 1. Set to 0 to ignore MinLevel on import.
MaxLevel Maximum monster level target. Set to 0 to ignore MaxLevel on import.
Location Map name where kills are counted.
MapName Displayed map name in quest UI.
MapMobTargets List of monster names. Only names in the list will increase the kill counter. Only active when Id is used.
<name>: <bool> Monster name and whether the monster is added or removed from the list.
---------------------------------------
Drops: Quest item drop targets.
- Mob Monster to kill. 0 will apply to all monsters.
Item Item to drop (aegis item name).
Count Amount of items that will drop. Non-stackable items default to 1.
Rate Item drop rate. (10000 = 100%)