Upstream/Quests
1
0
Fork 0
mirror of https://github.com/PikaMug/Quests.git synced 2025-02-18 05:21:20 +01:00
Code Issues Projects Releases Wiki Activity

Created Beginner ‐ Planner (markdown)

PikaMug 2019-08-05 17:23:46 -04:00
parent 79c5def036
commit 4db6278421
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
Beginner-‐-Planner.md Normal file

@ -0,0 +1,34 @@
Once you've familiarized yourself with the [Quests Editor](https://github.com/PikaMug/Quests/wiki/3-%E2%80%90-Quests-Editor), you may be wondering about the 'Edit Planner' selection. This sub-menu contains controls for when your quest should be available, based on real time:
![Planner](https://i.imgur.com/J0CtFJH.png)
<details>
<summary>Click here to see the breakdown.</summary>
| # | - | Choice | Description |
|---|---|--------|-------------|
| 1 | - | Set start date | Time the quest should become available |
| 2 | - | Set end date | Time the quest should cease to be available |
| 3 | - | Set repeat cycle | Lnegth until quest is available again |
| 4 | - | Set player cooldown | Length to wait after completing quest |
| 5 | - | Done | Finish working on your quest planner |
</details>
To better understand these selections, please observe the following example as it would appear in quests.yml:
```
custom1:
name: PrepareForNewYears
...
planner:
start: 31:12:2019:23:0:0:SystemV/EST5
end: 1:1:2020:0:0:0:SystemV/EST5
repeat: 31536000
cooldown: 3600
```
Here we want our quest to only be available during New Years' celebrations. The **start date** is set to December 31, 2019 at 11:00 PM EST. The **end date** is set to January 1, 2020 at midnight. This means that the quest will only be available for one hour.
Since we want to celebrate _every_ year, the **repeat cycle** is set to 31536000 seconds (one calendar year). This wait time is based on the start date, so the quest will next become available on December 31, 2020, then again on the 31st of 2021, and so on. It will only be available for one hour, just like the original duration.
Lastly, we set a **player cooldown** of 3600 seconds (one hour). This is because we do not want the player to take our quest again should they complete it within the hour that it's available. Having a cooldown of one hour ensures even the quickest players won't be able to take the quest again before it becomes unavailable.