Configuração
Referência do config.yml #
| Chave | Padrão | Significado |
|---|---|---|
language | en | Idioma de todas as mensagens e das explicações dos achados: en, tr, es, de, fr ou ru. As explicações dos achados usam o mesmo idioma; os códigos e as gravidades permanecem em inglês. |
auto-scan-on-startup | true | Executa uma análise completa automaticamente alguns segundos depois que o servidor termina de iniciar. |
auto-scan-delay-seconds | 5 | Quanto tempo esperar após a inicialização antes de a análise automática ser executada. |
report.save-to-file | true | Salva o relatório completo de cada análise em plugins/PluginGuard/reports/. |
report.default-format | txt | Formato usado para o arquivo de relatório salvo automaticamente: txt, json, yaml, md ou html. |
report.keep-last | 30 | Número de relatórios salvos a manter em plugins/PluginGuard/reports/; os mais antigos são excluídos. 0 mantém todos. |
discord-webhook-url | (vazio) | Se definido, o PluginGuard publica uma mensagem curta neste webhook do Discord quando uma análise encontra problemas CRITICAL. Vazio = desativado; nada é enviado a menos que você mesmo defina isto. |
show-optional-dependencies | false | As listas do chat e do console omitem as notas sobre dependências opcionais ausentes (MISSING_SOFT_DEPENDENCY), que são normais em quase todos os servidores; uma linha informa quantas foram omitidas. O relatório salvo e o /pluginguard export sempre as incluem. true = listá-las em todo lugar. |
discord-only-new-findings | true | Anuncia apenas os achados críticos que não foram anunciados antes (lembrados em discord-state.txt). false = anuncia em toda análise que tenha achados críticos. |
integrations.plugin-updates.enabled | false | Procura versões mais novas dos seus plugins (UPDATE_AVAILABLE, nível info). Veja "Verificação de atualizações" abaixo para saber o que cada fonte pode ou não reconhecer. |
integrations.plugin-updates.modrinth | true | Com a verificação de atualizações ativada: identifica os plugins no Modrinth pelo hash do arquivo. Envia a api.modrinth.com, a cada análise, o hash SHA-1 de cada jar de plugin e a sua versão do Minecraft - nada além disso. |
integrations.plugin-updates.spigotmc | true | Com a verificação de atualizações ativada: procura os plugins que indicam a página deles no spigotmc.org como website no plugin.yml (por meio do espelho público Spiget). Apenas o número do recurso é enviado. |
integrations.plugin-updates.builtbybit-api-token | (vazio) | Seu próprio token de API "Shared" do BuiltByBit. Com ele, os plugins que indicam a página deles no builtbybit.com no plugin.yml também são verificados. Vazio = o BuiltByBit é ignorado. |
ignore | [] | Uma lista de regras "CODE:PluginName" (ou "CODE:*" / "*:PluginName") para silenciar permanentemente achados específicos que você revisou e aceita. |
checks.* | todos true | Desativa uma categoria inteira de verificação se ela não se aplicar à sua configuração: java-version, api-version, dependencies, shaded-library-collision, native-library-duplicate, sqlite-jni-relocation, command-collision, bundled-server-api, loaded-state. |
integrations.update-checker.* | desativado | Notificação opcional de atualização do BuiltByBit; precisa do seu próprio token de API "Shared", nunca de um Private. |
Verificação de atualizações #
Ative com integrations.plugin-updates.enabled: true. Cada análise passa então a terminar com uma linha informando quantos dos seus jars de plugins puderam ser correspondidos, e cada plugin desatualizado recebe um achado UPDATE_AVAILABLE com um link.
O que pode ser correspondido e o que não pode:
- Modrinth: correspondência exata pelo hash do arquivo. Qualquer plugin (e arquivo exato) publicado no Modrinth é reconhecido.
- SpigotMC e BuiltByBit: não há como identificar um jar pelo arquivo, e o PluginGuard nunca adivinha plugins pelo nome (um palpite errado informaria uma "atualização" para outro plugin). Um plugin só é verificado quando o próprio
plugin.ymldele contém um linkwebsite:para a página dele no spigotmc.org ou no builtbybit.com. Os plugins que não informam um - muitos não informam - ficam sem verificação, assim como os plugins que não estão publicados em nenhum desses sites (por exemplo, os vendidos em outro lugar). - Os números de versão são comparados como números (1.9 é mais antigo que 1.10). Versões que não podem ser lidas como números nunca são informadas.
- Esses sites não informam quais versões do Minecraft uma atualização suporta, então leia a página do plugin antes de atualizar.
- As respostas do SpigotMC e do BuiltByBit ficam em cache por algumas horas; uma análise faz no máximo 40 dessas requisições e desiste depois de cerca de 25 segundos. Os jars dos plugins nunca são enviados a lugar nenhum.
Idiomas #
Achados, mensagens de comandos e relatórios exportados usam o language do config.yml (en, tr, es, de, fr, ru). Os códigos dos achados (por exemplo SQLITE_JNI_RELOCATED) e as gravidades permanecem sempre em inglês, para que as regras de ignorar, os pedidos de suporte e os resultados de busca tenham a mesma aparência em todos os servidores. Cada achado diz o que está errado, quando isso importa e o que fazer a respeito. Você pode editar os textos em plugins/PluginGuard/lang/; um texto que esteja ausente no seu arquivo é tomado da cópia que está dentro do jar.