Quest Journal System VisuStella MZ

From Yanfly.moe Wiki
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



Download

System

This is a plugin created for RPG Maker MZ.

InstallPluginsMz.png

UpdatePlugins.png

Troubleshooting.jpg

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.

Click here to learn how to update plugins.

Click here for how to troubleshoot plugins if you get an error.


Masterarbeit Writer


QuestJournalScreen1.png QuestJournalScreen2.png
QuestJournalScreen3.png QuestJournalScreen4.png


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.

Click here if you want to help support VisuStella on Patreon.

Introduction

QuestJournalScreen1.png

A quest journal is a very important tool provided by game developers for the players. It lists various quests, missions, and objectives that the player can pursue in order to progress further into the game. This can be helpful in reminding the player what needs to be done in the event the player can forget what things there are to do in a vast and large RPG world.

This plugin places a quest journal system into your RPG Maker MZ game. You can set up how the quest journal appears, move its windows around and/or reshape them to fit your game.

You can adjust the quest's title, display a difficulty level, remind the player who the quest is from, where that quest is from, various dynamic descriptions explaining the quest, a list of objectives to make, a list of rewards that will be given to the player once the quest is complete, and any subtext footnotes and quotes you may wish to insert into each quest.

NOTE

Keep in mind that while this plugin does enable a quest journal system into your game, this plugin will NOT automate it. If you have a quest enabled, it is still up to you to add the quest properly into the journal, set its many objectives, when the other objectives appear, what the rewards are, and then giving out the rewards yourself manually. The purpose of this plugin is to simply serve as a visual record for your player to see what quests have been handed down to him or her.

Features include all (but not limited to) the following:

  • Unlimited quest categories.
  • Unlimited quest slots.
  • Full control over what appears in the quest journal system and how it appears in-game.
  • Update quest descriptions, objectives, rewards, subtexts, etc. mid-game through the use of Plugin Commands.
  • A dedicated quest menu that's accessible from the Main Menu or by Plugin Command call.
  • A quest tracker that appears in the map scene to keep the player updated on how far they are progressing in their current quest.
  • Options for the player to show/hide the quest tracker and reposition its location on the screen.

Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.


Tier 2

This plugin is a Tier 2 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5).

This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.


Explanation - Categories and Quests

QuestJournalScreen3.png

The following is an explanation on the differences between Categories and Quests for the usage of this plugin.

---

QuestSystemCategories.png

Categories

Quest Categories separate the quest types in your game. These can be used to help players differentiate which are story-driven quests, which are optional quests, recurring quests, etc. These have limited settings, but serve as containers for quests that fall under its category.

---

Plugin Parameters > Categories > Category Name:

This is the category's name. It appears however you type it using text codes, allowing you to color-code it if needed.

---

Plugin Parameters > Categories > Quests:

These contain the quests that are listed under this category. Enter in as many as needed/desired.

---

QuestSystemQuests.png

Quests

Each Quest Category will contain a list of quests that can appear in-game. These individual quests make up the meat and bones of the Quest System and will serve to relay information to the player on what he/she needs to do in order to make progress in your game.

---

Plugin Parameters > General > Log Window > Quest Log

This determines how the template used by the quest logs to parse information regarding the quests themselves. By default, they are formatted like such:

---

\{[[Title]]\}
\c[4]Level:\c[0] [[Difficulty]]
\c[4]From:\c[0] [[From]]
\c[4]Location:\c[0] [[Location]]

\c[4]Description:\c[0]
[[Description]]

\c[4]Objectives:\c[0]
[[Objectives]]

\c[4]Rewards:\c[0]
[[Rewards]]

[[Subtext]]

[[Quote]]

---

Each "Marker" is to be replaced by the quest date related to them.

- [[Title]] - Inserts the title of the quest.

- [[RawTitle]] - Inserts the title of the quest without any text codes
  removed. Keep in mind that icons do NOT resize based on the text size.

- [[Difficulty]] - Inserts the quest difficulty text.

- [[From]] - Inserts the quest origin text.

- [[Location]] - Inserts the quest location text.

- [[Description]] - Inserts the currently active quest description.
  - The quest description can change depending on which Description ID
    is currently active for that quest.

- [[Objectives]] - Inserts a list of the visible quest objectives.
  - The quest objectives visible to the player will be determined by
    the quest's Visible Objectives settings and any Plugin Commands
    used to alter which objectives are visible and what state they are
    currently in (known, completed, failed).

