> For the complete documentation index, see [llms.txt](https://scheduler.groupez.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://scheduler.groupez.dev/getting-started.md).

# Getting Started

zScheduler will allow you to execute commands at regular intervals. You can reward your players or launch events automatically.

* Source code: <https://github.com/Maxlego08/zSchedulers>
* Discord: <https://discord.groupez.dev>

## Scheduler type:

* `HOURLY` : Runs every hour at the same minute.

* `DAILY` : Runs all days, you must provide hours and minutes

* `WEEKLY` : Runs every week, you must provide day of week, hours and minutes

* `MONTHLY` : Runs every month, you must provide hours and minutes

* `YEARLY` : Runs every year, you must provide month, day of month, hours and minutes

* `EVERY_DAY`[ ](#user-content-fn-1)[^1]: Will run all x days, configurable

* `EVERY_HOUR` : Will run all x hours, configurable

* `EVERY_MINUTE` : Will run all x minutes, configurable

* `EVERY_SECOND`: Will run all x seconds, configurable

* Days: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`

* Month: J`ANUARY`, `FEBRUARY`, `MARCH`, `APRIL`, `MAY`, `JUNE`, `SEPTEMBER`, `OCTOBER`, `NOVEMBER`, `DECEMBER`

## Commands

Main command is `/zschedulers`, but you have the following aliases: `/schedulers`, `/scheduler` and `/sch`

| Command              | Permission        | Description                |
| -------------------- | ----------------- | -------------------------- |
| /zschedulers         | zschedulers.use   | Display command list       |
| /zschedulers list    | zschedulers.list  | Display schedulers         |
| /zschedulers reload  | zchedulers.reload | Reload configuration files |
| /zschedulers version |                   | Show plugin version        |

## Placeholders

<table><thead><tr><th width="382">Placeholder</th><th>Description</th></tr></thead><tbody><tr><td>%zschedulers_time_&#x3C;scheduler name>%</td><td>Displays the time remaining before the next placeholder run</td></tr><tr><td>%zschedulers_date_&#x3C;scheduler name>%</td><td>Displays the date for the next placeholder run</td></tr><tr><td>%zschedulers_second_&#x3C;scheduler name>%</td><td>Displays the second number before the next placeholder</td></tr></tbody></table>

<div><figure><img src="/files/zOggJ6KKofgVHZ9EDKo9" alt=""><figcaption><p>Placeholder for the date</p></figcaption></figure> <figure><img src="/files/PxfL0KfjOkH1hjfOTXZW" alt=""><figcaption><p>Placeholder for the remaining time</p></figcaption></figure></div>

[^1]: