Configuração

O plugin deve funcionar sem necessidade de configuração adicional, mas se você precisar alterar o comportamento do plugin, você está no lugar certo.

Estrutura de arquivos

Abaixo está um exemplo de como é a estrutura de arquivos do plugin. Clique em uma pasta para expandi-la.

Configuração do plugin (config.yml)

O arquivo config.yml controla todo o comportamento do sistema de limpeza de plots. Abaixo estão todas as opções disponíveis com explicações detalhadas.

debug-mode

Ativa ou desativa o modo de depuração. Quando ativado, o plugin registrará informações detalhadas no console para ajudar a identificar problemas.

# Determina o funcionamento da depuração. Valores válidos: [false, true]
debug-mode: false

database

Define como e onde os dados do plugin serão armazenados. O plugin suporta três tipos de armazenamento:

• SQLITE: Armazena dados em um arquivo local. Ideal para servidores pequenos.
• MYSQL: Conecta a um servidor MySQL externo. Recomendado para servidores médios.
• HIKARI: Usa pool de conexões para MySQL. Recomendado para servidores grandes por melhor performance.

database:
  # Determina o tipo de banco de dados. Valores válidos: [SQLITE, MYSQL, HIKARI (recomendado)]
  storage-type: SQLITE

  # Dados para conexão ao banco de dados MYSQL.
  data:
    # Endereço de conexão do banco de dados. [EX: 127.0.0.1]
    host: localhost
    # Porta de conexão do banco de dados. [EX: 3306]
    port: 3306
    # Nome do banco de dados a ser conectado. [EX: minecraft]
    database: ''
    # Usuário de conexão. [EX: root]
    username: ''
    # Senha do usuário de conexão: [EX: 123]
    password: ''

limit

Define o limite de limpezas simultâneas que podem ocorrer no servidor. Este é um dos parâmetros mais importantes para a performance do servidor.

# Limite de limpezas por vez
# Ideal para não lagar seu servidor
limit: 10

Como funciona:

• Quando o limite é atingido, novos jogadores que tentarem limpar plots receberão uma mensagem de espera
• Assim que uma limpeza termina, libera espaço para uma nova começar
• Quanto maior o limite, maior o impacto na performance do servidor

Recomendações por tipo de servidor:

• Servidor pequeno (até 50 jogadores): limit: 5
• Servidor médio (50-200 jogadores): limit: 10
• Servidor grande (200+ jogadores): limit: 15-20

general

Configurações gerais do comportamento do limpador.

general:
  # Precisar de shift para ativar o limpador
  need-shift: true
  # Abrir o menu de confirmação
  open-menu: true
  # Utilizar o WorldEdit
  worldedit: false
  # Limpar de forma instantânea
  # Pode gerar LAG
  instant: false
  # Blocos removidos por tick no modo gradual
  blocks-per-tick: 42
  # Ativar para apenas o dono da plot conseguir limpar
  just-owner: true
  # Mundos que não será possível usar o limpador
  world-blacklist: []
  # Blocos que não serão limpos
  block-blacklist: [ 'BEDROCK:0' ]
  # Blocos que SERÃO limpos
  # Deixe [] para não usar
  block-whitelist: []
  # Comandos bloqueados para o jogador que está limpando a plot
  command-blacklist:
    - '/p'
    - '/plot'

need-shift

Define se o jogador precisa usar Shift + Botão Direito para ativar o limpador, adicionando uma camada extra de confirmação.

need-shift: true

• true - Requer Shift + Botão Direito (recomendado para evitar ativações acidentais)
• false - Apenas Botão Direito ativa o limpador

open-menu

Define se o menu de confirmação será exibido antes de iniciar a limpeza.

open-menu: true

• true - Abre menu com botões de confirmar/cancelar
• false - Inicia a limpeza imediatamente (não recomendado)

worldedit

Define se o plugin utilizará WorldEdit para realizar a limpeza. O WorldEdit tende a ser mais rápido, mas requer o plugin instalado.

