Invitation

At 3 AM, you're awakened by your phone buzzing incessantly:
"hey, can you whitelist the account Notch??"
Sound familiar? Scenes like these are happening all across the galaxy. You could be next. That is, unless you use this plugin.

Tell your friends to invite their friends themselves with a simple /invite. No more texts. No more waiting for the admin to whitelist someone. The annual summer Minecraft survival multiplayer server is not admin-picked, but invite-only!

This plugin / server-only mod supports:

• Spigot (Minecraft 1.17 to 26.2)
• Fabric (Minecraft 26.2)
• NeoForge (Minecraft 26.2)

This is a pretty wrapper around vanilla functionality. If there's something more than invites that you expect this plugin to do, it almost certainly already exists in vanilla: blacklists (/ban), kick on uninvite (enforce-whitelist=true), and invite revocation (/whitelist remove).

Features

• Let anyone whitelist a player by username. No more pings to add friends to the summer SMP!
• Revoke mistaken invites within a configurable window. Typos have been forgiven!
• Hold your friends accountable with the invite log. See who invited whom! (operator only)

Installation

1. Download the .jar file from GitHub releases or Modrinth.
2. Place it in your /plugins/ directory in your server root.
3. Start your server.

User guide

How do I invite someone? Use /invite <username>

I mistakenly invited the wrong person. How do I uninvite someone? Use /uninvite to revoke your most recent invite. Beyond that, you need an admin to /whitelist remove <username> them.

I accidentally invited someone and now they are on the server. What do I do? First, revoke their invite if you can. Otherwise, ask the admin to remove them from the whitelist then /kick <username> them. You should set enforce-whitelist=true in your server.properties if you want to kick uninvited players immediately.

How do I figure out who invited a griefer to the server? Use /invitelog received <username> using the username of the griefer. The latest entry is your culprit.

My friend keeps inviting someone I don't like. How do I blacklist that player from being invited? This exists in vanilla already: Just ban that problematic player (not your friend, but you can do that too) with /ban <username>. They can still be invited, but they can't join.

My friend got upset and invited a crap ton of randoms. How do I rollback the whitelist? There is no rollback. You should've kept a copy of whitelist.json as a backup. More importantly, you should have a sit down with your friend.

Can I use this on an offline server? Sure, but it only whitelists real Minecraft accounts. Behind Velocity, this works fine. A real offline server? No.

Commands

Configuration

You can edit the plugin's configuration in plugins/Invitation/config.yml:

Contributing

If you wrote the code for it, I'll happily accept a pull request if I feel like it doesn't bloat the scope of this plugin.

By submitting a contribution to this repository, you agree that your contribution is licensed under the same license as this repository, as published in the LICENSE file.

License

Unless otherwise noted, all source code in this repository is licensed under the Mozilla Public License 2.0 (SPDX: MPL-2.0). Please view the LICENSE file for the terms you are afforded under the MPL-2.0.