PH - Quest Book

[PrimeHover]

​

Version 2.0
​

 
​

Introduction

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

License

• This work is licensed under the Creative Commons Attribution 4.0 International License.
   To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/
  
• However, if this plugin is very useful to your project, consider making a small donation using the link below:
  
  

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.
  

Full Documentation (Examples, Configuration Step-by-Step, How to Use, Script Commands, ChangeLog, FAQ...)

• Official Blog Post
  

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
  

Screenshots
 

Spoiler

Spoiler

















 

• If you have old versions or you are getting in trouble with the previous kind of configuration, watch this video tutorial created by DGDgamer. He explains step by step what you should do.
  
  
  Version 1.3:
  
  
  
  
  
  
   
  
• Version 2.0:
  
  
  
  
  
  

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

Script

• GitHub: https://github.com/PrimeHover/QuestBook
  

Credits

• PrimeHover
  

 

[hardqueen]

Can I have a function like this?

(1) Quest 2 will show up only when quest 1 has been completed.

(2) A quest requiring the player to kill a specific monster with the same type. In the PH book there can show how many monsters have been killed by the player and the percentage of the whole quest.

Thank you for your consideration.

 

[PrimeHover]

Can I have a function like this?

(1) Quest 2 will show up only when quest 1 has been completed.

(2) A quest requiring the player to kill a specific monster with the same type. In the PH book there can show how many monsters have been killed by the player and the percentage of the whole quest.

Thank you for your consideration.

Hi hardqueen,