worldedit: false

• true - Usa WorldEdit (requer WorldEdit instalado)
• false - Usa sistema nativo do plugin

Quando usar WorldEdit:

• Plots muito grandes (acima de 200x200)
• Servidor com WorldEdit já otimizado
• Performance é prioridade máxima

Quando NÃO usar:

• WorldEdit não está instalado
• Plots pequenos/médios
• Preferência por sistema nativo

instant

Define se a limpeza será instantânea (todos os blocos removidos de uma vez) ou gradual.

instant: false

• true - Remove todos os blocos instantaneamente
• false - Remove blocos gradualmente (recomendado)

blocks-per-tick

Define quantos blocos são removidos por tick quando a limpeza gradual está ativa (instant: false). Valores maiores aceleram a limpeza mas podem gerar mais lag.

blocks-per-tick: 42

• Valores menores (ex: 10–20) — limpeza mais suave, menos impacto no servidor
• Valores maiores (ex: 50–100) — limpeza mais rápida, maior uso de CPU por tick

just-owner

Define se apenas o dono do plot pode usar o limpador.

just-owner: true

• true - Apenas o dono pode limpar (recomendado)
• false - Membros com permissão no plot também podem limpar

world-blacklist

Lista de mundos onde o limpador está completamente desabilitado.

world-blacklist: []

Exemplo de uso:

world-blacklist: 
  - 'spawn'
  - 'lobby'
  - 'minigames'

Útil para desabilitar o limpador em mundos onde não há plots ou onde a limpeza não faz sentido.

block-blacklist

Lista de blocos que não serão removidos durante a limpeza. Útil para preservar blocos específicos.

block-blacklist: ['BEDROCK:0']

Formato: MATERIAL:DATA (o data value é opcional)

Exemplo de uso:

block-blacklist: 
  - 'BEDROCK:0'        # Preserva bedrock
  - 'BARRIER:0'        # Preserva barreiras
  - 'DIAMOND_BLOCK:0'  # Preserva blocos de diamante
  - 'CHEST:0'          # Preserva baús

Casos de uso comuns:

• Preservar blocos de estrutura (bedrock, barrier)
• Preservar blocos valiosos marcados
• Preservar containers importantes (baús, fornalhas)

command-blacklist

Lista de comandos que ficam bloqueados enquanto o jogador está limpando seu plot, prevenindo exploits ou conflitos.

command-blacklist:
  - '/p'
  - '/plot'

Exemplo expandido:

command-blacklist:
  - '/p'
  - '/plot'
  - '/tp'
  - '/warp'
  - '/spawn'
  - '/home'

Por que bloquear comandos:

• Prevenir que o jogador teleporte durante a limpeza
• Evitar conflitos com comandos do PlotSquared
• Garantir que a limpeza complete antes de outras ações

hologram

Configurações do holograma flutuante que aparece durante a limpeza, fornecendo feedback visual do progresso.

hologram:
  enabled: true
  off-set: 2.0
  lines:
    - '&a&lLIMPADOR'
    - '&eRealizando limpeza...'
    - ''
    - '&fBlocos: &a{min}&7/&c{max}'
    - '&8[{progressbar}&8] &7{percentage}'

enabled

Define se o holograma será exibido durante a limpeza.

enabled: true

• true - Exibe holograma com progresso
• false - Sem holograma (apenas actionbar)

off-set

Define a altura do holograma acima do jogador (em blocos).

off-set: 2.0

Recomendações:

• 2.0 - Altura padrão, bem visível
• 3.0 - Mais alto, para ver de longe
• 1.5 - Mais baixo, mais discreto

lines

Define as linhas de texto do holograma. Cada elemento da lista é uma linha separada.

lines:
  - '&a&lLIMPADOR'
  - '&eRealizando limpeza...'
  - ''
  - '&fBlocos: &a{min}&7/&c{max}'
  - '&8[{progressbar}&8] &7{percentage}'

