InviteRewards Documentation

Overview

InviteRewards is a referral and invitation system for Minecraft servers that rewards players for bringing new members into the community.

Each player receives a unique invitation code and can invite friends to join the server. Once the invited player meets the configured validation requirements, the invitation becomes valid and contributes toward the inviter's rewards.


Installation

1. Stop your server.
2. Place InviteRewards.jar inside the /plugins/ folder.
3. Start the server.
4. Configure the plugin in:

plugins/InviteRewards/config.yml

1. Restart the server or run:

/inviteadmin reload


How the System Works

Step 1: Players Receive an Invite Code

Every registered player automatically receives:

• A unique invite code.
• The ability to use their username as an invite reference.

Example:

ABC123

or

Brian


Step 2: New Players Use an Invitation

Players can register an invitation using:

/invite <code>

or

/invite <player>

Examples:

/invite ABC123

/invite Brian


Step 3: Validation Process

Invitations are not instantly rewarded.

The invited player must meet the configured validation requirements.

Example:

validation:

required-playtime-hours: 24

After reaching the required playtime, the invitation becomes valid automatically.


Step 4: Reward Progress

Validated invitations increase the inviter's progress.

Players can track their progress through:

/invites

The GUI displays:

• Validated invitations.
• Pending invitations.
• Available invitations.
• Reward requirements.
• Reward preview.

Step 5: Claiming Rewards

When the required number of invitations is reached:

reward:

required-invites: 20

The player can claim their reward from the GUI.

Reward commands are fully configurable.

Example:

reward:

commands:

- "lp user %player% parent add vip"

- "crate give %player% epic 5"

- "eco give %player% 50000"


Reward System

InviteRewards uses a reusable reward system.

Example:

Required Invitations

reward:

required-invites: 20

Player Progress

20 Invitations = 1 Reward

40 Invitations = 2 Rewards

60 Invitations = 3 Rewards

Each reward claim only consumes the configured amount of invitations.

Example:

Player has 45 available invitations.


Claims reward.


45 - 20 = 25 remaining invitations.


Reward Preview

Players can preview rewards directly in the GUI.

Example:

reward:

display:

- "&7You will receive:"

- "&e• VIP Rank"

- "&e• 5 Epic Keys"

- "&e• $50,000"

This only affects the visual display and does not execute any commands.


Main GUI

Open using:

/invites

The main menu contains:

Profile

Displays:

• Player name
• Validated invitations
• Available invitations

Invite Code

Displays:

• Personal invite code
• Player name

Progress

Displays:

• Validated invitations
• Pending invitations
• Available invitations
• Current goal

Rewards

Displays:

• Reward status
• Required invitations
• Available invitations
• Reward preview

Top Inviters

Displays the leaderboard.


Top Inviters Menu

The leaderboard displays:

• Top 20 inviters.
• Real player heads.
• Top positions highlighted.
• Best inviter indicator.
• Back button.
• Inventory protection.

Only players with at least one invitation appear in the ranking.


Anti-Abuse Features

InviteRewards includes several protection systems:

One Invitation Per Account

A player may only use one invitation.

Self-Invite Protection

Players cannot invite themselves.

Duplicate Invite Protection

The same account cannot register multiple invitations.

IP Validation

Prevents abuse through alternate accounts using the same IP address.

Playtime Validation

Rewards are only granted after meeting the required playtime.


Administrative Commands

Permission:

inviterewards.admin


Reload Configuration

/inviteadmin reload

Reloads the configuration file.


Player Information

/inviteadmin info <player>

Displays:

• Invite code
• Total invitations
• Available invitations
• Playtime

Example:

/inviteadmin info Brian


Add Invitations

/inviteadmin add <player> <amount>

Adds valid invitations directly to a player.

Example:

/ inviteadmin add Brian 10


Reset Statistics

/inviteadmin reset <player>

Resets all player statistics.


Migrate Existing Players

/inviteadmin migrate

Registers existing server players into the database.

Use this command when installing InviteRewards on an already established server.

This ensures:

• Existing players receive invite codes.
• New invitations start working immediately.
• Existing server data remains untouched.

Configuration Example

validation:

required-playtime-hours: 24


reward:

required-invites: 20


display:

- "&7You will receive:"

- "&e• VIP Rank"

- "&e• 5 Epic Keys"

- "&e• $50,000"


commands:

- "lp user %player% parent add vip"

- "crate give %player% epic 5"

- "eco give %player% 50000"


Permissions

Permission

Description

inviterewards.admin

Access to administrative commands


Compatibility

• Spigot
• Paper
• Purpur

Modern Minecraft versions are recommended.


Support

If you encounter issues or have feature requests, please contact the plugin author through the marketplace where the plugin was purchased.