# Paycheck System

The Paycheck System lets server members claim recurring points rewards at set intervals. Admins deploy a persistent panel to any channel — users simply click the **Claim Paycheck** button to collect all available rewards at once.

Paid tier servers can customize both the amount and frequency of rewards, and configure up to **3 different paychecks** that run independently (e.g., a daily paycheck and a weekly paycheck).

***

## <mark style="color:$primary;">How to Enable the Paycheck system?</mark>

Use the `/paycheck panel` command to deploy the claim panel to a channel.

<figure><img src="https://691681724-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FS59t2C5jvoYxd5bKEx4E%2Fuploads%2FMyLEhgsIu7klPebpCpkB%2Fimage.png?alt=media&#x26;token=19b8a0e9-4d17-4d71-b52d-b594616e9026" alt=""><figcaption></figcaption></figure>

#### `/paycheck panel`

| Parameter | Required | Description                                        |
| --------- | -------- | -------------------------------------------------- |
| `channel` | ✅        | The channel where the panel will be placed.        |
| `image`   | ❌        | Optional banner image URL to display on the panel. |

**Example:**

```
/paycheck panel channel:#general
/paycheck panel channel:#rewards image:https://example.com/banner.png
```

The panel includes two buttons:

* **💰 Claim Paycheck** — Click to claim all available paycheck rewards at once.
* **🔎 View Claim Info** — View the current active paychecks, their reward amounts, and claim frequencies.

***

### <mark style="color:purple;">Customizations</mark>

> **Note:** Customization commands require a **Paid** tier plan. Free tier servers can still use the panel but are limited to the default settings (such as 100 points every 24 hours).

Servers can configure up to 3 separate paychecks. If a user clicks "Claim Paycheck", the system will award them for all paychecks that are off cooldown.

#### `/paycheck add`

Add a new paycheck or update an existing one for a specific frequency. You can set a minimum and maximum range; when users claim their paycheck, they will receive a random reward within this range. To give a fixed reward amount, set both minimum and maximum to the same value (default is 100).

| Parameter    | Required | Description                                    |
| ------------ | -------- | ---------------------------------------------- |
| `frequency`  | ✅        | Claim frequency in hours (1 – 168).            |
| `min_amount` | ❌        | Minimum reward amount per claim (default 100). |
| `max_amount` | ❌        | Maximum reward amount per claim (default 100). |

**Example:**

```
/paycheck add frequency:24 min_amount:100 max_amount:300   → Adds a daily paycheck with a random reward between 100-300
/paycheck add frequency:12 min_amount:150 max_amount:150   → Adds a 12-hour paycheck with a fixed reward of 150
```

***

#### `/paycheck remove`

Remove a previously configured paycheck by its frequency.

| Parameter   | Required | Description                       |
| ----------- | -------- | --------------------------------- |
| `frequency` | ✅        | The frequency in hours to remove. |

**Example:**

```
/paycheck remove frequency:12    → Removes the 12-hour paycheck.
```

***

#### `/paycheck view`

View all currently configured paychecks for the server.

***

### Summary

| Feature            | Free Tier | Paid Tier           |
| ------------------ | --------- | ------------------- |
| Deploy panel       | ✅         | ✅                   |
| Claim paycheck     | ✅         | ✅                   |
| Customize reward   | ❌         | ✅ (0 – 1,000,000)   |
| Multiple paychecks | ❌         | ✅ (Up to 3 at once) |