MCGuard - Documentación

Alcance y Finalidad de MCGuard

MCGuard es una solución integral de seguridad de "lado del servidor" diseñada para garantizar la integridad técnica de las comunidades de Minecraft. Su objetivo principal es mitigar el uso de modificaciones no autorizadas y asegurar que todos los jugadores compitan en igualdad de condiciones.

A diferencia de otros sistemas, MCGuard Server valida activamente la lista de mods y recursos dinámicos, permitiendo a los administradores definir exactamente qué software está permitido en su ecosistema.

Capacidades del Sistema

• Modloader: Compatible con Forge 47.x para Minecraft 1.20.1. El parámetro useModLoader controla si es obligatorio.
• Listas de Control (White/Blacklist): Gestión granular del JAR/Mod ID permitido para conectar al servidor.
• Gestión de Resource Packs: Control de paquetes de recursos para evitar "X-Rays" basados en texturas.
• Acciones Automáticas: Kick o Ban configurable tras la detección de inconsistencias.

Instalación de MCGuard Server

Sigue estos pasos para robustecer tu servidor con la protección de MCGuard.

Paso 1: Preparación del Servidor

Asegúrate de que tu servidor esté usando Minecraft 1.20.1 con Forge 47.x. MCGuard Server actualmente soporta únicamente Forge para esta versión.

Paso 2: Instalación del JAR

Copia el archivo mcguardserver.jar descargado en la carpeta de mods de tu servidor físico o hosting.

mi-servidor/
├── mods/
│   ├── MCGuardServer-1.2.1.jar  ← Instalación aquí
│   └── (otros mods...)
├── config/
└── server.properties

Paso 3: Primer Inicio

Arranca el servidor para que MCGuard genere los archivos de configuración por defecto en config/mcguard/.

Parámetros de Configuración

El archivo principal se encuentra en config/mcguard/validation_config.json. A continuación se detallan las opciones clave:

{
  "mcguardEnabled": true,
  "strictMode": false,
  "useModLoader": false,
  "whitelistedMods": ["minecraft", "forge", "mcguardserver"],
  "ignoreOptionalMods": ["jei", "journeymap"],
  "whitelistedResourcePacks": [],
  "ignoreOptionalResourcePacks": [],
  "monitorResourcePackChanges": true,
  "disconnectOnResourcePackChange": true,
  "maxModsAllowed": 500,
  "maxResourcePacksAllowed": 50,
  "logging": {
    "enableFileLogging": true,
    "enableConsoleLogging": true,
    "logPath": "logs/mcguard/",
    "webhook": {
      "enabled": false,
      "languageFile": "es_ES.json"
    }
  },
  "actions": {
    "kickOnInvalid": true,
    "kickMessage": "§c§lMods no autorizados§r§c. Contacta a los admins.",
    "banOnMultipleViolations": false,
    "violationsBeforeBan": 3
  }
}

Modelo de Datos (Clase Mod)

La clase Mod es el modelo del panel de control (frontend). Almacena la información completa de cada mod para la interfaz. El servidor valida únicamente el id del mod (string en minúscula) contra la whitelistedMods de la configuración.

Atributos de la Clase

Estructura de Inicialización

Al crear una instancia de Mod, se espera un objeto con el siguiente esquema:

{
  id: "ironchest",
  name: "ironchest",
  title: "Iron Chests",
  filename: "ironchest-1.20.1-14.4.4.jar",
  version: "14.4.4",
  description: "Amplía los cofres con nuevos materiales.",
  required: true,
  category: "storage",
  author: "ProgWML6",
  hash: "a1b2c3d4e5f6...",
  size: "2.4 MB",
  downloadUrl: "https://example.com/mod.jar",
  download: ""
}

MCGuard permite integrar webhooks de Discord para monitorear eventos críticos en tiempo real. Esta funcionalidad es asíncrona y no afecta el rendimiento del servidor.

Configuración en validation_config.json

Añade el siguiente bloque dentro de la sección logging:

"webhook": {
  "enabled": true,
  "languageFile": "es_ES.json",
  "onPlayerKick": "https://discord.com/api/webhooks/...",
  "onPlayerJoin": "https://discord.com/api/webhooks/...",
  "onMissingMods": "https://discord.com/api/webhooks/...",
  "onExtraMods": "https://discord.com/api/webhooks/...",
  "onResourcePackChange": "https://discord.com/api/webhooks/...",
  "onValidationTimeout": "https://discord.com/api/webhooks/...",
  "onSecurityTampering": "https://discord.com/api/webhooks/...",
  "onCreate": "https://discord.com/api/webhooks/...",
  "includePlayerUUID": true,
  "includeMods": true,
  "includeResourcePacks": true,
  "useEmbed": true,
  "colorKick": "DC354D",
  "colorJoin": "28A745",
  "colorViolation": "FFC107",
  "colorWarning": "FF6C00"
}

Eventos Disponibles