适用于 Paper/Spigot 1.21+ 服务器的先进邀请管理插件
? InviteMe 是什么?
InviteMe 将你的服务器白名单转变为一个社交邀请系统。每位玩家都拥有可配置的邀请名额,用于邀请好友加入服务器。该插件管理访问权限、记录操作日志、提供库存 GUI,并通过对互相邀请且彼此靠近的玩家给予经验值倍率作为奖励。
✨ 功能特点
- ?️ 邀请系统 — 每位玩家拥有可配置的名额上限;支持通过 LuckPerms 为不同权限组设置不同的上限
- ⏳ 临时邀请 — 支持自动过期的带期限邀请
- ?️ 库存 GUI — 带有玩家头像、分页和取消邀请确认的图形界面
- ⚡ 相互经验加成 — 互相邀请且彼此靠近的玩家获得经验值倍率
- ?️ 多种后端 — 支持 JSON、SQLite、MySQL 和 PostgreSQL,并支持实时迁移
- ? LuckPerms 集成 — 自动分配组别以及按权限组设置邀请上限
- ? PlaceholderAPI — 提供超过 15 个占位符,可用于记分板、Tab 列表和 HUD
- ? 多语言支持 — 包含英语、西班牙语和德语;可通过
plugins/InviteMe/locales/ 中的文件进行编辑
- ? 操作日志 — 完整的邀请和取消邀请历史记录,支持导出为 CSV
- ? 自动同步 — 自动保持原生白名单与插件数据同步
- ? 插件模式 — 替代原生白名单;访问控制完全由 InviteMe 管理
? 要求
| 要求 |
最低版本 |
备注 |
| Paper / Spigot |
1.21 |
推荐使用 Paper |
| Java |
21 |
|
| LuckPerms |
任意版本 |
可选 — 用于组别分配和按权限组设置上限 |
| PlaceholderAPI |
任意版本 |
可选 — 供其他插件使用占位符 |
? 安装
- 下载
InviteMe-<version>.jar。
- 将其放入服务器的
plugins/ 文件夹中。
- 启动或重启服务器。
- 插件会自动生成
plugins/InviteMe/config.yml。
- 编辑配置文件并运行
/im reload。
?️ 库存 GUI
/invite menu 命令打开一个带有玩家头像、分页、收藏过滤和取消邀请确认的图形界面。管理员可以看到全服所有被邀请的玩家;普通玩家只能看到自己的邀请列表。
? 管理员视图
⚡ 相互经验加成
当两个互相邀请的玩家进入配置的半径范围内时,双方都会获得经验值倍率。此效果可与多个伙伴叠加,并且可以在每个世界中单独配置。
⚙️ 加成配置
mutual-invite-boost:
enabled: true
xp-multiplier: 1.5 # +50% 经验值
check-interval: 5 # 检查间隔(秒)
show-actionbar: true
particle-effects: true
max-boost-partners: 3
max-multiplier: 2.5
radius:
overworld: 50
nether: 75
end: 100
在 mutual-invite-boost.radius.custom-worlds 下添加自定义世界:
radius:
custom-worlds:
mining_world: 60
? 指令
? 玩家指令 — /invite
需要 invite.use 权限(默认授予所有玩家)。
| 指令 |
描述 |
/invite add <player> |
邀请一名玩家加入服务器 |
/invite add <player> <days> |
创建带过期时间的临时邀请(需要 invite.temp 权限) |
/invite list |
显示你的邀请列表和剩余名额 |
/invite list <player> |
显示另一名玩家的邀请列表 |
/invite list all |
全局邀请者排名 |
/invite tree [player] |
邀请链关系(最多向上追溯 20 级) |
/invite menu |
打开库存 GUI |
?️ 管理员指令 — /im
需要 invite.admin 权限(默认仅 OP 可用)。
| 指令 |
描述 |
/invite remove <player> [reason] |
从服务器移除一名玩家 |
/im stats [N] |
全局统计数据和前 N 名邀请者 |
/im log list [player] [N] |
操作日志,可按玩家筛选 |
/im log export [global|player] |
将日志导出为 CSV 文件 |
/im sync |
强制立即同步白名单 |
/im debug |
插件诊断信息 |
/im reload |
重新加载配置而无需重启服务器 |
/im migrate [sqlite|mysql|postgresql] |
在不同后端之间迁移数据 |
/im boost [status|on|off|check] |
诊断和控制相互经验加成 |
? 权限
查看权限表
| 权限 |
默认值 |
描述 |
invite.use |
所有人 |
邀请玩家并查看自己的邀请列表 |
invite.admin |
OP |
完全管理访问权限;绕过限制和冷却时间 |
invite.temp |
false |
创建带过期时间的临时邀请 |
invite.stats |
OP |
使用 /im stats 查看全局统计数据 |
invite.log |
OP |
使用 /im log 查看和导出操作日志 |
invite.number.X |
— |
自定义 X 个邀请名额限制(例如 invite.number.10) |
invite.* |
OP |
通配符 — 授予所有权限 |
优先级顺序: invite.number.X > 配置文件中的 group-limits > 配置文件中的 max-invites。
要为某个权限组提供无限制的邀请名额:
/lp group <rank> permission set invite.admin true
或指定具体数量:
/lp group <rank> permission set invite.number.20 true
? PlaceholderAPI
查看所有占位符
需要安装 PlaceholderAPI。
? 玩家个人数据
| 占位符 |
描述 |
%inviteme_max_invites% |
最大邀请限额(无限制时显示为 ∞) |
%inviteme_used_invites% |
已使用的邀请次数 |
%inviteme_remaining_invites% |
剩余邀请次数 |
%inviteme_invited_players% |
被邀请的玩家数量 |
%inviteme_is_invited% |
如果该玩家被他人邀请,则返回 true |
%inviteme_invited_by% |
邀请者的名称 |
%inviteme_rank% |
在邀请者排行榜中的排名 |
%inviteme_invites_bar% |
可视化进度条(例如 ██████░░░░) |
%inviteme_invites_percentage% |
已使用邀请的百分比 |
%inviteme_status% |
状态:Unlimited(无限制)、Limited(有限制)或 Full(已满) |
⚡ 增益系统
| 占位符 |
描述 |
%inviteme_boost_active% |
如果双向增益处于激活状态,则返回 true |
%inviteme_boost_partners% |
当前激活的增益伙伴数量 |
%inviteme_boost_multiplier% |
当前的经验值倍率(例如 1.5) |
%inviteme_boost_percentage% |
经验值提升百分比(例如 50%) |
? 全局统计
| 占位符 |
描述 |
%inviteme_total_invites% |
服务器上的总邀请次数 |
%inviteme_total_players% |
总被邀请玩家数 |
%inviteme_top_inviter% |
邀请次数最多的玩家 |
%inviteme_top_inviter_count% |
榜首玩家的邀请次数 |
?️ 存储
查看存储后端及配置
| 后端 |
描述 |
json |
本地文件 invites.json,无需额外设置 |
sqlite |
本地数据库 invites.db,推荐使用 (默认) |
mysql |
远程 MySQL 或 MariaDB 数据库 |
postgresql |
远程 PostgreSQL 数据库 |
要在不同后端之间迁移:运行 /im migrate <type>,等待确认,然后更新 config.yml 中的 storage.type 并运行 /im reload。
storage:
type: sqlite # json | sqlite | mysql | postgresql
remote:
host: localhost
port: 3306 # PostgreSQL 使用 5432
database: inviteme
username: root
password: password
pool-size: 10
? 访问控制
原生白名单与插件模式对比
access-control-mode: native # native | plugin
native — 由 Minecraft 原生的白名单功能控制访问权限(默认)。
plugin — InviteMe 直接管理访问权限;需在 server.properties 中设置 white-list=false。OP 和拥有 invite.admin 权限的玩家始终可以加入。
❓ 常见问题
为什么玩家即使拥有 invite.use 权限也无法发送邀请?
他们可能已达到 max-invites 上限或正处于冷却时间中。拥有 invite.admin 权限的玩家不受这些限制。
某玩家出现在白名单中,但未显示在 /invite list 里。
他们是直接通过 /whitelist add 添加的。当 whitelist-sync.auto-register-console: true 开启时,插件将在下次同步时自动注册他们,或者你可以使用 /im sync 强制同步。
增益效果是否适用于自定义世界?
是的,将世界名称添加到 mutual-invite-boost.radius.custom-worlds 下:
radius:
custom-worlds:
mining_world: 60
? 许可证
InviteMe 是 源码可用(source-available) 软件,而非开源软件。
- ✅ 允许: 在你的服务器上使用该插件,通过 Dev Kit 创建插件
- ❌ 禁止: 出售 InviteMe、修改源代码、创建分支版本
- ? 扩展: 使用官方 Dev Kit 创建的插件可拥有独立的许可证
请参阅 LICENSE 了解完整条款。
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.use permission (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.admin permission (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; set white-list=false in server.properties. OPs and players with invite.admin can 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.
评论 0
登录后参与评分
还没有评论,来抢沙发吧