Configuração

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

Após alterar arquivos como commands.yml, config.yml, menus.yml, messages.yml, rewards.yml ou arquivos dentro de jobs/, reinicie o servidor ou use o comando de recarregamento quando disponível.

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

messages.yml

menus.yml

rewards.yml

objective-types.txt

miner.yml

fisherman.yml

Configuração do plugin (config.yml)

O arquivo config.yml controla o funcionamento geral do plugin, incluindo depuração, banco de dados, Redis, carregamento após login, ranking, fila, streak, anúncios, actionbar e sons.

debug-mode

Ativa ou desativa o modo de depuração para correção de problemas no plugin.

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

Mantenha desativado em produção, pois pode gerar muitos logs no console.

database

Define como os dados do plugin serão armazenados.

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

redis

Configura a conexão com Redis para sincronização em ambientes multi-servidores.

# Configurações do servidor redis
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 Redis quando os turnos, rankings ou jogadores ativos precisarem ser sincronizados entre servidores.

Define o atraso, em ticks, para carregar os dados do jogador após o login.

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

general

Agrupa os sistemas gerais do plugin.

# Sistemas gerais do plugin.
general:
  # Quantidade maxima de jogadores exibidos no menu de ranking.
  top-limit: 100
  # Envia actionbar periodica para jogadores em turno ativo.
  active-actionbar: true

general.queue

Controla a fila quando um turno atinge o limite de jogadores.

general:
  # Fila para turnos cheios.
  queue:
    # Se true, jogadores entram em uma fila quando o turno está cheio.
    enabled: true
    # Se true, o próximo da fila entra automaticamente quando abrir vaga.
    auto-enter: false

general.streak

Controla a sequência diária de turnos concluídos e o multiplicador aplicado nas recompensas.

general:
  # Sequência diária de turnos concluídos.
  streak:
    # Se true, registra sequência diária ao concluir turnos.
    enabled: true
    # Bônus por sequência aplicado na quantidade entregue pelas recompensas.
    # 0.05 = +5% por dia de sequência acima do primeiro.
    reward-multiplier: 0.05

general.announces

Controla os anúncios públicos e avisos de tempo restante.

general:
  # Anúncios automáticos.
  announces:
    # Anuncia quando um jogador completa um turno.
    completed: false
    # Anuncia quando um turno global é iniciado.
    global-start: true
    # Anuncia quando um turno global é encerrado.
    global-stop: true
    # Envia mensagens ao jogador quando restar esse tempo no turno ativo.
    # Formatos aceitos: 30s, 5m, 1h.
    remaining-times: [ '5m', '1m', '10s' ]

general.progress-bar

Configura a barra visual usada na actionbar de progresso.

general:
  # Barra usada na actionbar de progresso.
  progress-bar:
    # Simbolo/coloracao da parte concluida.
    filled: '&a|'
    # Simbolo/coloracao da parte pendente.
    empty: '&7|'
    # Tamanho total da barra.
    length: 20

general.sounds

Define os sons executados em ações importantes.

general:
  # Sons executados em acoes importantes.
  # Use nomes do enum Sound do Bukkit/Spigot.
  sounds:
    # Som ao entrar em um turno.
    turn-started: 'ENTITY_EXPERIENCE_ORB_PICKUP'
    # Som ao ganhar progresso em objetivo.
    progress: 'ENTITY_ITEM_PICKUP'
    # Som ao completar um turno.
    completed: 'ENTITY_PLAYER_LEVELUP'
    # Som ao falhar/expirar um turno.
    failed: 'ENTITY_VILLAGER_NO'

Próximos arquivos

As demais páginas desta seção documentam os arquivos específicos do plugin:

commands.yml: comando principal e aliases.
messages.yml: mensagens de chat, broadcasts, actionbar e títulos.
menus.yml: menus de categorias, turnos, ranking, histórico, recompensas e jogadores trabalhando.
rewards.yml: recompensas entregues ao concluir turnos.
jobs/*.yml: estrutura completa de cada emprego/turno.
objective-types.txt: tipos de objetivos disponíveis.

Nesta página