Invites

Configure invite tracking and role rewards for inviting members

Introduction

The Invites configuration file (invites.json) controls the invite tracking system and role rewards for users who invite members to your server.

---

Role Rewards

Automatically assign roles to users based on how many members they've successfully invited to the server.

enabled

Type: Boolean

Enables or disables invite role rewards.

role_rewards: {
    enabled: false,
}

When true: Users receive roles when they reach invite milestones When false: Invite tracking still works, but no roles are automatically assigned

---

keep_all_roles

Type: Boolean

Determines whether users keep all earned invite roles or only the highest one.

keep_all_roles: true

When true:

• User with 5 invites gets the 5-invite role

• When they reach 10 invites, they keep the 5-invite role AND get the 10-invite role

• Users accumulate all milestone roles

When false:

• User with 5 invites gets the 5-invite role

• When they reach 10 invites, the 5-invite role is removed and replaced with the 10-invite role

• Users only have their highest milestone role

---

roles

Type: Array of Objects

Define which roles are awarded at which invite counts.

roles: [
    {
        invites: 5,
        role_id: "804354034135597066",
    },
    {
        invites: 10,
        role_id: "804354033338286130",
    },
    {
        invites: 25,
        role_id: "123456789012345678",
    },
    {
        invites: 50,
        role_id: "234567890123456789",
    },
]

invites - Number of successful invites required to earn the role role_id - Discord role ID to assign

Note: Only successful invites count - if an invited member leaves the server, the invite count may be adjusted based on your server's invite tracking settings.

---

Complete Configuration Example

Here's a complete invite rewards configuration:

{
    config: {
        role_rewards: {
            enabled: true,
            keep_all_roles: true,
            roles: [
                {
                    invites: 5,
                    role_id: "804354034135597066",
                },
                {
                    invites: 10,
                    role_id: "804354033338286130",
                },
                {
                    invites: 25,
                    role_id: "123456789012345678",
                },
                {
                    invites: 50,
                    role_id: "234567890123456789",
                },
                {
                    invites: 100,
                    role_id: "345678901234567890",
                },
            ]
        }
    },
}