> For the complete documentation index, see [llms.txt](https://docs.zithium.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zithium.net/xl-series/xltournaments/calendars.md).

# Calendars

This page will explain how tournament calendars work.

{% hint style="danger" %}
As of version `v3.18.0-BETA`calendars are in BETA, meaning there may be issues or missing functions!
{% endhint %}

{% hint style="info" %}
Tournament calendars were added in version `v3.18.0`.
{% endhint %}

## Creating a Calendar

To create a calendar, create a new file in the calendar folder located at `/plugins/xltournaments/calendars/` .

There can be more than one calendar at a time so long as they have different names.

Example Calendar

```yaml
# How long should each tournament in this calendar run?
# Supported values: HOURLY, DAILY, WEEKLY, MONTHLY
timeline: WEEKLY

# Should the calendar loop back to the first tournament after the last one ends?
# If false when the last tournament is run it will stop.
loop: true

# Should the next tournament be picked randomly from the list?
# If set to false it runs the list in order.
randomize: false

# The ordered list of tournaments to cycle through.
# Each entry must match the filename (without .yml) of a tournament
tournaments:
  - block_break_tournament
  - item_craft_challenge_tournament
  - player_kills_tournament
```

## Calendar Options

Here we will explain what each option does.

### Timeline

The timeline option functions similarly to how it does for regular tournaments. It defines how long each tournament in the calendar will run for.

### Loop

This true/false option decides if the calendar should loop after all the tournaments are completed or just stop.

### Randomize

This true/false option decides if the tournaments should be played in a random order or if they should be played in the order they are listed in the calendar file.

### Tournaments

This is a list of tournaments that are cycled through in this calendar. For a tournament to be added, copy the name of its YAML file, ensuring you remove the `.yml` part from the end of it.

The tournament must have its Timeline set to `CALENDAR` to function correctly.