ModSync

Etapa de Desarrollo Temprano – Este plugin se encuentra en una etapa de desarrollo muy temprana. Úsalo bajo tu propio riesgo. El desarrollo está en curso – ¡por favor, sé amable con los comentarios y los informes de errores!

Un plugin de gestión de mods del lado del servidor para Hytale que te permite agregar, instalar, actualizar y eliminar mods fácilmente desde comandos dentro del juego.

Características

• Agregar mods a través de URL – Simplemente pega una URL de mod de CurseForge para agregarlo a la lista de mods de tu servidor
• Instalación fácil – Instala todos los mods gestionados con un solo comando
• Verificación de actualizaciones – Verifica si hay actualizaciones disponibles con una visualización de comparación de versiones
• Actualizaciones con un clic – Actualiza los mods a sus últimas versiones
• Eliminación flexible – Elimina mods por nombre, slug o identificador del plugin
• Seguimiento persistente – Tu lista de mods se guarda y persiste a través de reinicios del servidor
• Manejo inteligente de archivos – Los archivos bloqueados se ponen automáticamente en cola para eliminación en el próximo reinicio del servidor
• Rutas configurables – La ruta de la carpeta de plugins tempranos es configurable

Comandos

Todos los comandos utilizan el prefijo /modsync:

Comando
Descripción

/modsync add [url]
Agregar un mod desde una URL de CurseForge

/modsync list
Mostrar todos los mods gestionados con estado de instalación, versión e identificador

/modsync install
Instalar todos los mods de tu lista

/modsync install [name]
Instalar un mod específico por nombre, slug o identificador

/modsync remove all
Eliminar todos los mods

/modsync remove [name]
Eliminar un mod por nombre, slug o identificador

/modsync check
Verificar si hay actualizaciones disponibles (muestra versión instalada vs. última versión)

/modsync upgrade
Actualizar todos los mods instalados a la última versión

/modsync upgrade [name]
Actualizar un mod específico por nombre, slug o identificador

/modsync setkey [key]
Establecer tu clave API de CurseForge

/modsync status
Mostrar la configuración actual

/modsync reload
Recargar la configuración

Consejo: Usa comillas para nombres con espacios: /modsync install "Mi Mod"

Ejemplos

# Agregando mods regulares
/modsync add https://www.curseforge.com/hytale/mods/example

# Agregando plugins bootstrap/tempranos
/modsync add https://www.curseforge.com/hytale/bootstrap/example

# Gestionando mods
/modsync install
/modsync install simply-trash
/modsync install BlameJared:SimplyTrash
/modsync check
/modsync upgrade
/modsync upgrade BlameJared:SimplyTrash
/modsync remove BlameJared:SimplyTrash
/modsync remove all

Configuración

Instala el plugin en tu servidor de Hytale

(Opcional pero recomendado) Instala el plugin bootstrap en la carpeta earlyplugins (incluido como dependencia en curseforge), especialmente si obtienes errores de eliminación.

• El servidor debe iniciarse con los flags --early-plugins y --accept-early-plugins

Obtén una clave API de CurseForge de CurseForge para Estudios

Establece tu clave API: /modsync setkey TU_CLAVE_API

Comienza a agregar mods: /modsync add https://www.curseforge.com/hytale/mods/your-mod

Requisitos

• Servidor de Hytale (línea de parche de lanzamiento)
• El servidor debe iniciarse con los flags --early-plugins y --accept-early-plugins
• Clave API de CurseForge
• Plugin bootstrap para una correcta eliminación de archivos

Cómo Funciona

Instalando Mods

Cuando instalas un mod, el plugin:

Descarga el archivo JAR de CurseForge

Detecta el tipo de plugin (plugin regular o plugin temprano) de la categoría de CurseForge

Lo guarda en la carpeta apropiada:

• Plugins regulares → mods/
• Plugins tempranos/bootstrap → earlyplugins/ (configurable)

Registra el mod en el registro de mods instalados

Nota: Se requiere un reinicio del servidor para cargar los mods recién instalados.

Plugins Bootstrap/Tempranos

ModSync detecta automáticamente los Plugins Bootstrap/Tempranos de CurseForge y los instala en la carpeta correcta. Cuando agregas un mod:

• URLs como https://www.curseforge.com/hytale/mods/... son plugins regulares
• URLs como https://www.curseforge.com/hytale/bootstrap/... son plugins tempranos

El tipo de plugin se muestra en los comandos con [Plugin] o [Early Plugin].

Eliminando Mods

Cuando eliminas un mod, el plugin:

Descarga el mod si está actualmente cargado

Intenta eliminar el archivo JAR

Si el archivo está bloqueado (Windows), lo pone en cola para eliminación en el próximo reinicio

El plugin bootstrap maneja las eliminaciones en cola antes de que el servidor cargue los mods

Nota: Si un archivo está bloqueado, verás un mensaje indicando que se requiere un reinicio.

Verificando Actualizaciones

El comando /modsync check muestra:

• Qué mods tienen actualizaciones disponibles
• Versión instalada actual vs. última versión disponible
• Ejemplo de salida: Simply Trash: Simply-Trash-0.0.1.jar -> Simply-Trash-0.0.2.jar

Actualizando Mods

El comando /modsync upgrade:

Verifica cada mod si hay actualizaciones disponibles

Descarga e instala la nueva versión

Pone la versión antigua en cola para eliminación

Nota: Se requiere un reinicio del servidor para cargar los mods actualizados.

Notas Importantes

• Ajuste de Distribución de Mods: Los mods solo pueden ser descargados si el autor del mod ha habilitado “Permitir Distribución de Mods” en la configuración de su proyecto de CurseForge. Si un mod no permite la distribución por API, se omitirá durante la instalación.
• Reinicio del Servidor: Instalar, actualizar o eliminar mods requiere un reinicio del servidor para que tenga efecto.
• Sin Reinicio Automático: Actualmente, no hay forma de activar un reinicio del servidor a través de la API de Mods. Después de instalar, actualizar o eliminar mods, debes reiniciar manualmente el servidor.
• Bloqueo de Archivos (Windows): Los archivos JAR están bloqueados mientras están cargados. El plugin bootstrap maneja la eliminación en el reinicio.
• Fuentes Soportadas: Actualmente, CurseForge es la única fuente de mods soportada. La arquitectura del plugin permite que se agreguen fuentes adicionales en el futuro.

Configuración

El archivo config.json en mods/Onyxmoon_ModSync/ contiene:

{
  "apiKeys": {
    "CURSEFORGE": "tu-clave-api"
  },
  "earlyPluginsPath": "earlyplugins"
}

• earlyPluginsPath – Ruta para la carpeta de plugins tempranos (por defecto: earlyplugins). Puede ser absoluta o relativa a la raíz del servidor.

Ubicaciones de Archivos

Todos los datos se almacenan en mods/Onyxmoon_ModSync/:

• config.json – Claves API y configuraciones
• mods.json – Tu lista de mods curada (compartible entre servidores)
• mods.lock.json – Estado de instalación (específico de la máquina, no compartible)
• pending_deletions.json – Archivos en cola para eliminación en el reinicio

Soporte

Reporta problemas en el repositorio de GitHub.