# Invite Tracker

The Invite Tracking system allows server administrators to reward members for inviting new users to the server. The system tracks who invited whom and provides rewards based on configurable criteria.

#### How Invite Rewards Work

1. When a member invites someone to the server, the system automatically tracks this
2. The inviter becomes eligible for rewards when:
   * The invited user gets the required role (if configured)
   * The invited user stays for the minimum duration (if configured)
3. Rewards are automatically added to the inviter's balance once conditions are met

#### Important Notes

* If an invited user leaves before meeting the minimum stay requirement, the invite is not counted
* If an invited user leaves after the reward is claimed, the reward amount is deducted from the inviter's balance
* The system automatically tracks and updates invite statistics

## <mark style="color:red;">Server Admin Setup</mark>

Server administrators can configure invite rewards using the following commands:

### **Set Reward Amount**

```
/invite-config set-reward <amount>
```

* Sets the number of points awarded for each successful invite
* Range: 0 to 1,000,000 points
* Set to 0 to disable invite rewards

### **Set Required Role**

```
/invite-config set-required-role <role>
```

* Sets a role that invited users must have for the inviter to receive rewards
* This ensures that only quality invites (users who get the required role) are rewarded
* Useful for ensuring new members are properly integrated into the community

### **Set Minimum Stay Duration**

```
/invite-config set-minimum-stay-days <days>
```

* Sets the minimum number of days an invited user must stay in the server
* Range: 0 to 30 days
* Helps prevent abuse by requiring invited users to stay for a minimum period

### **Remove Required Role**

```
/invite-config remove-required-role
```

* Removes the required role requirement for invite rewards

### **View Current Settings**

```
/invite-config view
```

* Displays current invite reward configuration including:
  * Reward amount
  * Required role (if set)
  * Minimum stay duration

## <mark style="color:yellow;">For Community Members</mark>

### Viewing Invites

Members can check their invite statistics using:

```
/invites
```

This command shows:

* Total number of successful invites
* Pending invites (users who haven't met the minimum stay requirement)
* Claimed rewards

## Package Comparison

| Feature                             | Free | Pro        | Enterprise       |
| ----------------------------------- | ---- | ---------- | ---------------- |
| Customize Required Role             | ❌    | ✅          | ✅                |
| Customize Minimum Stay Days         | ❌    | ❌          | ✅                |
| Customize Maximum Reward per Invite | ❌    | 100 points | 1,000,000 points |