- [[Rewards]] - Inserts a list of visible quest rewards.
  - The quest rewards visible to the player will be determined by the
    quest's Visible Rewards settings and any Plugin Commands used to
    alter which rewards are visible and what state they are currently
    in (known, claimed, denied).

- [[Subtext]] - Inserts the currently active quest subtext.
  - The quest subtext can change depending on which Subtext ID is
    currently active for that quest.

- [[Quote]] - Inserts the currently active quest quote.
  - The quest quote can change depending on which Quote ID is
    currently active for that quest.

---

QuestJournalScreen3.png

Each of the following aspects of the quests can be changed through the usage of Plugin Commands:

- Description - Objectives - Rewards - Subtext - Quote

The following are the Plugin Commands that can change them:

- Quest: Description Change - Quest: Objectives Change - Quest: Rewards Change - Quest: Subtext Change - Quest: Quote Change

---

More information will be explained in their respective Plugin Parameter sections further down in the help file.

Control Variable and Conditional Branch Usage

For those wanting to use Control Variable event commands and/or Conditional Branch event commands with the Quest Journal System plugin, you can insert the following functions into the "Script" input fields of the respective event commands.

These are new JavaScript functions added through this plugin and will not work without it.

---

Control Variable Script Functions

These are newly added JavaScript functions that return a numeric value. The functions are best used with the Control Variable script input field.

---

totalQuestsAvailable()

- Returns the total number of quests available for the player.

---

totalQuestsCompleted()

- Returns the total number of quests completed by the player.

---

totalQuestsFailed()

- Returns the total number of quests failed by the player.

---

totalQuestsRevealed()

- Returns the total number of quests visible to the player.

---

totalQuestsInGame()

- Returns the total number of quests available in-game.

---

getQuestDescriptionIndex(questKey)

- Returns the select quest's current description index ID.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Example: getQuestDescriptionIndex('Welcome')

---

totalVisibleQuestObjectives(questKey)

- Returns the total number of visible quest objectives for selected quest.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Example: totalVisibleQuestObjectives('Welcome')

---

totalQuestObjectives(questKey)

- Returns the total number of quest objectives for selected quest.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Example: totalQuestObjectives('Welcome')

---

totalVisibleQuestRewards(questKey)

- Returns the total number of visible quest rewards for selected quest.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Example: totalVisibleQuestRewards('Welcome')

---

totalQuestRewards(questKey)

- Returns the total number of quest rewards for selected quest.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Example: totalQuestRewards('Welcome')

---

getQuestSubtextIndex(questKey)

- Returns the select quest's current subtext index ID.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Example: getQuestSubtextIndex('Welcome')

---

getQuestQuoteIndex(questKey)

- Returns the select quest's current subtext index ID.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Example: getQuestQuoteIndex('Welcome')

---

Conditional Branch Script Functions

These are newly added JavaScript functions that return a true/false value. The functions are best used with the Conditional Branch script input field.

---

isQuestObjectiveCompleted(questKey, objectiveID)

- Returns a true/false value depending on the selected quest's objective
  and if it is completed.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Replace 'objectiveID' with the numeric ID of the quest objective you want
  to check.
- Example: isQuestObjectiveCompleted('Welcome', 1)

---

isQuestObjectiveFailed(questKey, objectiveID)

- Returns a true/false value depending on the selected quest's objective
  and if it is failed.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Replace 'objectiveID' with the numeric ID of the quest objective you want
  to check.
- Example: isQuestObjectiveFailed('Welcome', 1)

---

isQuestObjectiveUncleared(questKey, objectiveID)

- Returns a true/false value depending on the selected quest's objective
  and if it is uncleared.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Replace 'objectiveID' with the numeric ID of the quest objective you want
  to check.
- Example: isQuestObjectiveUncleared('Welcome', 1)

---

isQuestRewardClaimed(questKey, rewardID)

- Returns a true/false value depending on the selected quest's reward
  and if it is claimed.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Replace 'objectiveID' with the numeric ID of the quest reward you want
  to check.
- Example: isQuestRewardClaimed('Welcome', 1)

---

isQuestRewardDenied(questKey, rewardID)

- Returns a true/false value depending on the selected quest's reward
  and if it is denied.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Replace 'objectiveID' with the numeric ID of the quest reward you want
  to check.
- Example: isQuestRewardDenied('Welcome', 1)

---

isQuestRewardUnclaimed(questKey, rewardID)

- Returns a true/false value depending on the selected quest's reward
  and if it is unclaimed.