Placeholders disponíveis:

Exemplo personalizado:

lines:
  - '&6&l⚒ LIMPEZA EM ANDAMENTO ⚒'
  - ''
  - '&eProgresso: &f{percentage}'
  - '&7{min} &f/ &7{max} blocos'
  - '{progressbar}'
  - ''
  - '&7Aguarde...'

item

Configurações do item físico que representa o limpador no inventário.

item:
  material: 'DIAMOND_SPADE'
  name: '&aLimpador'
  lore:
    - '&7Use este item no seu plot para'
    - '&7limpá-lo por completo.'
    - ''
    - '&7Clique com botão direito para ativar.'

material

Define o tipo do item limpador.

material: 'DIAMOND_SPADE'

Materiais sugeridos:

• DIAMOND_SPADE - Pá de diamante (padrão, temático)
• GOLDEN_SHOVEL - Pá dourada (dourado chama atenção)
• BLAZE_ROD - Vara de blaze (varinha mágica)
• NETHER_STAR - Estrela do nether (item raro/especial)

name

Define o nome de exibição do item.

name: '&aLimpador'

Exemplos:

name: '&6&l⚒ &eLimpador de Plot &6&l⚒'
name: '&b&lLimpador Mágico'
name: '&aLimpador de Terreno'

lore

Define as linhas de descrição do item (lore).

lore:
  - '&7Use este item no seu plot para'
  - '&7limpá-lo por completo.'
  - ''
  - '&7Clique com botão direito para ativar.'

Exemplo expandido:

lore:
  - '&7Use este item mágico para limpar'
  - '&7completamente seu plot!'
  - ''
  - '&e▸ &fBotão Direito &7para usar'
  - '&e▸ &fShift + Botão Direito &7para confirmar'
  - ''
  - '&cATENÇÃO: &7Esta ação é irreversível!'

progress-bar

Configurações da barra de progresso visual exibida no holograma e actionbar.

progress-bar:
  amount: 10
  symbol: ':'
  color-yes: '&a'
  color-no: '&7'

amount

Define quantos símbolos a barra de progresso terá.

amount: 10

Exemplos visuais:

• amount: 10 → &a::::::&7:::: (10 símbolos)
• amount: 20 → &a::::::::::::&7:::::::: (20 símbolos, mais preciso)
• amount: 5 → &a:::&7:: (5 símbolos, mais simples)

Recomendações:

• 10 - Balanço perfeito entre precisão e simplicidade
• 20 - Mais preciso, mas pode ficar visualmente poluído
• 5 - Mais limpo, mas menos preciso

symbol

Define o caractere usado para representar cada unidade da barra.

symbol: ':'

Opções de símbolos:

symbol: ':'   # Resultado: ::::::::
symbol: '|'   # Resultado: ||||||||
symbol: '█'   # Resultado: ████████
symbol: '▌'   # Resultado: ▌▌▌▌▌▌▌▌
symbol: '■'   # Resultado: ■■■■■■■■
symbol: '●'   # Resultado: ●●●●●●●●

color-yes

Define a cor dos símbolos que representam o progresso completo (parte preenchida).

color-yes: '&a'

Cores sugeridas:

• &a - Verde (padrão, sucesso)
• &2 - Verde escuro
• &e - Amarelo (neutro)
• &6 - Dourado (destaque)
• &b - Aqua (moderno)

color-no

Define a cor dos símbolos que representam o progresso pendente (parte vazia).

color-no: '&7'

Cores sugeridas:

• &7 - Cinza (padrão, discreto)
• &8 - Cinza escuro (mais sutil)
• &f - Branco (contraste claro)
• &c - Vermelho (pendente/atenção)

Exemplo visual completo:

Com amount: 10, symbol: '|', color-yes: '&a', color-no: '&7' a 60% de progresso:

&a||||||&7||||  (6 verdes, 4 cinzas)