Configuración

Referencia de config.yml #

ClaveValor por defectoSignificado
languageenIdioma de todos los mensajes y de las explicaciones de los hallazgos: en, tr, es, de, fr o ru. Las explicaciones de los hallazgos usan el mismo idioma; los códigos y las gravedades siguen en inglés.
auto-scan-on-startuptrueEjecuta un análisis completo automáticamente unos segundos después de que el servidor termine de arrancar.
auto-scan-delay-seconds5Cuánto esperar tras el arranque antes de que se ejecute el análisis automático.
report.save-to-filetrueGuarda el informe completo de cada análisis en plugins/PluginGuard/reports/.
report.default-formattxtFormato del archivo de informe guardado automáticamente: txt, json, yaml, md o html.
report.keep-last30Número de informes guardados que se conservan en plugins/PluginGuard/reports/; los más antiguos se eliminan. 0 conserva todos.
discord-webhook-url(vacío)Si se define, PluginGuard publica un mensaje breve en este webhook de Discord cuando un análisis encuentra problemas CRITICAL. Vacío = desactivado; nunca se envía nada a menos que lo definas tú mismo.
show-optional-dependenciesfalseLas listas del chat y de la consola omiten las notas sobre dependencias opcionales ausentes (MISSING_SOFT_DEPENDENCY), que son normales en casi todos los servidores; una línea indica cuántas se omitieron. El informe guardado y /pluginguard export siempre las incluyen. true = las lista en todas partes.
discord-only-new-findingstrueAnuncia solo los hallazgos críticos que no se habían anunciado antes (se recuerdan en discord-state.txt). false = anuncia en cada análisis que tenga hallazgos críticos.
integrations.plugin-updates.enabledfalseBusca versiones más nuevas de tus plugins (UPDATE_AVAILABLE, nivel informativo). Consulta «Comprobación de actualizaciones» más abajo para saber qué puede y qué no puede reconocer cada fuente.
integrations.plugin-updates.modrinthtrueCon la comprobación de actualizaciones activada: identifica los plugins en Modrinth por el hash del archivo. En cada análisis envía a api.modrinth.com el hash SHA-1 de cada jar de plugin y tu versión de Minecraft, y nada más.
integrations.plugin-updates.spigotmctrueCon la comprobación de actualizaciones activada: busca los plugins que indican su página de spigotmc.org como website en plugin.yml (a través del espejo público de Spiget). Solo se envía el número del recurso.
integrations.plugin-updates.builtbybit-api-token(vacío)Tu propio token de API «Shared» de BuiltByBit. Con él también se comprueban los plugins que enlazan su página de builtbybit.com en plugin.yml. Vacío = se omite BuiltByBit.
ignore[]Una lista de reglas "CODE:PluginName" (o "CODE:*" / "*:PluginName") para silenciar de forma permanente hallazgos concretos que has revisado y con los que estás conforme.
checks.*todos trueDesactiva una categoría entera de comprobación si no se aplica a tu configuración: java-version, api-version, dependencies, shaded-library-collision, native-library-duplicate, sqlite-jni-relocation, command-collision, bundled-server-api, loaded-state.
integrations.update-checker.*desactivadoNotificación opcional de actualizaciones de BuiltByBit; necesita tu propio token de API «Shared», nunca uno Private.

Comprobación de actualizaciones #

Actívala con integrations.plugin-updates.enabled: true. Cada análisis termina entonces con una línea que indica cuántos de tus jar de plugins pudieron emparejarse, y cada plugin desactualizado recibe un hallazgo UPDATE_AVAILABLE con un enlace.

Qué se puede emparejar y qué no:

  • Modrinth: coincidencia exacta por hash del archivo. Se reconoce cualquier plugin (y archivo exacto) publicado en Modrinth.
  • SpigotMC y BuiltByBit: no hay forma de identificar un jar por su archivo, y PluginGuard nunca adivina plugins por su nombre (una suposición errónea informaría de una «actualización» de otro plugin). Un plugin solo se comprueba cuando su propio plugin.yml contiene un enlace website: a su página de spigotmc.org o builtbybit.com. Los plugins que no incluyen ninguno (muchos no lo hacen) quedan sin comprobar, igual que los que no están publicados en ninguno de estos sitios (por ejemplo, los que se venden en otro lugar).
  • Los números de versión se comparan como números (1.9 es anterior a 1.10). Las versiones que no pueden leerse como números nunca se notifican.
  • Estos sitios no indican qué versiones de Minecraft admite una actualización, así que lee la página del plugin antes de actualizar.
  • Las respuestas de SpigotMC y BuiltByBit se almacenan en caché unas horas; un análisis hace como máximo 40 solicitudes de este tipo y se rinde tras unos 25 segundos. Los jar de los plugins nunca se suben a ningún sitio.

Idiomas #

Los hallazgos, los mensajes de los comandos y los informes exportados usan el language de config.yml (en, tr, es, de, fr, ru). Los códigos de los hallazgos (por ejemplo SQLITE_JNI_RELOCATED) y las gravedades siempre siguen en inglés para que las reglas de ignorar, las solicitudes de soporte y los resultados de búsqueda se vean igual en todos los servidores. Cada hallazgo explica qué falla, cuándo importa y qué hacer al respecto. Puedes editar los textos en plugins/PluginGuard/lang/; un texto que falte en tu archivo se toma de la copia que hay dentro del jar.