- Replace 'questKey' with the 'Quest ID Key' of the desired quest to gather
  data from. You can find out what the 'Quest ID Key' is in the plugin's
  parameters > Quest Categories > target category > Quests > selected quest
  > Quest ID Key.
- Insert quotes around the 'questKey' to ensure it works.
- Replace 'objectiveID' with the numeric ID of the quest reward you want
  to check.
- Example: isQuestRewardUnclaimed('Welcome', 1)

---

Notetags

RPG Maker MZ's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin.

Here is a list of Notetag(s) that you may use.


The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present.

---

Action Tracking-Related Notetags

QuestJournalScreen2.png

---

<Variable id On Use: +x>
<Variable id On Use: -x>

- Used for: Skill, Item Notetags
- Whenever any actor uses this specific skill or item, increase or decrease
  the target variable by a certain amount.
- Replace 'id' with the Variable ID you wish to alter.
- Replace 'x' with the increase or decrease in value for the variable.

---

Enemy Tracking-Related Notetags

QuestJournalScreen2.png

---

<Variable id On Death: +x>
<Variable id On Death: -x>

- Used for: Enemy Notetags
- Whenever this specific enemy dies, increase or decrease the target
  variable by a certain amount.
- Replace 'id' with the Variable ID you wish to alter.
- Replace 'x' with the increase or decrease in value for the variable.

---

Item Tracking-Related Notetags

QuestJournalScreen2.png

---

<Variable id On Gain: +x>
<Variable id On Gain: -x>

- Used Item, Weapon, Armor Notetags
- Whenever the party gains the specific item, weapon, or armor, increase or
  decrease the target variable by a certai amount.
- Replace 'id' with the Variable ID you wish to alter.
- Replace 'x' with the increase or decrease in value for the variable.

---

<Variable id On Lose: +x>
<Variable id On Lose: -x>

- Used Item, Weapon, Armor Notetags
- Whenever the party loses the specific item, weapon, or armor, increase or
  decrease the target variable by a certai amount.
- Replace 'id' with the Variable ID you wish to alter.
- Replace 'x' with the increase or decrease in value for the variable.

---

<Track With Variable id>

- Used Item, Weapon, Armor Notetags
- Whenever there is a change made to the specific item, weapon, or armor,
  set the value of the target variable to the number of items owned.
- Replace 'id' with the Variable ID you wish to alter.

---

Plugin Commands

PluginCommandsMZ.png

Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MZ.

Here is a list of Plugin Command(s) that you may use:

---


The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command.

---

Quest Plugin Commands

---

QuestJournalScreen3.png

QuestJournalSystemCommand1.png

Quest: Add/Complete/Fail/Remove
- Adds quest(s) to be known/completed/failed.
- Or removes them.

  Quest Keys:
  - Insert the quest key(s) here.
  - Each quest key must be unique.

  Status:
  - Change the status to this.
    - Add to Known
    - Add to Completed
    - Add to Failed
    - Remove from All

---

QuestJournalScreen1.png

QuestJournalSystemCommand2.png

Quest: Description Change
- Changes the description of the quest(s) to a ID.

  Quest Keys:
  - Insert the quest key(s) here.
  - Each quest key must be unique.

  Description ID:
  - Change the description of the quest(s) to a different ID.
  - You may use JavaScript code.

---

QuestJournalSystemCommand3.png

Quest: Objectives Change
- Changes the objective(s) status of the quest(s).

  Quest Keys:
  - Insert the quest key(s) here.
  - Each quest key must be unique.

  Objective ID(s):
  - Select the objective ID(s) to change.
  - You may use JavaScript code.

  Status:
  - Change the status of the objective(s) to this.
    - Show Objective(s)
    - Complete Objective(s)
    - Fail Objective(s)
    - Remove Objective(s)

---

QuestJournalSystemCommand4.png

Quest: Quote Quote
- Changes the quote of the quest(s) to a ID.

  Quest Keys:
  - Insert the quest key(s) here.
  - Each quest key must be unique.

  Subtext ID:
  - Change the quote of the quest(s) to a different ID.
  - You may use JavaScript code.

---

QuestJournalScreen3.png

QuestJournalSystemCommand5.png

Quest: Rewards Change
- Changes the reward(s) status of the quest(s).

  Quest Keys:
  - Insert the quest key(s) here.
  - Each quest key must be unique.

  Reward ID(s):
  - Select the reward ID(s) to change.
  - You may use JavaScript code.

  Status:
  - Change the status of the reward(s) to this.
    - Show Reward(s)
    - Claim Reward(s)
    - Deny Reward(s)
    - Remove Reward(s)

