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.

gorilla.yml

commands.yml

config.yml

economies.yml

menus.yml

messages.yml

Configuração do plugin (config.yml)

O arquivo config.yml controla o funcionamento principal dos mascotes, incluindo banco de dados, limites de recompensas e integrações com outros sistemas.

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

Mantenha desativado em produção, pois pode gerar muitos logs e afetar a performance.

database

Define como e onde os dados dos mascotes 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: ''

Se usar SQLITE, não precisa preencher os dados de conexão. O arquivo será criado automaticamente em plugins/yMascots/data.db.

Define o tempo de espera (em ticks) antes de carregar os dados do jogador após o login. Essencial para sincronização em redes BungeeCord.

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

Quando usar:

Servidor único: Pode usar valores baixos (10-20 ticks)
Rede BungeeCord: Use 20-40 ticks para garantir sincronização correta entre servidores

1 segundo = 20 ticks. O valor padrão de 20 ticks equivale a 1 segundo de espera.

limit

Controla o limite de recompensas que podem ser coletadas de uma vez. Esta configuração é crítica para a performance do servidor.

limit:
  enabled: true
  # Máximo que irá recolher por vez
  max: 1000

Por que isso é importante:

Quando um mascote acumula muitas recompensas, coletar todas de uma vez pode:

Gerar lag significativo
Causar travamento do servidor
Sobrecarregar o inventário do jogador

Recomendações:

Servidor pequeno (até 50 players): max: 1000
Servidor médio (50-150 players): max: 500
Servidor grande (150+ players): max: 250

Aumentar muito este valor ou desabilitar o limite pode crashar seu servidor quando jogadores coletarem recompensas acumuladas.

general

Configurações gerais que controlam integrações e limites do sistema de mascotes.

general:
  # Permitir colocar spawners apenas nos plots
  plot: false
  # Ativar o sistema de mascotes por clan
  use-clans: false
  # Ativar o modo bungeecord
  bungeecord: false
  # Número padrão de slots para o mascote do clan
  clan-slot-default: 1
  # Número máximo de slots para o mascote do clan
  clan-slot-maximum: 10
  # Item do slot que será ativável
  clan-slot-item:
    material: 'HOPPER'
    name: '&bSlots'
    lore:
      - ''
      - '&fQuantia: &a{amount}'
      - ''
      - '&7Clique com botão direito para ativar.'

Explicação dos parâmetros:

plot: Quando ativado, mascotes só podem ser colocados em plots onde o jogador tem permissão. Útil para servidores com PlotSquared/GriefPrevention.
use-clans: Ativa integração com yClans, permitindo mascotes compartilhados pelo clan. Membros do clan podem visualizar e gerenciar mascotes coletivamente.
bungeecord: Habilite se seu servidor faz parte de uma rede BungeeCord. Permite sincronização de dados entre servidores.
clan-slot-default: Número inicial de slots que mascotes de clan possuem. Cada slot permite armazenar mais recompensas.
clan-slot-maximum: Limite máximo de slots que um mascote de clan pode ter. Cria progressão e limita poder dos clans dominantes.
clan-slot-item: Configuração do item usado para ativar slots adicionais. Jogadores podem clicar com o item para expandir capacidade do mascote.

Exemplos de uso:

Servidor com plots:

plot: true
use-clans: false

Servidor de clans/facções:

plot: false
use-clans: true
clan-slot-default: 3
clan-slot-maximum: 15

Rede BungeeCord:

bungeecord: true
login-delay: 30

O sistema de plots verifica automaticamente se o jogador tem permissão no terreno usando plugins compatíveis (PlotSquared, GriefPrevention, etc).

Para usar use-clans: true, é necessário ter o plugin yClans instalado e funcionando no servidor.