whitelisted

The Minecraft side of a self-service allow-listing service.

For the auth server, please see this repository.

What this does

This mod is part of a self-service onboarding service. It adds an extra layer of authorization when players log in to a Minecraft server, by asking an auth server whether a given player is allowed to join or not.

Essentially, this is a glue mod to the auth server, which does user auth with MSA* and displays a document prior to adding a player to the allow list.

The original goal for this project is to enforce players to read a code-of-conduct document before playing.
While newer Minecraft versions already have this feature built-in, this project still serves a purpose as a gatekeeper against malicious players or bots that ignore the rules screen.

This mod does not talk to any specific server out of the box. It must be configured before use.

tl;dr: If you are a server admin intending to operate a public server but would like some protection from server scanner griefers and make players agree to some rules, then whitelisted might be a solution.

[!NOTE] If you are a player intending to play on a server, you do not need to install this.

[!IMPORTANT] Setting up this service requires some technical knowledge, and at the moment this mod does not serve any purpose without the backend server.

In the future, this mod will become optional as it is planned for the backend to talk to the management websocket directly.

Footnotes

*: Microsoft Accounts