---

QuestJournalSystemCommand6.png

Quest: Subtext Change
- Changes the subtext of the quest(s) to a ID.

  Quest Keys:
  - Insert the quest key(s) here.
  - Each quest key must be unique.

  Subtext ID:
  - Change the subtext of the quest(s) to a different ID.
  - You may use JavaScript code.

---

Label Plugin Commands

QuestJournalSystem QuestMarker.gif

---

QuestJournalSystem Update127 Command1.png

Label: Add Quest Label
- Add Quest Labels to target items, weapons, and armors.

  Item ID(s):
  Weapon ID(s):
  Armor ID(s):
  - Select which Item, Weapon, or Armor ID(s) to add Quest Labels to.

---

QuestJournalSystem Update127 Command2.png

Label: Clear Quest Label
- Clear Quest Labels from target items, weapons, and armors.

  Item ID(s):
  Weapon ID(s):
  Armor ID(s):
  - Select which Item, Weapon, or Armor ID(s) to clear Quest Labels from.

---

Tracker Plugin Commands

---

QuestJournalScreen2.png

QuestJournalSystemCommand7.png

Tracker: Change Quest
- Changes the tracked quest.

  Quest Key:
  - Insert the quest key here.

---

QuestJournalSystemCommand8.png

Tracker: Refresh Window
- Refreshes the quest tracker window.

---

QuestJournalSystemCommand9.png

Tracker: Show/Hide Window
- Can forcefully hide window.
- Showing will depend on the player's Options setting.

  Show/Hide?:
  - Shows/hides the tracker window on the map.

---

System Plugin Commands

---

QuestJournalScreen1.png

QuestJournalSystemCommand10.png

System: Call Scene_Quest
- Opens Scene_Quest for the player.
- Does not work in battle.

---

QuestJournalSystemCommand11.png

System: Enable Quests in Menu?
- Enables/disables quest menu inside the main menu.

  Enable/Disable?:
  - Enables/disables quest menu inside the main menu.

---

QuestJournalSystemCommand12.png

System: Show Quests in Menu?
- Shows/hides quest menu inside the main menu.

  Show/Hide?:
  - Shows/hides quest menu inside the main menu.

---


Script Calls

The following are Script Calls that can be used with this plugin. These are made for JavaScript proficient users. We are not responsible if you use them incorrectly or for unintended usage.

Using these require you to have an adequate understanding of how JavaScript works in order to successfully use it.

---

$gameSystem.setQuestStatus(key, status)
- Changes the quest's completion status.
- Replace 'key' with Quest Key (include quotes).
- Replace 'status' with one of the following strings (include quotes):
  - 'known'
  - 'completed'
  - 'failed'
  - 'removed'

Example: $gameSystem.setQuestStatus('exampleName', 'completed')

---

$gameSystem.setQuestDescription(key, id)
- Changes the quest's description.
- Replace 'key' with Quest Key (include quotes).
- Replace 'id' with description ID to use.

Example: $gameSystem.setQuestDescription('exampleName', 2)

---

$gameSystem.setQuestObjectives(key, ids, status)
- Changes the quest's objectives.
- Replace 'key' with Quest Key (include quotes).
- Replace 'ids' with an array of ID's to use.
- Replace 'status' with one of the following strings (include quotes):
  - 'known'
  - 'completed'
  - 'failed'
  - 'removed'

Example: $gameSystem.setQuestDescription('exampleName', [1, 2, 3], 'failed')

---

$gameSystem.setQuestRewards(key, ids, status)
- Changes the quest's rewards.
- Replace 'key' with Quest Key (include quotes).
- Replace 'ids' with an array of ID's to use.
- Replace 'status' with one of the following strings (include quotes):
  - 'known'
  - 'claimed'
  - 'denied'
  - 'removed'

Example: $gameSystem.setQuestRewards('exampleName', [1, 3, 5], 'claimed')

---

$gameSystem.setQuestSubtext(key, id)
- Changes the quest's subtext.
- Replace 'key' with Quest Key (include quotes).
- Replace 'id' with subtext ID to use.

Example: $gameSystem.questSubtext('exampleName', 3)

---

$gameSystem.setQuestQuote(key, id)
- Changes the quest's quote.
- Replace 'key' with Quest Key (include quotes).
- Replace 'id' with quote ID to use.

Example: $gameSystem.setQuestQuote('exampleName', 4)

---

DISCLAIMER:

Keep in mind that VisuStella is NOT responsible for your proficiency (or otherwise) of JavaScript.

