Difference between revisions of "Quests"

Revision as of 19:48, 2 September 2016

UNDER CONSTRUCTION.

Quests

This contains all the quests information. Each line that can be added to the file will be below.

[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.

[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!

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!

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

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.
SetPage\|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.
Award\| ExperienceAmount\| GoldAmount\| 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\|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.

[Info]