# 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="https://1156062455-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDepPariphfbl16VpR60c%2Fuploads%2FlgYGrxhI79FIEHptqrM3%2Fplaceholder_date.png?alt=media&#x26;token=e3129c78-87d3-477f-8b0c-89ec1d430246" alt=""><figcaption><p>Placeholder for the date</p></figcaption></figure> <figure><img src="https://1156062455-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDepPariphfbl16VpR60c%2Fuploads%2FOERRvmY0kFx6zAcuTdFW%2Fplaceholder_timer.png?alt=media&#x26;token=b3769c87-0cb3-4646-9829-0a984d1a3f75" alt=""><figcaption><p>Placeholder for the remaining time</p></figcaption></figure></div>

[^1]:


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://scheduler.groupez.dev/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.