If you get any errors with the custom code, it is up to YOU to fix it.

If you do not understand how any of this section works, do not be afraid. It's not the end of the world.

You can still change the status of the quests and its objectives through the usage of Plugin Commands.

---


Plugin Parameters

General Settings

QuestJournalScreen1.png

QuestJournalSystemParam1.png

The general settings determine various aspects of the Quest System plugin from the quests that appear at the start of the game to how it's displayed inside menus.

---

Starting Quests

 Known Quests:
 - Which quests are known at the start of the game?
 - Insert their keys here.
 Completed Quests:
 - Which quests are completed at the start of the game?
 - Insert their keys here.
 Failed Quests:
 - Which quests are failed at the start of the game?
 - Insert their keys here.
 Tracked Quest:
 - Which quest is tracked at the start of the game?

---

Scene_Quest

---

Scene_Quest > Background Settings:

 Snapshop Opacity:
 - Snapshot opacity for the scene.
 Background 1:
 - Filename used for the bottom background image.
 - Leave empty if you don't wish to use one.
 Background 2:
 - Filename used for the upper background image.
 - Leave empty if you don't wish to use one.

---

Scene_Quest > Vocab

---

Scene_Quest > Vocab > Command Window

 Command: Known:
 - Text used to display known quests.
 Command: Completed:
 - Text used to display completed quests.
 Command: Failed:
 - Text used to display failed quests.

---

Scene_Quest > Vocab > Label Window

 Empty Title:
 - Text displayed in the Label Window when no quest is selected.

---

Scene_Quest > Vocab > List Window

 Open Categories:
 - Text format for an open category.
 - %1 - Category Name, %2 - Quest Amount
 Closed Categories:
 - Text format for a closed category.
 - %1 - Category Name, %2 - Quest Amount
 No Quest Listed:
 - Text when no quest is listed.
 Tracked Quest:
 - Text format for a tracked quest.
 - %1 - Tracked Quest's Name

---

Scene_Quest > Vocab > Log Window

 Empty Message:
 - Text displayed when no quest is selected.
   JS: On Load:
   - Runs code upon making the empty message.
   - Useful for setting up variables.
  Quest Log:
  - Text format for Quest Log Window.
  - Instructions:
    - Insert the [[Keyword]] marks in the text where you want certain parts
      of the quest to appear.

      - [[Title]] - Inserts the title of the quest.

      - [[Difficulty]] - Inserts the quest difficulty text.

      - [[From]] - Inserts the quest origin text.

      - [[Location]] - Inserts the quest location text.

      - [[Description]] - Inserts the currently active quest description.
        - The quest description can change depending on which Description ID
          is currently active for that quest.

      - [[Objectives]] - Inserts a list of the visible quest objectives.
        - The quest objectives visible to the player will be determined by
          the quest's Visible Objectives settings and any Plugin Commands
          used to alter which objectives are visible and what state they are
          currently in (known, completed, failed).

      - [[Rewards]] - Inserts a list of visible quest rewards.
        - The quest rewards visible to the player will be determined by the
          quest's Visible Rewards settings and any Plugin Commands used to
          alter which rewards are visible and what state they are currently
          in (known, claimed, denied).

      - [[Subtext]] - Inserts the currently active quest subtext.
        - The quest subtext can change depending on which Subtext ID is
          currently active for that quest.

      - [[Quote]] - Inserts the currently active quest quote.
        - The quest quote can change depending on which Quote ID is
          currently active for that quest.
 Objective (Known):
 - Text format for known objectives.
 - %1 - Objective Text
 Objective (Done):
 - Text format for complete objectives.
 - %1 - Objective Text
 Objective (Failed):
 - Text format for failed objectives.
 - %1 - Objective Text
 Reward (Known):
 - Text format for normal rewards.
 - %1 - Reward Text
 Reward (Claimed):
 - Text format for claimed rewards.
 - %1 - Reward Text
 Reward (Denied):
 - Text format for denied rewards.
 - %1 - Reward Text

---

Scene_Quest > Vocab > Button Assist Window

 Scroll Up/Down:
 - Text for Page Up/Down to scroll log window.
 - Requires VisuMZ_0_CoreEngine!
 Tracker:
 - Text for tracking quests.
 - Requires VisuMZ_0_CoreEngine!
 Expand:
 - Text for expanding categories.
 - Requires VisuMZ_0_CoreEngine!
 Collapse:
 - Text for collapsing categories.
 - Requires VisuMZ_0_CoreEngine!

---

