PH Quest Book

PH Quest Book

Publish Date: June 06, 2016

Introduction

  • Script that allows you to create a quest book that can be managed by a single common event and plugin commands.

License

Download

Configuration

  • Download the JS file and include it into the /plugins folder of your project.
  • Open the Plugin Manager, select the file PH_QuestBook.js, and turn it on.
  • Create a Common Event called PHQuestBook
  • Add comments in this Common Event to create quests (the pattern for creating comments are below)
  • Add the quest you've created into the quest book using the plugin command PHQuestBook add Title_of_the_quest
  • IMPORTANT: If you were using the versions 1.3.1 and you want to see the documentation, go to this projects' GitHub page and find a folder called "1.3.1". There will be the entire documentation. However, if you want to update from the version 1.3.1 to 2.0, read the full documentation again to adapt the old setting to the new ones! I do not recommend updating if your project is above 70% done.

Plugin Commands

  • PHQuestBook add Title_of_the_quest
    Add a quest in the book
     
  • PHQuestBook remove Title_of_the_quest
    Remove a quest from the book
     
  • PHQuestBook clear
    Clear the Quest Book
     
  • PHQuestBook show
    Open the Quest Book
     
  • PHQuestBook change Title_of_the_quest|category
    Changes the category of a quest
     
  • PHQuestBook update Title_of_the_quest
    Updates an existent quest

Script Commands

  • PHPlugins.PHQuests.isActive("Title of the Quest")
  • PHPlugins.PHQuests.is("Title of the Quest", "categoryID")

How to Use

CREATING A CATEGORY:

  • In order to create a category, you have to set 3 required parameters, which are: Category IDsCategory Texts and Category Icons IDs. Here is an example of these three parameters:
[Category IDs]: primary, secondary, completed, failed
[Category Texts]: Primary, Secondary, Completed, Failed
[Category Icons IDs]: 312, 311, 310, 309
  • In the example above, the "primary" in Category IDs will be a category. The text that will be displayed when a quest is in this category is "Primary", and the default icon for this category is the ID "312".

  • As I stated earlier, you can have as many categories as you want. You just need to separate the ids, names and icons with a comma (,).

  • IMPORTANT: Make sure that you have the same amount of ids, texts and icons. In other words, if you have 4 IDs, you must have 4 Texts and 4 Icons.

 

WRITING A QUEST:

  • Open the database and go to the section "Common Events"
  • Create a common event with the name "PHQuestBook" (without quotation marks)
  • Create one or several comments to create quests following the pattern below:
{Title of the quest|categoryID|iconID}
Description of the quest...
 
  • The [categoryID] is optional. If you don't specify the priority of the quest, it will be [default] by default.
  • The iconID is also optional. You can put the ID of the icon you want to show for this quest. If you don't specify an item, the quest will get the default for its priority.
  • You are allowed to have several comments meaning one quest (you don't need to use just the 6 lines for comments, you can add a new comment right below and keep going).
  • You are allowed to write control characters in the description of the quest (such as \C[n], \I[n], \V[n]).
  • You are allowed to use some special tags to get the name of an item, weapon, armor, enemy or actor. When you are writing the description of a quest, use the tags <enemy:ID>, <actor:ID>, <item:ID>, <weapon:ID> and <armor:ID> to print the name of the particular item on the description. ChangeID for the corresponding number you want.
  • There is a tag called [break-on-update]. When you use it, it needs to be the only thing in the line you are writing! When you use it, all the content of the same quest will be hidden, and it will just appear in the quest book when you call the plugin command PHQuestBook update Title_of_the_quest. (SEE THE FAQ SECTION TO GET MORE INFORMATION)
  • You are allowed to have as many [break-on-update] as you want. And always when you call the plugin command for updating, the book will allow the player to see a new part of the quest.
  • (This is a good feature if you want to have a "step-by-step" quest, where each time the player completes the quest, the same quest is updated and new things have to be done).

 

REGISTERING A QUEST ON THE BOOK:

  • To register a quest in the book, create an event in the map, go to "Plugin Command" and type the command for adding the quest.
    • Ex.: PHQuestBook add Title of the Quest
  • "Title of the Quest" does not need to be a single word or between quotation marks, it can be several words meaning one title.

Yanfly MMM + PH Quest Book

  • If you are using Yanfly MMM and you want to implement PH Quest Book, you have two different options to do this. Since version 1.2, there is a particular configuration to add the quest book into the Yanfly MMM, which is:


Demo

  • Many thanks to DGDgamer for providing a demo (using version 2.0)
    DropBox Link

Video Tutorial

Screenshots

FAQ

  • My quests do not load. What should I do?
    There are a couple of things you can verify to make sure the quests are being loaded correcty:
    • Make sure the PH Quest Book JavaScript file has the name: PH_QuestBook.js.
    • Make sure the name of your quests do not have special characters like (), [], etc..
       
  • How should i use the command [break-on-update]
    [break-on-update] needs to be in a single line. Nothing can be written before or after this command (in the same line)! However, you can have as many comments as you want to create the same quests! Basically, you can stack a lot of comments to describe the same quest, like the example below:

Changelog

  • 05/19/2016: Version 2.0 (Infinite Categories, Title Window, New Layout, and bug fixes).
  • 01/11/2016: Version 1.3.1 released - Bug fixes (black background when using third party plugins that deals with background; update quests is now working).
  • 12/27/2015: Version 1.3 released (Page improvements, background image and tag notations).
  • 11/19/2015: Version 1.2 released (More organized layout, quests separated by category, page breaks when writing quests, allow several comments to write quests, bug fixing).
  • 11/12/2015: Fixed issue about not saving quests when saving and exiting the game. Also, added some features to check status and priorities of quests via Script command.
  • 11/11/2015: README.md updated
  • 11/10/2015: Version 1.1 released.
  • 11/08/2015: Fixed incompatibility issue that did not allowed this script to be called by the menu if other scripts being called by the menu were in the project.
  • 11/03/2015: README.md updated
  • 10/25/2015: Correction in the clear function, which did not allowed that other quests were added after its call.
  • 10/24/2015: Version 1.0

Social Links

Copyright © 2018 - Gustavo Fernandes - All rights reserved

Cookies and Privacy Policy