Skip to content

MythicPalette/simpler-quests

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FoundryVTT - Mythic's Simpler Quests

This module aims to provide a streamlined and easy quest tracking system. The main goal is simplicity and on-the-fly usage. [Compatibility]: FoundryVTT v12 [Game Systems]: any

Usage

Docked VS Undocked

There are two primary ways to use the module; Docked mode and Floating mode. Each user can decide which mode they want to use through the settings. There are very few differences between the two modes. The mode mostly controls how the tracker is placed on your screen. The default is docked.

While in Docked mode, the tracker will attach itself to the side of the sidebar.

image

While docked you can minimize the tracker but not close it.

image

While undocked the tracker appears as a floating window. This window can be closed. To open it again you can go navigate to the note controls on the left and click the scroll icon

image

image

Creating/Editing a Quest

Start by clicking the Add Quest button on the titlebar or by clicking the Edit Quest button in the quest tracker (Only visible when moused over)

image image

image

This will present you with a quest configuration screen.

image

You can easily set the quest name, quest visibility, objective view mode, and objectives.

Quest Visibility Mode

Quest visibility controls how objectives are presented to players. The three modes make it easy to quickly display information how you like. Secrets are never shown to players, so visibility modes only apply to non-secret objectives.

All Quest Objectives shows all of the objectives (excluding secrets) to the players at all times. Great if you want to let them see all the major points of a quest.

image

Up To Next Objective Only shows only objectives that have been completed or failed and the next one. Want your party to only be able to see the very next step but don't want to have to make every single objective a secret? This will make sure your players don't get to peak ahead into the quest too far while also making you work less. Just keep in mind, if the next objective has subobjectives, it will show all of those with it!

image

Only Completed will only let players see objectives they've already finished. Great for keeping tabs on progress without letting the players peak ahead. This is great for tracking player progress in quests, especially between breaks or even between sessions.

image

Combine these modes with the use of secret objectives to present information in a creative way.

Objectives

imageimage

Objectives are written in a text area. Each line is a new objective. So write an objective, hit enter, and keep writing. No hoops.

You can easily set secrets and completed/failed objectives, and subobjectives with with a very fast syntax. Just put the following symbols at the beginning of a line to mark it. Don't worry, you don't have to use this if you don't want to! Just check out the Objective Controls section to see how you can do all of this with just the click of a mouse.

  • / Makes the objective a secret. Secrets can only be seen by the GM
  • + Marks the quest as complete
  • - marks the quest as failed
  • * marks a subobjective. You can have as many subobjectives as you like, just put the same number of * in front of each subobjective. Putting two will mark it as a subobjective of a subobjective, you can only do that if there is a subobjective in front of it though!

image

Note that a secret objective with subobjectives will make the rail purple to show that the subobjectives are a secret but won't make the subobjectives themselves purple. This is so revealing the secret will reveal all of its sub objectives too. If you want to make sure they aren't revealed with the parent objective, you can just make them a secret, too. This way you have quick and easy control over what does and does not get scene.

Tracker Controls

Now for the main feature of this module, the tracker. The tracker was designed with one thing in mind "streamline". Every action should be quick and easy to do, especially for the GM. Nothing slows down a VTT campaign faster than having to jump through menus.

Quest Controls

Click the quest title

image

Clicking the quest name will collapse/expand the quest. By default, you can only have one quest expanded at a time, but there is a setting that each user can change to expand multiple quests if they prefer. You can set the quest visibility, edit the quest in the editor (Just like creating a quest), or delete the quest right here at the right hand side. The controls show up as soon as your mouse goes over the quest title.

Objective Controls

image

image

Here is where the streamline mindset comes in handy. You can mark a quest objective complete by clicking it. If you click it a second time, it will mark as failed. Clicking a third time will reset it to incomplete. That easy.

Now, you may have noticed some objectives were written in purple. Those quests are secrets. Only the GM can see them. And, as you can see, they can be marked completed or failed without unhiding them as well. If you want to show an objective or make one a secret, there is no need to go into any of the menus. Just right-click the objective and it will toggle the secret state. This makes it great for revealing secret objectives on the fly without interrupting the flow of gameplay.

image image

And remember, a secret objective with subobjectives will only make the rail secret. Any objectives with a purple rail are hidden from players but as soon as you make that objective not a secret, any subobjectives on that rail will also be visible if they aren't secrets on their own. image

API

There is an API. Please see the Wiki for more information.

Installation

Recommended Installation method

  1. Install through Foundry's package management. The easiest way to do that is using the manifest url: https://github.com/MythicPalette/simpler-quests/releases/latest/download/module.json
  2. Activate the module in your World in the Module Management settings.
  3. Refresh your browser.

Manual Installation method

  1. Download the latest zip file from here
  2. Extract it to your modules folder in your Foundry user data directory.
  3. Active the module in your World in the Module Management settings.
  4. Refresh your browser.