Hand Shaker

⚠️ Этот проект требует установки как на стороне клиента, так и на стороне сервера ⚠️

🤝 HandShaker 7.0.0 (alpha) Вики здесь!

📋 Что такое HandShaker?

HandShaker — это кросс-платформенная система проверки модов/плагинов для серверов и клиентов Minecraft. Она позволяет серверам определять, какие моды используют игроки, и применять ограничения на моды с настраиваемыми правилами.

🎯 Основной функционал

• Клиент Fabric/Neoforge → Отправляет список ваших активных модов на сервер при входе
• Сервер Paper/Fabric/NeoForge → Проверяет списки модов по настроенным правилам и применяет ограничения
• Поддержка нескольких платформ → Работает на Fabric, Paper и NeoForge
• Криптографическая целостность → Предотвращает подделку или самостоятельную сборку модов HandShaker
• Гибкая настройка → Правила для каждого мода: Required, Allowed или Blacklisted

✨ Ключевые особенности

🏗️ Сравнение платформ

✅ Поддерживается/Работает ⚠️ Проблемы/Не поддерживается ❌ Не поддерживается/Сломано

🚀 Быстрый старт

Команды

Установка

1. Скачай подходящий мод/плагин для своей платформы:

   • Fabric Client: Помести JAR в папку mods/
   • Paper Server: Помести JAR в папку plugins/
   • NeoForge Client: Помести JAR в папку mods/
2. Настрой мод/плагин

Базовая настройка

config: v4

# Поведение: "strict" - принудительно требует клиентский мод, или "vanilla" - разрешает также клиентов без мода
behavior: strict

# Режим целостности: "signed" или "dev" - разрешить неподписанные моды (если ты собираешь собственный форк клиента/сервера)
integrity-mode: signed

# Режим белого списка: true = только разрешённые моды (в whitelisted.yml), false = разрешены по умолчанию.
# Для корректной работы "mods-whitelisted-enabled" должен быть true
whitelist: false

# Разрешить игроков Bedrock
allow-bedrock-players: false

# База данных игроков: хранить и отслеживать историю модов игрока (требуется включённый playerdb)
playerdb-enabled: false

# Переключатели списков модов: включай/отключай каждый список модов без потери конфигурации
mods-required-enabled: true
mods-blacklisted-enabled: true
mods-whitelisted-enabled: true

# Сообщения при кике - настраивай по необходимости (используй {mod} для названия мода)
messages:
  kick: "Ты используешь мод из чёрного списка: {mod}. Удали его, чтобы зайти на этот сервер."
  no-handshake: "Чтобы подключиться к этому серверу, скачай мод 'Hand-shaker'."
  missing-whitelist: "У тебя отсутствуют обязательные моды: {mod}. Установи их, чтобы зайти на этот сервер."
  invalid-signature: "Недействительная подпись клиента. Пожалуйста, используй официальный клиентский мод HandShaker."

  ban: "Ты был забанен за использование мода из чёрного списка: {mod}."
  bedrock: "Игроки Bedrock не допускаются на этот сервер."
  # здесь можно добавить свои сообщения для действий
  # плейсхолдеры: {mod} - мод, который сработал, {player}
  test_action: "Привет, {player}! Ты используешь {mod}! Спасибо, что пользуешься им!"

actions:
# Системные действия (используют жёстко заданные функции, не рекомендуется копировать их)
  kick:
    commands:
      - "kick {player} {messages.kick}"

  ban:
    commands:
      - "ban {player} {messages.ban}"
    log: true
    
  log:
    missing: "{player} попытался зайти, но отсутствуют обязательные моды: {mod}"
    blacklisted: "{player} попытался зайти с модами из чёрного списка: {mod}"

# Примеры пользовательских действий
# плейсхолдеры: {mod} - мод, который сработал, {player}, {messages.name_from_config.yml}

  test_action:
    commands:
      - "msg {player} {messages.test_action}"
      - "give {player} minecraft:diamond 1"
      - "say Поприветствуйте {player}, который использует {mod}!"

  watchdog:
    commands:
      - "ac increase_alert_level {player} 1000"

📝 Права

🎮 Поддерживаемые версии

📚 Документация

• 📖 Полная вики
• ⬇️ Руководство по установке
• ⚙️ Руководство по настройке
• 💬 Справочник команд
• 🔨 Сборка из исходников
• 📋 Список изменений

План разработки

• Больше функций QoL

🤝 Участие в разработке

Приветствуются issues, pull requests и предложения! Загляните в репозиторий на GitHub, чтобы ознакомиться с правилами участия.