### **\u26a0\ufe0f This project requires to be set up on both sides, client and server side \u26a0\ufe0f**<\/p>\n
# \ud83e\udd1d HandShaker 7.0.0 (alpha) Wiki is there!<\/p>\n
\n
\n
\n
\n
\n
\n
\n<\/p>\n
—<\/p>\n
## \ud83d\udccb What is HandShaker?<\/p>\n
HandShaker is a **cross-platform mod\/plugin verification system** for Minecraft servers and clients. It enables servers to detect which mods players are running and enforce mod restrictions with customizable policies.<\/p>\n
### \ud83c\udfaf Core Functionality<\/p>\n
– **Fabric\/Neoforge Client** \u2192 Sends your active mod list to the server upon join
\n– **Paper\/Fabric\/NeoForge Server** \u2192 Validates mod lists against configured rules and enforces restrictions
\n– **Multi-platform Support** \u2192 Works across Fabric, Paper, and NeoForge
\n– **Cryptographic Integrity** \u2192 Prevents tampered or self-compiled HandShaker mods
\n– **Flexible Configuration** \u2192 Per-mod rules: Required, Allowed, or Blacklisted<\/p>\n
—<\/p>\n
## \u2728 Key Features<\/p>\n
| Feature | Description |
\n| ——————————- | ——————————————————————- |
\n| \ud83d\udd10 **Per-Mod Configuration** | Individually set mod allowance to Required, Allowed, or Blacklisted |
\n| \ud83d\udeab **Customizable Enforcement** | Configurable kick messages and auto-ban capabilities |
\n| \ud83d\udcca **Player History Database** | Store and query player mod histories |
\n| \ud83d\udc40 **Player Mod Viewing** | Administrators can see other players’ mod lists |
\n| \u2714\ufe0f **Integrity Verification** | Cryptographic signatures prevent spoofed mod reports |
\n| **\ud83d\udd10 Custom Actions** | Allows to setup custom events (commands) for triggered mods |<\/p>\n
—<\/p>\n
## \ud83c\udfd7\ufe0f Platform Comparison<\/p>\n
\u2705 Supported\/Working
\n\u26a0\ufe0f Issues\/Unsupported
\n\u274c Unsupported\/Broken<\/p>\n
| Features | Paper (1.x – 6.x) | Fabric (2.x – 6.x) | NeoForge (6.x+) |
\n| ————————– |:—————————-:|:———————–:|:—————:|
\n| **Integrity Checking** | \u2705 6.x+
\u26a0\ufe0f 3.x – 5.x
| \u2705 6.x+
\u26a0\ufe0f 3.x – 5.x | \u2705\u00a06.0.0+ |
\n| **Configurable Rules** | \u2705\u00a06.0.0+ | \u2705\u00a06.0.0+ | \u2705\u00a06.0.0+ |
\n| **Database Storage** | \u2705\u00a05.0.0+ | \u2705 5.0.0+ | \u2705 6.0.0+ |
\n| **GeyserMC\/Floodgate** | \u2705 5.2.0+ | \u2705 5.2.0+ | \u274c |
\n| **Permissions** | \u2705\u00a05.0.0+ | \u2705 5.0.0+ | \u274c |
\n| **Folia Compatibility** | \u2705 6.0.0+ | \u274c | \u274c |
\n| **Clickable text in chat** | \u2705 | \u274c | \u274c |<\/p>\n
—<\/p>\n
## \ud83d\ude80 Quick Start<\/p>\n
## Commands<\/p>\n
### Installation<\/p>\n
1. **Download** the appropriate mod\/plugin for your platform:<\/p>\n
– **Fabric Client**: Place JAR in `mods\/` folder
\n – **Paper Server**: Place JAR in `plugins\/` folder
\n – **NeoForge Client**: Place JAR in `mods\/` folder<\/p>\n
2. **Configure** the mod\/plugin<\/p>\n
### Basic Configuration<\/p>\n
“`yaml
\nconfig: v4<\/p>\n
# Behavior: “strict” – Force requires client-side mod or “vanilla” allow also non-mod clients
\nbehavior: strict<\/p>\n
# Integrity Mode: “signed” or “dev” – allow unsigned mods (if you are building own client\/server fork)
\nintegrity-mode: signed<\/p>\n
# Whitelist mode: true = only allowed mods (inside whitelisted.yml), false = allowed by default.
\n# To work properly set “mods-whitelisted-enabled” must be true
\nwhitelist: false<\/p>\n
# Allow Bedrock players
\nallow-bedrock-players: false<\/p>\n
# Player Database: Store and track player mod history (requires playerdb to be enabled)
\nplayerdb-enabled: false<\/p>\n
# Mod List Toggles: Enable\/disable each mod list without losing configuration
\nmods-required-enabled: true
\nmods-blacklisted-enabled: true
\nmods-whitelisted-enabled: true<\/p>\n
# Kick Messages – customize as needed (use {mod} for mod name)
\nmessages:
\n kick: “You are using a blacklisted mod: {mod}. Please remove it to join this server.”
\n no-handshake: “To connect to this server please download ‘Hand-shaker’ mod.”
\n missing-whitelist: “You are missing required mods: {mod}. Please install them to join this server.”
\n invalid-signature: “Invalid client signature. Please use the official HandShaker client mod.”<\/p>\n
ban: “You have been banned for using a blacklisted mod: {mod}.”
\n bedrock: “Bedrock players are not allowed on this server.”
\n # custom messages for actions can be added here
\n # placeholders are {mod} – mod which triggered, {player}
\n test_action: “Hi, {player}! You are using {mod}! Thanks for using it!”<\/p>\n
“`<\/p>\n
“`yaml
\nactions:
\n# System actions (Uses hardcoded functions, not recomended to copy these)
\n kick:
\n commands:
\n – “kick {player} {messages.kick}”<\/p>\n
ban:
\n commands:
\n – “ban {player} {messages.ban}”
\n log: true<\/p>\n
log:
\n missing: “{player} tried to join but missing required mod\/mods: {mod}”
\n blacklisted: “{player} tried to join with blacklisted mod\/mods: {mod}”<\/p>\n
# Examples of custom actions
\n# placeholders are {mod} – mod which triggered, {player}, {messages.name_from_config.yml}<\/p>\n
test_action:
\n commands:
\n – “msg {player} {messages.test_action}”
\n – “give {player} minecraft:diamond 1”
\n – “say Say Hello to {player}, who is using {mod}!”<\/p>\n
watchdog:
\n commands:
\n – “ac increase_alert_level {player} 1000”<\/p>\n
“`<\/p>\n
—<\/p>\n
## \ud83d\udcdd Permissions<\/p>\n
| Permission | Description | Default |
\n| ——————- | ———————— | ——– |
\n| `handshaker.admin` | Access to admin commands | Operator |
\n| `handshaker.bypass` | Bypass mod restrictions | False |<\/p>\n
—<\/p>\n
## \ud83c\udfae Supported Versions<\/p>\n
| Loader | Versions | Status | Versions | Status |
\n| ———— | ———————– | ———– | ——– | ——- |
\n| **Fabric** | 1.21 – 1.21.10, 1.21.11 | \u2705 Supported | N\/A | N\/A |
\n| **Paper** | 1.21+ | \u2705 Supported | N\/A | N\/A |
\n| **NeoForge** | 1.21 – 1.21.10, 1.21.11 | \u2705 Supported | 1.20.1 | Planned |<\/p>\n
—<\/p>\n
## \ud83d\udcda Documentation<\/p>\n
* \ud83d\udcd6 **Full Wiki**
\n* \u2b07\ufe0f **Installation Guide**
\n* \u2699\ufe0f **Configuration Guide**
\n* \ud83d\udcac **Commands Reference**
\n* \ud83d\udd28 **Building from Source**
\n* \ud83d\udccb **Changelog**<\/p>\n
—<\/p>\n
## Roadmap<\/p>\n
– More QoL features<\/p>\n
—<\/p>\n
## \ud83e\udd1d Contributing<\/p>\n
Issues, pull requests, and suggestions are welcome! Check the GitHub repository for contribution guidelines.<\/p>\n","protected":false},"excerpt":{"rendered":"
Solution for server owners or modpack developers to disconnect users with unwanted mods, allow or require mods<\/p>\n","protected":false},"featured_media":79007,"template":"","meta":{"_minecraft_slug":"hand-shaker","_minecraft_project_id":"pdGDkQiy","_minecraft_author":"Suskese","_minecraft_license":"MIT","_minecraft_downloads":16766,"_minecraft_follows":35,"_minecraft_client_side":"required","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"hand-shaker.zip","_minecraft_size_bytes":262702242,"_minecraft_version_count":56,"_minecraft_updated_at":"2026-05-15T19:18:13.740889Z","_minecraft_date_created":"2025-09-08T19:38:14.441945Z","_minecraft_date_modified":"2026-03-30T23:24:05.035405Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/hand-shaker","_minecraft_icon_attachment_id":79007,"_minecraft_imported_at":"2026-06-04T13:21:04+00:00","_minecraft_import_hash":"7c030ec05c1e505f8e907b68307db3a6","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,125,126,158,127,128,92],"mod_loader":[99,131,160,132,133],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82,83,167,163],"class_list":["post-79006","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-folia","mod_category-management","mod_category-neoforge","mod_category-paper","mod_category-purpur","mod_category-utility","mod_loader-fabric","mod_loader-folia","mod_loader-neoforge","mod_loader-paper","mod_loader-purpur","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9","minecraft_version-26-1","minecraft_version-26-1-1","minecraft_version-26-1-2"],"yoast_head":"\n