(1) The only way I see is to create some variables to keep track of what quest you are in. Then, when you complete a quest, you just remove the previous one and replace it for the new one. But I agree with you that it would be easier if the script could provided a sort of checker to see whether or not a quest has been completed (probably I'll add this feature, thanks for that).

(2) Yes, you can. Still using a variable, you can keep track of how many monster the player has killed. In the message of the quest, you would write something like this:

{Title of the Quest [primary]}

Description...

Monsters killed: \V[n] / 25

You would replace n for the ID of the variable you want to show, and when the player opens the book, he/she will see the corresponding number of the variable.

Thanks for the ideas for future improvements, I hope I've helped you.

 

[hardqueen]

It would be nice of you to give me positive feedback.

Hope your quality plugin will gain a worldwide reputation.

 

[tejam]

Great script! Nice and easy. I have one question, can this script be used with Yanfly MainMenuManager?

I would like to use this script using a Yanfly script. Here is an example of what needs to be filled in:

Spoiler

 

[Rose Guardian]

Nice script. However I ran into a problem. Every time I save, and exit the test play part of my game, then test play again later all of the quests disappear, completed or not.

 

[PrimeHover]

Nice script. However I ran into a problem. Every time I save, and exit the test play part of my game, then test play again later all of the quests disappear, completed or not.

You got it very right. So, I updated the script in order to correct this issue. Thanks for let me know!

Great script! Nice and easy. I have one question, can this script be used with Yanfly MainMenuManager?

I would like to use this script using a Yanfly script. Here is an example of what needs to be filled in:

Spoiler

yanflycustommenu.png

I think there is no problem using it with Yanfly MainMenuManager! I'll try testing them together. If I find anything wrong, I'll let you know!


Update notes:

Now, you can use the following commands to check the status and priority of the quest (you may want to put these scripts in an IF CONDITIONAL to return TRUE or FALSE).

• PHQuests.isActive("Title of the Quest");
• PHQuests.isComplete("Title of the Quest");
• PHQuests.isSecondary("Title of the Quest");
• PHQuests.isPrimary("Title of the Quest");
• PHQuests.isFail("Title of the Quest");

Also, the feature for saving the quests with the game saving is working now.

 

[DGDgamer]

PrimeHover, I think this is a great script. I have been trying to implement it with all the scripts that I use but could not figure what was wrong. I removed all other scripts and started a fresh program. Your script works fine. I then tried it with Yanfly's Core Engine with no problems. When adding the MainMenuManager it removed the "Quest Log" selection from the menu. I tried to go around this by creating a book and calling a common event and it works fine that way. I do not know if you work with third party's but I though you would like to know since it has been brought up previously on this forum. Thank You for your hard work and keep it up. I have included the error and how to create the workaround in images.

 

[Fuchsilein]

Hm, I always get the Error "Cannot read property 'length' of undefined" if i try to call your Plugin and i cant figure out why ._.

 

[PrimeHover]

@DGDgamer

Thanks for reporting!

Actually, I use some Yanfly's plugin, but I did not confirm if my plugin had an incompatibility problem. You make a great job doing this, it is very creative.

I'll post a new update this week, and I'll make sure this incompatibility goes away. Thanks!

@Fuchsilein

Can you take screenshots of your Common Event for the quests, the event where you are using to add the quest, and the console error? (press F8 when the error occurs and a window will open with the given error)

 

[PrimeHover]

Ok guys, new update today!

• USE MORE COMMENTS: Now you are allowed to use as many comments as you want to write a quest!
• PAGINATION: Create long quest texts with pagination. You can use the tag [break] to start a new page of the quest!
• UPDATE YOUR QUEST: A new command called [break-on-update] allows you to update an existing quest, inserting a new part in a new page. See documentation for how to use.
• CATEGORY DIVISION: Quests now are subdivided into their categories (primary, secondary, complete and fail).
• SPECIFIC ICON FOR EACH QUEST: You are allowed to choose a specific icon for each quest you have in your quest book.

Also, if you are using the Yanfly Main Menu Manager, it's totally compatible right now. In order to add the Quest Book in your menu, you can use the following configuration:

Spoiler

Thanks everyone. I hope everyone enjoy this new update!

 

[tejam]

I am getting an error

Spoiler

I am not sure what it is from. I am using Yanfly menu also.

Thank You.

 

[PrimeHover]

I am getting an error

Spoiler

error.png

I am not sure what it is from. I am using Yanfly menu also.


Thank You.

When you get this error, press F8 and take a screenshot of the console that will appear.
It will show where the error is coming from!

 

[tejam]

When you get this error, press F8 and take a screenshot of the console that will appear.

It will show where the error is coming from!

When you get this error, press F8 and take a screenshot of the console that will appear.

It will show where the error is coming from!

Sorry, Here is the Dev file

Spoiler

Thank You

 

[PrimeHover]

Sorry, Here is the Dev file

Spoiler

dev_tool_error.png

Thank You

I see. It seems to me the configuration in the Yanfly MMM is amiss, because it cannot call the Scene_QuestBook.
Look at my example for configuration of the Yanfly MMM to add the Quest Book, perhaps it's a misspelling word.


If you still keep getting this error, post the configuration you did in the Yanfly MMM for adding the quest book!

 

[tejam]

I see. It seems to me the configuration in the Yanfly MMM is amiss, because it cannot call the Scene_QuestBook.

Look at my example for configuration of the Yanfly MMM to add the Quest Book, perhaps it's a misspelling word.

If you still keep getting this error, post the configuration you did in the Yanfly MMM for adding the quest book!

Hmmm, i checked the spelling. Here is a pic of MMM.

Spoiler

TY

 

[PrimeHover]

Hmmm, i checked the spelling. Here is a pic of MMM.

Spoiler

picOfMyMMM.png

TY

I tested in mine, and it worked fine.

Does this error happens when you try to open the Quest Book?

Sorry for the inconvenience.

 

[tejam]

I tested in mine, and it worked fine.

Does this error happens when you try to open the Quest Book?

Sorry for the inconvenience.

Yes, when i try to open the quest book in game it gives me the error. It might be a script conflict. gonna do some testing.

Not an inconvenience. probably something on my side.

UPDATE:

It works now, User error. Had the plugin name misspelled.

Thank You PrimeHover for your fast replies.

 

[PrimeHover]

Yes, when i try to open the quest book in game it gives me the error. It might be a script conflict. gonna do some testing.

Not an inconvenience. probably something on my side.

I've sent to you a personal message, so we can keep going and find what's going on.

Thanks tejam!

I hope you enjoy the plugin! 

 

[hardqueen]

Although YEP plugins have considerable features that have gained worldwide popularity, I have decided to use PH Quest in my commercial game. Definitely the credit will be shown in the game. I leave this message just to show my appreciation.