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.

Após alterar a configuração, é necessário reiniciar o servidor.

Estrutura de arquivos

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

commands.yml

config.yml

economies.yml

menus.yml

messages.yml

Arquivos de configuração

O yMultas possui arquivos separados para cada área do plugin. Use esta página como visão geral e acesse as páginas específicas para conferir o conteúdo completo de cada arquivo.

Arquivo	Função
`config.yml`	Controla banco de dados, Redis, delay de login, regras gerais, bloqueio de comandos, comandos ao pagar multas e sons.
`commands.yml`	Define o comando principal do plugin e seus aliases.
`economies.yml`	Configura a economia padrão e os providers de economia disponíveis.
`menus.yml`	Personaliza títulos, tamanhos, slots, itens e placeholders dos menus.
`messages.yml`	Personaliza mensagens de chat, ajuda, aplicação, pagamento e remoção de multas.

O arquivo plugin.yml também existe nos recursos do plugin, mas ele contém metadados internos do plugin, como main, authors, softdepend e api-version.

Configuração do plugin (config.yml)

O arquivo config.yml é o arquivo principal do yMultas. Nele você controla armazenamento, Redis, carregamento de dados, regras de multas, bloqueios e sons.

debug-mode

Ativa ou desativa o modo de depuração. Quando ativado, o plugin pode registrar informações adicionais para ajudar na correção de problemas.

# Modo de depuração para correção de problemas no plugin.
debug-mode: false

Mantenha desativado em produção, pois pode gerar logs adicionais.

database

Define onde os dados do plugin serão armazenados. O arquivo informa os tipos válidos SQLITE, MYSQL e HIKARI.

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: ''

Se usar SQLITE, os dados de conexão MySQL podem permanecer vazios.

redis

Configura a conexão com Redis. Esta seção permite ativar ou desativar a conexão e informar endereço, porta, usuário e senha.

redis:
  # Ativar a conexão com o redis
  enabled: false
  # Endereço de conexão. [EX: 127.0.0.1]
  host: 'localhost'
  # Porta de conexão. [EX: 3306]
  port: 6379
  # Usuário de conexão. [EX: root]
  username: ''
  # Senha do usuário de conexão: [EX: 123]
  password: ''

Use esta seção quando precisar ativar a conexão Redis do plugin.

Exemplo com Redis ativado:

redis:
  enabled: true
  host: 'localhost'
  port: 6379
  username: ''
  password: ''

Define o delay para carregar os dados depois do login. O próprio arquivo recomenda 20 ticks.

# Delay para carregar os dados depois do login
# Necessário para usar em servidor de mina separado
# Recomendado: 20 ticks
login-delay: 20

general

Controla regras gerais do sistema de multas, como provider padrão, vencimento, juros, bloqueio de comandos e comandos executados ao pagar uma multa.

general:
  # Economia padrão usada ao aplicar multas sem provider explícito.
  default-provider: 'money'
  # Prazo padrão para vencimento de uma multa, em segundos. 0 = sem vencimento.
  default-due-seconds: 604800
  # Juros diários aplicados sobre multas vencidas, em percentual. 0 = sem juros.
  interest:
    # Ativar a aplicação de juros sobre multas vencidas.
    enable: true
    # Valor percentual de juros diários aplicados sobre multas vencidas. 0 = sem juros.
    daily-percent: 5.0
    # Intervalo de checagem de multas vencidas para aplicação de juros, em ticks. 20 ticks = 1 segundo.
    check-interval-ticks: 1200
  # Bloequios relacionados às multas.
  blocks:
    # Quando a multa tá pendente.
    fine-pending:
      # Ativar o bloqueio.
      enable: true
      # Comandos bloqueados para jogadores com multas pendentes.
      commands:
        - '/g'
        - '/trade'
        - '/leilao'
  vault:
    # Comandos executados quando uma multa é paga.
    commands-on-pay: []

Pontos importantes:

default-provider deve corresponder a uma economia configurada em economies.yml.
default-due-seconds: 604800 representa o prazo padrão em segundos configurado no arquivo.
general.blocks.fine-pending.commands define quais comandos serão bloqueados para jogadores com multas pendentes.
Jogadores com a permissão ymultas.bypass ignoram o bloqueio de comandos.

Exemplo sem vencimento de multas:

general:
  default-due-seconds: 0

Exemplo sem juros diários:

general:
  interest:
    enable: false
    daily-percent: 0.0
    check-interval-ticks: 1200

Exemplo alterando comandos bloqueados:

general:
  blocks:
    fine-pending:
      enable: true
      commands:
        - '/g'
        - '/trade'
        - '/leilao'

sounds

Define os sons executados em ações relacionadas às multas.

# Sons personalizados para ações relacionadas às multas.
sounds:
  # Quando aplica a multa.
  fine-applied: 'ENTITY_VILLAGER_NO'
  # Quando o jogador paga a multa.
  fine-paid: 'ENTITY_EXPERIENCE_ORB_PICKUP'
  # Quando o jogador tenta pagar uma multa, mas não tem dinheiro suficiente.
  action-fail: 'ENTITY_VILLAGER_NO'

Arquivos relacionados

commands.yml

Use commands.yml para alterar o comando principal e os aliases do yMultas.

commands:
  fines: 'multas|multa|ymultas'

economies.yml

Use economies.yml para definir a economia padrão e os providers disponíveis.

default: 'money'

economies:
  money:
    provider: 'Money'
    display: 'Dinheiro'
    abbreviated: 'coins'
    symbol: '$'
    allow-offline: true
    permission: ''

O campo permission existe nas economias em economies.yml, mas não há verificação dessa permissão no código atual.

menus.yml

Use menus.yml para alterar nomes, tamanhos, slots e itens dos menus de multas pendentes, histórico, ranking, cofre e confirmação de pagamento.

messages.yml

Use messages.yml para personalizar mensagens de erro, ajuda, aplicação, recebimento, pagamento e remoção de multas.

Nesta página