Scene_Quest > Icons

 Icon: Known:
 - Icon used for this command.
 Icon: Completed:
 - Icon used for this command.
 Icon: Failed:
 - Icon used for this command.

---

Quest Category Settings

QuestSystemCategories.png

QuestJournalSystemParam2.png

Quest Categories separate the quest types in your game. These can be used to help players differentiate which are story-driven quests, which are optional quests, recurring quests, etc. These have limited settings, but serve as containers for quests that fall under its category.

---

QuestJournalSystemParam2a.png

Category

 Category Name:
 - This category's name.
 - You may use text codes.
 Quests:
 - A list of quests listed under this category.
 - Quests will be listed in the same order as this parameter.

---

Quest Settings

QuestJournalSystemParam2b.png

Each Quest Category will contain a list of quests that can appear in-game. These individual quests make up the meat and bones of the Quest System and will serve to relay information to the player on what he/she needs to do in order to make progress in your game.

---

Quest

 Quest ID Key:
 - This quest's identification key. Quests require unique keys for the
   plugin to differentiate them.
 - It is VERY important that you keep this key unique from other quests in
   order for the Quest System to operate properly in your game.

---

Header

  Title:
  - The quest of the title. This is what appears in-game.
  - You may use text codes.
  - In Plugin Parameters => General => Vocab => Log Window => Quest Log,
    this will replace the [[Title]] marker.
  Difficulty:
  - Difficulty level for this quest.
  - You may use text codes.
  - In Plugin Parameters => General => Vocab => Log Window => Quest Log,
    this will replace the [[Difficulty]] marker.
  From:
  - Insert the name of the one who issued this quest.
  - You may use text codes.
  - In Plugin Parameters => General => Vocab => Log Window => Quest Log,
    this will replace the [[From]] marker.
  Location:
  - Insert location name where this quest was issued.
  - You may use text codes.
  - In Plugin Parameters => General => Vocab => Log Window => Quest Log,
    this will replace the [[Location]] marker.
  Description:
  - Type out the description(s) used for this quest.
  - You may use text codes.
  - In Plugin Parameters => General => Vocab => Log Window => Quest Log,
    this will replace the [[Description]] marker.
  - The displayed description will depend on the Description ID set through
    Plugin Command.
  - If no Description ID is set through Plugin Commands, it will default to
    a default ID value of 1.

---

Lists

  Objectives List:
  - The objectives to be completed for this quest.
  - You may use text codes.
  - In Plugin Parameters => General => Vocab => Log Window => Quest Log,
    this will replace the [[Objectives]] marker.
  - Depending on which ID's are set to visible, a list will created at the
    marker displaying each of the objectives.
   - This can be done thorugh the Visible Objectives parameter or through
     Plugin Commands.
  Visible Objectives:
  - The objectives that are visible from the start.
  Rewards List:
  - The reward list for this quest.
  - You may use text codes.
  - In Plugin Parameters => General => Vocab => Log Window => Quest Log,
    this will replace the [[Rewards]] marker.
  - Depending on which ID's are set to visible, a list will created at the
    marker displaying each of the rewards.
   - This can be done thorugh the Visible Rewards parameter or through
     Plugin Commands.
  Visible Rewards:
  - The rewards that are visible from the start.

---

Footer

  Subtext:
  - Subtext to be displayed with the quest.
  - You may use text codes.
  - In Plugin Parameters => General => Vocab => Log Window => Quest Log,
    this will replace the [[Subtext]] marker.
  - The displayed description will depend on the Subtext ID set through
    Plugin Command.
  - If no Subtext ID is set through Plugin Commands, it will default to
    a default ID value of 1.
  Quotes:
  - Quotes to be displayed with the quest.
  - You may use text codes.
  - In Plugin Parameters => General => Vocab => Log Window => Quest Log,
    this will replace the [[Quote]] marker.
  - The displayed description will depend on the Quote ID set through
    Plugin Command.
  - If no Quote ID is set through Plugin Commands, it will default to
    a default ID value of 1.

---

JavaScript

 JS: On Load:
 - Runs code upon loading the quest in Scene_Quest.
 - Useful for setting up variables.

---

Quest Label Settings

QuestJournalSystem QuestMarker.gif

Change how Quest Labels apply to your game project. Quest Labels are applied to items, weapons, and armors manually by the you, the game dev, through this plugin's Plugin Commands. They add a "QUEST" text over the icon of the target item(s) and these will be shown to the player inside most windows that show items.

This way, players can instantly recognize which items are quest-related (as long as they are marked by you, the game dev) and make quicker on-the-go decisions such as whether or not to use them or sell them.

