(→Part 2) |
|||
| Line 10: | Line 10: | ||
*ExtraTotal=''The amount of quests requirements needed to be completed using script functions.'' | *ExtraTotal=''The amount of quests requirements needed to be completed using script functions.'' | ||
*ExtraItems=''The amount of inventory slots required for quest awards given by the script system. If the inventory slots free is lower then this number, the script will not continue.'' | *ExtraItems=''The amount of inventory slots required for quest awards given by the script system. If the inventory slots free is lower then this number, the script will not continue.'' | ||
| + | *AccountQuest=''If this is a account bound quest.'' | ||
| + | *AccountOneChar=''If AccountQuest is true, then having this true allows only one character to complete it. '' | ||
| + | *Expire=''How many server resets until this is quest is removed and they have to restart.'' | ||
| + | *RecommendedPlayers=''The recommended player count to run this quest.'' | ||
| + | *AdditionalInfo=''Any additoinal info can be added here. It also can be changed per page (check below for details!)'' | ||
====[Requirement]==== | ====[Requirement]==== | ||
| Line 18: | Line 23: | ||
*Race=''The race name the player needs to be to accept this quest. Works with [RACEREQUIREMENT] below.'' | *Race=''The race name the player needs to be to accept this quest. Works with [RACEREQUIREMENT] below.'' | ||
*Level=''The level the player needs to be to accept this quest. Works with [LEVELREQUIREMENT] below.'' | *Level=''The level the player needs to be to accept this quest. Works with [LEVELREQUIREMENT] below.'' | ||
| − | * | + | *Virtue=''The amount of virtue points needed to accept this quest. Works with [VIRTUEREQUIREMENT] below.'' |
| − | + | ||
====[Kills]==== | ====[Kills]==== | ||
| Line 39: | Line 43: | ||
=====Page Details===== | =====Page Details===== | ||
| + | *AdditionalInfo=''This changes the additional quest details which can be used to update the quest tab if you have changes. I.E. Go from NPC A to NPC B after completing the requirements.'' | ||
*Info=''This is the details that are displayed on the page, aka, the NPC talking.'' | *Info=''This is the details that are displayed on the page, aka, the NPC talking.'' | ||
*Reply-X=''Replace X with 1 to 6. This is the reply you will give to the NPC. Up to 6 options can be created.'' | *Reply-X=''Replace X with 1 to 6. This is the reply you will give to the NPC. Up to 6 options can be created.'' | ||
| Line 68: | Line 73: | ||
| Page|PageNumber || ''This will change the page number and display the contents. This Should NOT be used on page 0. Does not update the player GUI if added here and can be used once someone closes hte page.'' | | Page|PageNumber || ''This will change the page number and display the contents. This Should NOT be used on page 0. Does not update the player GUI if added here and can be used once someone closes hte page.'' | ||
|- | |- | ||
| − | | Award| ExperienceAmount| GoldAmount| | + | | Award| ExperienceAmount| GoldAmount| VirtueAmount|ChampionMarkAmount|Item1| Item1Count| Item2| Item2Count| Item3| Item3Count... || ''Award the player with experience, gold, and items. More then one item can be added, for example: 'Award|1000|500|0|0|Azure Potion|5|Long Sword|1' will award the player with 1000 experience, 500 gold, 5 azure potions, and 1 long sword. Item count can be maximum of the stack of the item. You do not need to include items if they are not required as a award.'' |
|- | |- | ||
| ProgressAndScript || ''Progress and Script together as above described.'' | | ProgressAndScript || ''Progress and Script together as above described.'' | ||
| Line 104: | Line 109: | ||
*Info=''The race requirement needed to take on this quest.'' | *Info=''The race requirement needed to take on this quest.'' | ||
| − | =====[ | + | =====[VirtueRequirement]===== |
| − | *Info=''The | + | *Info=''The virtue points requirement needed to take on this quest.'' |
| − | + | ||
| − | + | ||
| − | + | ||
Revision as of 15:42, 5 October 2018
Contents
Quests
This contains all the quests information. Each line that can be added to the file will be below. For details on how to add it too NPCs, read [[1]]!
[Main]
- ID=The quest ID, as a number. This must be unique to other quests (typically you name this the same as the file name.
- Name=The name of the quest.
- Giver=The quest giver's name.
- Location=The area or location of the quest.
- Extra=The script quest requirement that is displayed on the text.
- ExtraTotal=The amount of quests requirements needed to be completed using script functions.
- ExtraItems=The amount of inventory slots required for quest awards given by the script system. If the inventory slots free is lower then this number, the script will not continue.
- AccountQuest=If this is a account bound quest.
- AccountOneChar=If AccountQuest is true, then having this true allows only one character to complete it.
- Expire=How many server resets until this is quest is removed and they have to restart.
- RecommendedPlayers=The recommended player count to run this quest.
- AdditionalInfo=Any additoinal info can be added here. It also can be changed per page (check below for details!)
[Requirement]
- Quest=The quest the player needs to have finished to start this quest. This is not required on the same NPC that gives quests in a line as they assume that you need the previous quest to continue. Works with [QUESTREQUIREMENT] below.
- Page=This works with the quest requirement above. Instead of the player needing the quest to be complete, they need to be at a certain page to advance instead (I.E. The middle of the quest). This is good for things such as needing to talk to another person before continuing the current quest. Works with [PAGEREQUIREMENT] below.
- CompleteQuest=The quest the player needs to have finished to complete this quest. Works with [COMPLETEREQUIREMENT] below.
- Class=The class name the player needs to be to accept this quest. Works with [CLASSREQUIREMENT] below.
- Race=The race name the player needs to be to accept this quest. Works with [RACEREQUIREMENT] below.
- Level=The level the player needs to be to accept this quest. Works with [LEVELREQUIREMENT] below.
- Virtue=The amount of virtue points needed to accept this quest. Works with [VIRTUEREQUIREMENT] below.
[Kills]
This is a dynamic field area. You should define the NPC name and the amount of kills required. For example: 'Snake=3' would mean that one of the requirements would be killing a snake 3 times. One NPC per line! Works with [COMPLETEREQUIREMENT] below.
- NPCName=Amount of kills.
[Items]
This is a dynamic field area. You should define the item name and the amount of items required. For example: 'Wine=3' would mean that one of the requirements would be giving the giver 3 wine. One item per line! Works with [COMPLETEREQUIREMENT] below.
- ItemName=Amount to give.
[Pages]
Page details. This is where most of the magic happens.
[Page-0]
The default/start page. At the moment, The first page should have an accept value somewhere to continue, Otherwise the quest will not be able to continue. More info for pages will be below.
[Page-X]
Replace X with a number. This will be the page number of the quest. The page number should be above 0, and you can skip pages or use different numbers to make sections. More info for pages will be below..
Page Details
- AdditionalInfo=This changes the additional quest details which can be used to update the quest tab if you have changes. I.E. Go from NPC A to NPC B after completing the requirements.
- Info=This is the details that are displayed on the page, aka, the NPC talking.
- Reply-X=Replace X with 1 to 6. This is the reply you will give to the NPC. Up to 6 options can be created.
- Answer-X=Replace X with 1 to 6. This is what will happen when the user selects the corresponding Reply answer. The following can be used, split into two parts:
Part 1
| Accept|PageNumber | This will accept the quest, change the page, and close the quest window. When the user opens up the quest window again, it will be on the designated page. Change PageNumber to a page number you will define. Should be used ONLY on page 0. |
| AcceptandPage|PageNumber | This will accept the quest and change the page. Change PageNumber to a page number you will define. Should be used ONLY on page 0. |
| Close | This will close the window without doing anything. Typically you will want to ensure there is some sort of close function on each page. |
| CloseAndPage|PageNumber | This will close the window and change the page so next time they open up the window it will display a new page. Change PageNumber to a page number you will define. Should NOT be used on page 0. |
| Page|PageNumber | This will change the page number and display the contents. This is good for dialog that requires more then one page. Change PageNumber to a page number you will define. Should NOT be used on page 0. |
| Remove | This will remove the quest. Removing the quest will allow them to do the quest again in a later date. Good for canceling. Should NOT be used on page 0. |
| Complete | Complete the quest. Will show the completion page. Quests completed will get removed from the quest book and will NOT be able to run at a later date, unless the quest is a daily/weekly/etc. Should NOT be used on page 0. |
| CompleteNoPage | Complete the quest with no extra page. Will close the quest window. Quests completed will get removed from the quest book and will NOT be able to run at a later date, unless the quest is a daily/weekly/etc. Should NOT be used on page 0. |
Part 2
| Script | This will add a script that is outside the normal quest checks. For example, a script could check the time and only allow a quest to be completed at night time. This does not include the script requirements check, which is handled in the 'process' area and has nothing to do with additional script requirements. |
| Progress | This will verify that all the requirements have been met, insuring that kills, items, script requirements are met. If combine with other values, progress will come first always. (I.E. If Progress and Award are combined, it will check requirements first, then award if the requirements are valid. |
| Page|PageNumber | This will change the page number and display the contents. This Should NOT be used on page 0. Does not update the player GUI if added here and can be used once someone closes hte page. |
| Award| ExperienceAmount| GoldAmount| VirtueAmount|ChampionMarkAmount|Item1| Item1Count| Item2| Item2Count| Item3| Item3Count... | Award the player with experience, gold, and items. More then one item can be added, for example: 'Award|1000|500|0|0|Azure Potion|5|Long Sword|1' will award the player with 1000 experience, 500 gold, 5 azure potions, and 1 long sword. Item count can be maximum of the stack of the item. You do not need to include items if they are not required as a award. |
| ProgressAndScript | Progress and Script together as above described. |
| ProgressAndAward | Progress and Award together as above described. This is normally a good option to check quest progress and award an item if the requirements are met. |
| AwardAndScript | Award and Script together as above described. |
| All | Progress, Award, and Script together as above described. |
Complete/Fail Messages
These are the complete or fail messages that can be said. They end the quest or wait for a requirement. All the 'requirement' messages have defaults if left blank.
[Complete]
- Info=This is the completion message when you have finished the quest.
- TimeLock=If the quest can be run again, this will unlock it after X days. X should be the number of server resets until it unlocks again. Good for making daily or weekly quests.
[CompleteRequirement]
- Info=The message if you attempt to complete when all the requirements have not been met.
[QuestRequirement]
- Info=The message if another quest needs to be complete before this one (I.E. Talk to someone else first!).
[PageRequirement]
- Info=If a player needs to be not only on a certain quest, but also a page number to continue, this will be the message you will get.
[LevelRequirement]
- Info=The level requirement needed to take on this quest.
[ClassRequirement]
- Info=The class requirement needed to take on this quest.
[RaceRequirement]
- Info=The race requirement needed to take on this quest.
[VirtueRequirement]
- Info=The virtue points requirement needed to take on this quest.