⚠️ This project requires to be set up on both sides, client and server side ⚠️

HandShaker 4.0.0

HandShaker is a cross-platform mod/plugin system for Minecraft servers and clients.
It lets Paper/Fabric servers see which Fabric mods players are using, and automatically enforce a blacklist with customizable kick messages. Wiki is there!

• Fabric mod: Sends your mod list to the server when you join.
• Fabric/Paper plugin: Checks mod lists against a blacklist and kicks players using forbidden mods.

Features

• Per mod configuration: Individualy set mod allowance to Required, Allowed or Blacklisted
• Fabric client <-> Paper/Fabric server
• Configurable kick & Missing mod messages
• Integrity: Prevents self-compiled hand-shaker mods from being used
• See other player mods: Allows to See/Blacklist/Allow other player mods

Installation

Universal (Fabric Client, Fabric server, Paper)

1. Download Hand Shaker <version> (Universal).
2. Place it in your mods folder or plugin folder.
3. If server, start server once to generate config file and edit it.

Server (Paper)

1. Download hand-shaker-paper-<version>.jar.
2. Place it in your server's plugins/ folder.
3. Start the server once to generate the config.
4. Edit plugins/HandShaker/config.yml as you need.

Server (Fabric)

1. Download hand-shaker-<version>.jar.
2. Place it in your server's mods/ folder.
3. Start the server once to generate the config.
4. Edit config/hand-shaker.json as you need.

Client (Fabric)

1. Download hand-shaker-<version>.jar.
2. Place it in your Fabric client's mods/ folder.
3. No config needed — the mod just sends your mod list to the server.

Configuration

Example of default config.yml for Paper server:

config: v2 #DO NOT CHANGE!!!

Kick Message: "You are using a blacklisted mod: {mod}. Please remove it to join this server."
Missing required mod message: "You are missing required mods: {mod}. Please install them to join this server."
Missing mod message: "To connect to this server please download 'Hand-shaker' mod."
Invalid signature kick message: "Invalid client signature. Please use the official client."

Behavior: Strict

#"Strict" - Kick clients with blacklisted mods + Kick non Hand-shaker mod clients
#"Vanilla" - Kick clients with blacklisted mods but ignoring non Hand-shaker mod clients (Could be dangerous if clients spoofs clients)

Integrity: Signed

#"Signed" - Accepts only-signed handshaker copies, preventing using modified handshaker mod
#"Dev" - Accepts non-signed copys, Only for personal use or self signed copies (Could be potentially dangerous)

#Per-mod configuration system:
#"required" - Mod must be present to join the server
#"allowed" - Mod is permitted but not required
#"blacklisted" - Mod will cause kick if detected
#Mods not in the list will be treated based on Default Mode setting

Default Mode: allowed

#"allowed" - Unlisted mods are permitted (permissive)
#"blacklisted" - Unlisted mods will cause kick (restrictive)

Mods:
  hand-shaker: required
  xraymod: blacklisted
  testmod: blacklisted
  forge: blacklisted

Example of default hand-shaker.json for Fabric server:

{
  "config": "v2",
  "integrity": "SIGNED",
  "behavior": "STRICT",
  "invalid_signature_kick_message": "Invalid client signature. Please use the official client.",
  "kick_message": "You are using a blacklisted mod: {mod}. Please remove it to join this server.",
  "missing_mod_message": "To connect to this server please download 'Hand-shaker' mod.",
  "missing_whitelist_mod_message": "You are missing required mods: {mod}. Please install them to join this server.",
  "default_mode": "ALLOWED",
  "mods": {
    "hand-shaker": "REQUIRED",
    "xraymod": "BLACKLISTED",
    "testmod": "BLACKLISTED",
    "forge": "BLACKLISTED"
  }
}

• {mod} in Kick Message will be replaced with the actual mod(s) found.

Commands

Permissions

• handshaker.admin — Required for all /handshaker commands (ops have this by default).