QuestJournalSystem Update127 Params1.png

---

Settings

 Icon:
 - The icon index used to represent the NEW! text.
 - Use 0 to not draw any icons.
 Text:
 - The text written on the Quest Label.
 Font Color:
 - Use #rrggbb for custom colors or regular numbers for text colors from
   the Window Skin.
 Font Face:
 - Font face used for the Quest Label.
 Font Size:
 - The font size used for the Quest text.
 Fade Limit:
 - What's the upper opaque limit before reversing?
 Fade Speed:
 - What's the fade speed of the Quest Label?
 Offset X:
 - How much to offset the Quest Label's X position by.
 Offset Y:
 - How much to offset the Quest Label's Y position by.

---

Quest Tracker Settings

QuestJournalScreen2.png

QuestJournalSystemParam3.png

The Quest Tracker Window is a window that appears on the map scene to display the objectives (and other desired information) of the currently tracked quest decided by the player.

---

General

 Tracker Format:
 - Text format for Quest Tracker Window.
 - Read help file for instructions.

---

Fading

 Close Minimum Opacity:
 - Minimum opacity when the player is too close to the quest tracker on
   the map screen.
 Tracker Fade Speed:
 - Fade speed of the tracker when toggled on/off.
 - Lower is slower. Higher is faster.

---

Options

 Adjust Window Height:
 - Automatically adjust the options window height?
 Add Show Tracker?:
 - Add the 'Show Tracker' option to the Options menu?
   Option Name:
   - Command name of the option.
 Add Position Tracker?:
 - Add the 'Position Tracker' option to the Options menu?
   Option Name:
   - Command name of the option.
   Option OFF:
   - Text displayed when the option is OFF.
   Option ON:
   - Text displayed when the option is ON.

---

Main Menu Settings

QuestJournalMainMenu.png

QuestJournalSystemParam4.png

Set up the main menu defaults.

---

Main Menu Settings

 Command Name:
 - Name of the 'Quest' option in the Main Menu.
 Show in Main Menu?:
 - Add the 'Quest' option to the Main Menu by default?
 Enable in Main Menu?:
 - Enable the 'Quest' option to the Main Menu by default?

---

Background Settings

QuestJournalScreen4.png

QuestJournalSystemParam5.png

Background settings for Scene_Quest.

---

Background Settings

 Snapshop Opacity:
 - Snapshot opacity for the scene.
 Background 1:
 - Filename used for the bottom background image.
 - Leave empty if you don't wish to use one.
 Background 2:
 - Filename used for the upper background image.
 - Leave empty if you don't wish to use one.

---

Window Settings

QuestJournalScreen4.png

QuestJournalSystemParam6.png

These settings let you control the various windows that appear in the Scene_Quest menu and the Quest Tracker Window that appears in Scene_Map.

---

Command Window

 Show Failed Quests?:
 - Show/hide Failed Quests in the command window.
 Style:
 - How do you wish to draw commands in the Command Window?
 - Text Only: Display only the text.
 - Icon Only: Display only the icon.
 - Icon + Text: Display the icon first, then the text.
 - Auto: Determine which is better to use based on the size of the cell.
 Text Align:
 - Text alignment for the Command Window.
 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Quest Label

 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Log Window

 PageUp/Down Speed:
 - Scroll speed for PageUp/Down.
 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.
 EXPERIMENTAL:
   Automatic Word Wrap?:
   - Enables/disables automatic word wrap.
   - Requires VisuMZ_1_MessageCore!
   - This feature is experimental. Word Wrap does not worth perfectly
     with the Log Window, although it performs well enough. This feature
     will be updated and completed at a later point in the future. Use it
     at your own discretion.

---

List Window

 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Tracker Window

 Window Scale:
 - How much do you want to scale the Tracker Window's size by?
 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---


Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com.

2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella".

3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code.

4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.

5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code.

6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.

7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.

8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed.

Terms of Use: Japanese


『VisuStella MZ』利用規約

1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。

2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。

3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。

Credits

If you are using this plugin, credit the following people in your game:

Team VisuStella

Changelog

