> For the complete documentation index, see [llms.txt](https://tn-modifications.gitbook.io/tn-modifications/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tn-modifications.gitbook.io/tn-modifications/tn_adventcalendar.md).

# Advanced Advent Calendar

Seasonal rewards with a 3D calendar, missions, hidden presents, gifting and global events.

Seasonal rewards with a 3D calendar, missions, hidden presents, gifting and global events.

## Requirements

**ox\_lib**, **oxmysql**, and ESX, QBCore or Qbox. Standalone requires custom framework hooks.

## Installation

{% stepper %}
{% step %}

### Install

Copy `tn_adventcalendar` into resources. The release UI is included in `html/`; no web build is needed.
{% endstep %}

{% step %}

### Authorize

```cfg
ensure oxmysql
ensure ox_lib
ensure tn_adventcalendar
add_ace group.admin tnadvent.admin allow
```

Start framework and inventory first. Tables are created automatically; `install/adventcalendar.sql` supports manual import.
{% endstep %}

{% step %}

### Configure the season

Use `/adventadmin` for dates, doors, loot pools, streaks and events. Open `/advent` to test.
{% endstep %}
{% endstepper %}

## Configuration

| Location              | Purpose                                     |
| --------------------- | ------------------------------------------- |
| `config.lua`          | Bridges, commands, props, UI and missions   |
| Admin dashboard       | Dates, rewards, jackpot and feature toggles |
| `server/defaults.lua` | Dashboard defaults                          |
| `config_server.lua`   | Server-only webhooks/custom hooks           |

Dashboard settings persist in the database and override defaults. Rewards support money, items, vehicles, weapons and custom events.

<details>

<summary>Testing commands</summary>

`/adventnextday` advances the test day; `/adventresetday` restores the date. `/adventevent` manages events, `/adventhidden [new]` shows/rerolls a hidden present, and `/adventcancel` cancels a mission. Access follows configured command/admin rules.

</details>

## Technical documentation

* [Exports & custom rewards](https://tn-modifications.gitbook.io/tn-modifications/tn_adventcalendar/exports.md) — Server API for calendar progress, rewards and active event effects.
* [Rewards & configuration](https://tn-modifications.gitbook.io/tn-modifications/tn_adventcalendar/configuration.md) — Configuration examples, supported options and setup checks.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://tn-modifications.gitbook.io/tn-modifications/tn_adventcalendar.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
