Compatibility
Minecraft: Java Edition
Platforms
Tags
Creators
Details
Advanced invitation management plugin for Paper/Spigot 1.21+ servers
๐ฎ What is InviteMe?
InviteMe turns your server's whitelist into a social invitation system. Each player has a configurable number of invitation slots to bring friends to the server. The plugin manages access, keeps an action log, provides an inventory GUI, and rewards proximity between mutually-invited players with an XP multiplier.
โจ Features
- ๐๏ธ Invitation system โ each player has a configurable slot limit; different limits per rank via LuckPerms
- โณ Temporary invitations โ invitations with automatic expiry date support
- ๐ฅ๏ธ Inventory GUI โ graphical interface with player heads, pagination and uninvite confirmation
- โก Mutual XP boost โ XP multiplier for mutually-invited players who are near each other
- ๐๏ธ Multiple backends โ JSON, SQLite, MySQL and PostgreSQL with live migration
- ๐ LuckPerms integration โ automatic group assignment and per-rank invitation limits
- ๐ PlaceholderAPI โ over 15 placeholders for scoreboards, tablist and HUDs
- ๐ Multilingual โ English, Spanish and German included; editable files in
plugins/InviteMe/locales/ - ๐ Action log โ full history of invites and uninvites, exportable to CSV
- ๐ Auto-sync โ keeps the native whitelist in sync with plugin data automatically
- ๐ Plugin mode โ alternative to the native whitelist; access control managed entirely by InviteMe
๐ Requirements
| Requirement | Minimum version | Notes |
|---|---|---|
| Paper / Spigot | 1.21 | Paper recommended |
| Java | 21 | |
| LuckPerms | any | Optional โ group assignment and per-rank limits |
| PlaceholderAPI | any | Optional โ placeholders in other plugins |
๐ Installation
- Download
InviteMe-<version>.jar. - Place it in your server's
plugins/folder. - Start or restart the server.
- The plugin automatically generates
plugins/InviteMe/config.yml. - Edit the configuration and run
/im reload.
๐ฅ๏ธ Inventory GUI
The /invite menu command opens a graphical interface with player heads, pagination, favourite filtering and uninvite confirmation. Admins see all invited players server-wide; regular players see only their own invitations.
๐ Admin view
โก Mutual XP Boost
When two players who mutually invited each other enter the configured radius, both receive an XP multiplier. The effect stacks with multiple partners and is configurable per world.
โ๏ธ Boost configuration
mutual-invite-boost:
enabled: true
xp-multiplier: 1.5 # +50% XP
check-interval: 5 # seconds between checks
show-actionbar: true
particle-effects: true
max-boost-partners: 3
max-multiplier: 2.5
radius:
overworld: 50
nether: 75
end: 100
Add custom worlds under mutual-invite-boost.radius.custom-worlds:
radius:
custom-worlds:
mining_world: 60
๐ฌ Commands
๐ค Player commands โ /invite
Require the
invite.usepermission (granted to all players by default).
| Command | Description |
|---|---|
/invite add <player> |
Invite a player to the server |
/invite add <player> <days> |
Temporary invitation with expiry (requires invite.temp) |
/invite list |
Show your invitations and remaining slots |
/invite list <player> |
Show another player's invitation list |
/invite list all |
Global inviter ranking |
/invite tree [player] |
Invitation chain (up to 20 levels up) |
/invite menu |
Open the inventory GUI |
๐ก๏ธ Admin commands โ /im
Require the
invite.adminpermission (OPs only by default).
| Command | Description |
|---|---|
/invite remove <player> [reason] |
Remove a player from the server |
/im stats [N] |
Global statistics and top N inviters |
/im log list [player] [N] |
Action log, filterable by player |
/im log export [global|player] |
Export the log to a CSV file |
/im sync |
Force an immediate whitelist sync |
/im debug |
Plugin diagnostic information |
/im reload |
Reload configuration without restarting |
/im migrate [sqlite|mysql|postgresql] |
Migrate data between backends |
/im boost [status|on|off|check] |
Diagnose and control the mutual boost |
๐ Permissions
View permissions table
| Permission | Default | Description |
|---|---|---|
invite.use |
Everyone | Invite players and view own invitation list |
invite.admin |
OP | Full administrative access; bypasses limits and cooldown |
invite.temp |
false | Create temporary invitations with expiry |
invite.stats |
OP | View global statistics with /im stats |
invite.log |
OP | View and export the action log with /im log |
invite.number.X |
โ | Custom limit of X invitations (e.g. invite.number.10) |
invite.* |
OP | Wildcard โ grants all permissions |
Limit priority: invite.number.X > group-limits in config > max-invites in config.
To give a rank unlimited invitations:
/lp group <rank> permission set invite.admin true
Or a specific number:
/lp group <rank> permission set invite.number.20 true
๐ PlaceholderAPI
View all placeholders
Requires PlaceholderAPI installed.
๐ค Per player
| Placeholder | Description |
|---|---|
%inviteme_max_invites% |
Maximum invitation limit (โ if unlimited) |
%inviteme_used_invites% |
Invitations already used |
%inviteme_remaining_invites% |
Remaining invitations |
%inviteme_invited_players% |
Number of players invited |
%inviteme_is_invited% |
true if the player was invited by someone |
%inviteme_invited_by% |
Name of the player who invited them |
%inviteme_rank% |
Position in the inviter ranking |
%inviteme_invites_bar% |
Visual progress bar (e.g. โโโโโโโโโโ) |
%inviteme_invites_percentage% |
Percentage of invitations used |
%inviteme_status% |
Status: Unlimited, Limited or Full |
โก Boost system
| Placeholder | Description |
|---|---|
%inviteme_boost_active% |
true if mutual boost is active |
%inviteme_boost_partners% |
Number of active boost partners |
%inviteme_boost_multiplier% |
Current XP multiplier (e.g. 1.5) |
%inviteme_boost_percentage% |
XP increase percentage (e.g. 50%) |
๐ Global stats
| Placeholder | Description |
|---|---|
%inviteme_total_invites% |
Total invitations on the server |
%inviteme_total_players% |
Total invited players |
%inviteme_top_inviter% |
Player with the most invitations |
%inviteme_top_inviter_count% |
Top inviter's invitation count |
๐๏ธ Storage
View storage backends and configuration
| Backend | Description |
|---|---|
json |
Local file invites.json, no additional setup |
sqlite |
Local database invites.db, recommended (default) |
mysql |
Remote MySQL or MariaDB database |
postgresql |
Remote PostgreSQL database |
To migrate between backends: run /im migrate <type>, wait for confirmation, then update storage.type in config.yml and run /im reload.
storage:
type: sqlite # json | sqlite | mysql | postgresql
remote:
host: localhost
port: 3306 # 5432 for PostgreSQL
database: inviteme
username: root
password: password
pool-size: 10
๐ Access Control
Native whitelist vs plugin mode
access-control-mode: native # native | plugin
nativeโ Minecraft's native whitelist controls access (default).pluginโ InviteMe manages access directly; setwhite-list=falseinserver.properties. OPs and players withinvite.admincan always join.
โ FAQ
Why can't a player invite even with the invite.use permission?
They may have reached the max-invites limit or be on cooldown. Players with invite.admin have no such restrictions.
A player appears on the whitelist but not in /invite list.
They were added directly via /whitelist add. With whitelist-sync.auto-register-console: true the plugin will register them on the next sync, or force it with /im sync.
Does the boost work in custom worlds?
Yes, add the world under mutual-invite-boost.radius.custom-worlds:
radius:
custom-worlds:
mining_world: 60
๐ License
InviteMe is source-available, not open-source.
- โ Permitted: Use the plugin on your servers, create addons via the Dev Kit
- โ Not permitted: Sell InviteMe, modify the source code, create forks
- ๐ Extension: Addons created with the official Dev Kit can have their own licenses
See LICENSE for full terms.