FAQ - Frequently Asked Questions

Quick answers to the most common questions.

General

Q: Why should I use InviteMe instead of just the vanilla whitelist?

A: InviteMe provides:

✅ Players manage their own invitations (no admin work)
✅ Temporary invitations (expires after N days)
✅ Mutual XP boost for invited friends
✅ Complete action log (who invited whom, when)
✅ Statistics and analytics
✅ Better permission control with LuckPerms

Installation & Setup

Q: I installed the plugin but it’s not loading. What do I do?

A: Check these things:

You’re running Java 21 or higher: java -version
You’re running Paper 1.21.10+ (not pure Spigot)
The JAR is in your plugins/ folder
Your server console shows: [InviteMe] Plugin loaded successfully

If still not working, run: /im debug to see status

Q: Can I use InviteMe on a bukkit/pure Spigot server?

A: InviteMe requires Paper specifically. Paper is backward-compatible with Spigot plugins but adds extra features we depend on.

Upgrade to Paper: Download from https://papermc.io/

Invitations

Q: A player says they can’t join, but I already invited them. Why?

A: Check these things:

Did you invite them? Check: /invite list
Did you use the correct username? (case-sensitive sometimes)
Did someone uninvite them? Check: /im log list
Is their invitation expired? (if temporary)

Try: /im sync to resync with the native whitelist

Q: How do I invite someone for only 7 days?

A: Use the days parameter:

/invite add PlayerName 7

The invitation automatically expires after 7 days. Change 7 to any number of days.

Q: Can I change how long temporary invitations last?

A: Yes! Edit config.yml:

temporary-invite-expiry-days: 14

Then run: /im reload

Q: What happens when an invitation expires?

A: The player is automatically removed from the whitelist and can’t join anymore. They don’t receive a warning message.

Configuration

Q: How do I switch from SQLite to MySQL?

Edit config.yml:

storage:
  type: mysql
  remote:
    host: your-db-host.com
    port: 3306
    database: inviteme
    username: your_user
    password: your_password

Run: /im reload
InviteMe automatically migrates your data!

Original SQLite file is renamed to .migrated

Q: What storage backend should I use?

SQLite (default) - Great for small/medium servers (up to 100 players)
MySQL - Needed for large servers or multi-server networks
PostgreSQL - Alternative to MySQL, similar performance
JSON - Only for testing, not recommended for production

See: Storage Backends Guide

Q: Does InviteMe work with my permission plugin?

A: Yes! InviteMe works with any permission plugin. For LuckPerms specifically, we have special integration:

luckperms:
  enabled: true
  group-limits:
    member: 3
    vip: 10
    admin: 99

See: LuckPerms Integration Guide

Features & Usage

Q: Can I see who invited which players?

A: Yes! There are several ways:

View a player’s full invite history:
```
/im log list PlayerName
```
View all invitations:
```
/invite list all
```
View global action log:
```
/im log list
```

Q: Does the mutual boost system require both players to have permission?

A: No. The boost is automatic and needs no permissions:

Player A invites Player B (/invite add PlayerB) — that single invite is enough
When both are online, in the same world, and within range, both receive the XP boost
Player B cannot invite Player A back (A was already on the server), and they don’t need to

Troubleshooting

Q: My changes to config.yml don’t take effect

A: You need to reload the plugin:

/im reload

Do NOT restart the server (though it also works). The reload command is instant and keeps things running.

Q: The /im stats command doesn’t work

A: Check your permission:

You need invite.stats (default: op)
Or invite.admin gives you everything

If you have the permission but it still doesn’t work:

/im reload
/im debug

Q: I can’t find the config.yml file

A: It’s located at:

plugins/InviteMe/config.yml

If it doesn’t exist:

Start the plugin: /im reload
The file will be created automatically

Advanced

Q: Can I customize the messages players see?

A: Yes! InviteMe includes editable language files:

plugins/InviteMe/locales/en.yml
plugins/InviteMe/locales/es.yml
plugins/InviteMe/locales/de.yml

Edit any file and run: /im reload

If the file gets corrupted, delete it and InviteMe will recreate it.

Q: What data does InviteMe store?

A: Only:

Invited player UUIDs and names
Inviter names
Invitation timestamps
Action log (who did what, when)
Player statistics (XP boosted)

No personal data beyond Minecraft usernames/UUIDs is stored.

Still Have Questions?

📖 Check the full Commands Guide
⚙️ See Complete Configuration Reference
🔗 Read LuckPerms Integration
💬 Report issues on Modrinth Discussions

Last updated: 2024 | InviteMe Documentation