ClientID is a mod-plugin pair that allows server owners to view the mod and resource pack lists of all joining players and ban specific mods/packs from entering the server. In order to be used, the plugin must be installed on the server, and the mod must be installed on the client.
The mod list can be changed via the config in the server. Properties and what they do are listed here:
| Option | Description | Default Value |
|---|---|---|
| requireMod | If enabled, all players who join will be required to have ClientID installed. If requireMod is enabled, when a player joins, then until they are confirmed to have the mod installed by the server, they will be unable to perform any actions, including taking damage. | true |
| keywordBans | Any keywords in this list will be checked against player mod lists and, if a keyword is contained in one of the player's mods, they will be kicked. | - |
| blacklist | A list of specific mod IDs to be banned | - |
| whitelist | A list of mod IDs that bypass keywordBans and blacklist and are allowed to be used even if one of those two lists contains a ban for it. | - |
| playerBypass | A list of usernames of players that are allowed to join even if they don't have ClientID or have a banned mod installed. | - |
| reversePlayerBypass | Changes playerBypass from a whitelist into a blacklist, so all players in the list will be required to have ClientID, while all players outside it will not. | false |
| disablePieChart | Disallows clients from opening the pie chart | false |
| logModsOnJoin | Whether to print out the player's mods and resource packs when they join | true |
Should you find any problems, please report them to the linked issue tracker with logs and a description of the issue. For Geyser users, Bedrock players may join, but no checks will be performed on them.
This is designed to be a preventative for a majority of hackers and is not a foolproof solution. It is highly recommended to use an anticheat in tandem with ClientID to increase your server's safety further.
To Forge/NeoForge users
This mod can be used on Forge/NeoForge by pairing with conversion mods. In order to do so, you must install these mods alongside ClientID:
https://modrinth.com/mod/forgified-fabric-api
https://modrinth.com/mod/connector
https://modrinth.com/mod/fabric-permissions-api
THE FUTURE
This mod will no longer be receiving feature updates. It will continue to be updated to newer versions, but no new features will be added. Consequently, the mod's source code is now licensed under the GNU GPL 3.0 license to allow the community to make and distribute further open-source changes.