Version 1.17: July 13, 2023

  • Documentation Update!
    • Help file updated for new features.
    • Script Call section updated for more clarity.
  • New Features!
    • New Plugin Commands added by Irina:
      • Label: Add Quest Label
        • Add Quest Labels to target items, weapons, and armors.
      • Label: Clear Quest Label
        • Clear Quest Labels from target items, weapons, and armors.
    • New Plugin Parameters added by Irina:
      • Quest Label Settings
        • Change how Quest Labels apply to your game project. Quest Labels are applied to items, weapons, and armors manually by the you, the game dev, through this plugin's Plugin Commands. They add a "QUEST" text over the icon of the target item(s) and these will be shown to the player inside most windows that show items.
        • This way, players can instantly recognize which items are quest-related (as long as they are marked by you, the game dev) and make quicker on-the-go decisions such as whether or not to use them or sell them.


Version 1.16: November 24, 2022

  • Feature Update!
    • Updated Plugin Command "Tracker: Show/Hide Window" cases from "Enable" and "Disable" to "Show" and "Hide". Update made by Arisu.


Version 1.15: October 6, 2022

  • Compatibility Update!
    • Plugins should be more compatible with one another.


Version 1.14: August 18, 2022

  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New Plugin Parameters added by Olivia:
      • Quest Tracker Settings > Fading > Close Minimum Opacity
      • Quest Tracker Settings > Fading > Tracker Fade Speed
        • These settings allow you to make the quest tracker become opaque the moment the player comes near the quest tracker on the screen.


Version 1.13: March 10, 2022

  • Compatibility Update
    • Plugins should be more compatible with one another.


Version 1.12: July 9, 2021

  • Feature Update!
    • Improved calculations for determining window size. Update made by Irina.


Version 1.11: January 15, 2021

  • Documentation Update!
    • Added documentation for new feature(s)!
  • New Feature!
    • Added new Marker to Quest Log format and Quest Tracker formats.
      • RawTitle - Inserts the title of the quest without any text codes removed. Keep in mind that icons do NOT resize based on the text size.


Version 1.10: December 11, 2020

  • Bugs Fixed!
    • Quest tracking should now automatically remove itself once a quest is dubbed complete, failed, or removed. Fix made by Yanfly.


Version 1.09: November 29, 2020

  • Bug Fixed!
    • The Button Assist Window will now properly display the text for expanding and collapsing quest categories. Fix made by Arisu.


Version 1.08: November 15, 2020

  • Optimization Update!
    • Plugin should run more optimized.


Version 1.07: November 1, 2020

  • Documentation Update!
    • Added documentation for new feature(s)!
  • Feature Updates!
    • When multiple parallel events are occuring, they will no longer cause lag by inducing multiple refreshes at a time. Update by Olivia.
  • New Features!
    • New Plugin Parameter added by Irina!
      • Plugin Parameters > Quest Tracker Settings > Tracker Format
        • Text format for Quest Tracker Window. This lets you customize the text that appears in the Quest Tracker instead of just having the title and the objectives.


Version 1.06: October 25, 2020

  • Feature Update!
    • If Message Core is not detected, <ColorLock> and </ColorLock> notetags will be automatically removed. Added by Arisu.


Version 1.05: October 11, 2020

  • Documentation Update!
    • "Control Variable and Conditional Branch Usage" section added for those who wish to gather data for the script input fields of the mentioned event commands.


Version 1.04: October 4, 2020

  • Bug Fixes!
    • Quest Tracker window refreshes should no longer cause infinite loops when used with specific script calls. Fix made by Yanfly.


Version 1.03: September 20, 2020

  • Documentation Update!
    • For all the new features!
  • New Features!
    • New notetags added by Olivia!
    • <Variable id On Death: +x> and <Variable id On Death: -x> for enemies.
    • <Variable id On Gain: +x> and <Variable id On Gain: -x> for items, weapons, and armors.
    • <Variable id On Lose: +x> and <Variable id On Lose: -x> for items, weapons, and armors.
    • <Track With Variable id> for items, weapons, and armors.
    • <Variable id On Use: +x> and <Variable id On Use: -x> for items & skills.


Version 1.02: September 13, 2020

  • Bugs Fixed!:
    • Quest Tracker Window should no longer flicker.


Version 1.01: September 6, 2020

  • Bug Fixed!
    • Disabled track windows no longer appear on the screen for one frame after leaving a menu of any sort. Fix made by Yanfly.
    • Viewing the failed quests no longer crash the game. Fix made by Yanfly.
  • Feature Update!
    • The following Plugin Commands will now automatically update the tracker if needed. Feature update by Yanfly.
      • Quest: Add/Complete/Fail/Remove
      • Quest: Description Change
      • Quest: Objectives Change
      • Quest: Quote Change
      • Quest: Rewards Change
      • Quest: Subtext Change


Version 1.00:

  • Finished Plugin!

See Also


Help File