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 é o coração do plugin, onde você controla todos os aspectos do sistema de ranks e prestígios. 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 dos jogadores 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: ''

login-delay

Define o tempo de espera em ticks antes de carregar os dados do jogador após o login. Essencial para servidores com mina separada ou redes BungeeCord/Velocity.

# Delay em ticks (20 ticks = 1 segundo)
# Recomendado: 20 ticks
login-delay: 20

Quando usar delays maiores:

• Servidores em rede BungeeCord/Velocity: 40-60 ticks
• Servidor único: 20 ticks (padrão)
• Problemas de sincronização: aumentar até 100 ticks

rankup-cooldown

Define o tempo de espera em segundos entre um rankup e o próximo. Evita que jogadores façam vários rankups em sequência muito rápida.

# Cooldown em segundos entre rankups
rankup-cooldown: 5

• 0 — Sem cooldown (jogadores podem rankup imediatamente após o anterior)
• Valores positivos — Tempo em segundos que o jogador deve aguardar

staff-block

Impede que membros da equipe (staff) ganhem ranks automaticamente, útil para manter a integridade do sistema de ranks apenas para jogadores.

# Impede que jogadores com permissão de staff ganhem ranks
staff-block: false

Use staff-block: true se quiser que moderadores e admins não participem do sistema de progressão.

hide-enabled

Permite que jogadores com a permissão yrankup.hide escondam suas tags de rank.

# Quando ativado, jogadores com a permissão yrankup.hide terão suas tags escondidas
hide-enabled: false

Útil para staff que não quer exibir sua tag de rank em plugins de chat.

rankup-cmd-menu

Define o comportamento do comando /rankup.

# true = abre menu | false = dá rankup direto
rankup-cmd-menu: true

• true - Abre menu de confirmação com preview dos requisitos
• false - Dá rankup diretamente sem confirmação (mais rápido)

prestige-cmd-menu

Define o comportamento do comando /prestigio.

# true = abre menu | false = dá prestígio direto
prestige-cmd-menu: true

• true - Abre menu de confirmação (recomendado, pois prestígio reseta o rank)
• false - Dá prestígio diretamente sem confirmação

heads-disabled

Desativa completamente o sistema de heads (cabeças de mobs).

# Desativa coleta e uso de heads
heads-disabled: false

Ative (true) se não quiser usar o sistema de heads no seu servidor.

coin-disabled

Desativa completamente o sistema de fragmentos (coins/fragments).

# Desativa coleta e uso de fragmentos
coin-disabled: false

Ative (true) se não quiser usar o sistema de fragmentos no seu servidor.

auto-rankup

Sistema de Auto-Rankup que rankupa o jogador automaticamente quando ele tiver recursos suficientes.

auto-rankup:
  # Ativa ou desativa o sistema
  enabled: true
  # Define se vem ativado por padrão para novos jogadores
  enabled-default: false
  # Permissão necessária para ativar o auto-rankup
  permission: 'yrankup.autorankup'
  # Delay em segundos para checar se pode dar rankup
  delay: 3

Como funciona:

1. Jogador ativa o auto-rankup no menu ou com comando
2. A cada 3 segundos (configurável), o plugin verifica se o jogador tem recursos
3. Se tiver, rankupa automaticamente
4. Mensagens são enviadas normalmente

Configuração recomendada:

• Servidores pequenos: delay: 3
• Servidores grandes: delay: 5 ou delay: 10 (reduz carga no servidor)

auto-prestige

Sistema de Auto-Prestígio que prestigia automaticamente quando o jogador chega no último rank e cumpre os requisitos.

# Sistema de Auto-Prestígio
auto-prestige:
  enabled: true
  # Ativado por padrão
  enabled-default: false
  # Permissão para conseguir ativar o sistema
  permission: 'yrankup.autoprestige'
  # Delay para checar o prestígio
  # em segundos
  delay: 3

O fluxo é parecido com o Auto-Rankup: o jogador ativa o sistema e o plugin verifica periodicamente se o prestígio pode ser aplicado.

fragment

Configurações do sistema de fragmentos obtidos ao matar mobs ou quebrar blocos.

fragment:
  # Metadata do plugin de mob-stack para multiplicar os fragmentos
  # Deixe vazio '' para não usar
  metadata: 'ySpawners-MobStacked'
  # Ao matar com shift, dropar apenas a quantia de fragmentos configurados
  shift-unit: true
  # Ao matar em pé, dropar apenas a quantia de fragmentos configurados
  no-shift-unit: false
  # Mundos que não irão dropar fragmentos
  world-blacklist: []

Integração com spawners stackados:

• metadata: 'ySpawners-MobStacked' - Funciona com ySpawners
• shift-unit: true - Mata 1 mob stackado = 1 fragmento (não multiplica)
• shift-unit: false - Mata 1 mob stackado = fragmentos × stack
• no-shift-unit: true - Mata sem shift = 1 fragmento (não multiplica)
• no-shift-unit: false - Mata sem shift = fragmentos × stack

Exemplo de uso:

fragment:
  metadata: 'ySpawners-MobStacked'
  shift-unit: true    # Shift = mata 1 por 1 (farm manual)
  no-shift-unit: false  # Sem shift = mata todo stack (farm em área)
  world-blacklist: ['world_nether', 'world_the_end']

head

Configurações do sistema de heads (cabeças de mobs).

head:
  # Metadata do plugin de mob-stack para multiplicar as heads
  # Deixe vazio '' para não usar
  metadata: 'ySpawners-MobStacked'
  # Ao matar com shift, dropar apenas a quantia de heads configurados
  shift-unit: true
  # Ao matar em pé, dropar apenas a quantia de heads configurados
  no-shift-unit: false
  # Mundos que não irão dropar heads
  world-blacklist: []

Funciona da mesma forma que o sistema de fragmentos. Configure conforme a mecânica desejada de farm.

items

Configuração dos itens especiais do plugin que podem ser dados aos jogadores.

usable-item (Fragmento Ativável)

Item físico que pode ser usado pelo jogador para adicionar fragmentos à sua conta.

items:
  usable-item:
    material: '1ba16c3890af39c3f2d576586cff443de07dad32b2315e2ff6f0d5d6a3c663dd'
    name: '&b+{amount} Fragmentos'
    lore:
      - ''
      - '&fQuantia: &b{amount}'
      - ''
      - '&7Clique com botão direito para ativar.'
      - ''
      - '&7Clique com shift + botão direito para compactar'
      - '&7todos os seus fragmentos no inventário em 1 só.'
      - ''

Funcionalidades:

• Clique direito: Ativa o item e adiciona fragmentos
• Shift + Clique direito: Compacta todos os fragmentos do inventário em 1 item
• Use /fragmentos give <player> <quantia> para dar esse item

prestige-item (Item de Prestígio)

Item que dá +1 prestígio ao jogador.

items:
  prestige-item:
    material: '885620b88e0de9b34f76027c7f9c1def5e1de5ae542c6920b5f28693a54'
    name: '&aPrestigio'
    lore:
      - '&fEste item equivale à &7+1 &fnível de prestígio.'
      - ''
      - '&7Clique com botão direito para ativar.'

Use /rank giveprestigio <player> <quantia> para dar esse item.

rankup-item (Item de Rankup)

Item que dá +1 rankup ao jogador.

items:
  rankup-item:
    material: '1ad6c81f899a785ecf26be1dc48eae2bcfe777a862390f5785e95bd83bd14d'
    URL: 'http://textures.minecraft.net/texture/1ad6c81f899a785ecf26be1dc48eae2bcfe777a862390f5785e95bd83bd14d'
    name: '&aRankup'
    lore:
      - '&7Este item equivale à &f+1 &7nível de rankup.'
      - ''
      - '&7Clique com botão direito para ativar.'

Use /rank giverankup <player> <quantia> para dar esse item.

discounts

Sistema de descontos para rankups baseado em permissões. Jogadores com desconto pagam menos para upar de rank.

discounts:
  vip:
    # Ordem de prioridade (menor = maior prioridade)
    order: 1
    # Permissão necessária
    permission: 'yrankup.vip'
    # Desconto em porcentagem
    discount: 10.0

Como funciona:

• Rank custa 10.000 coins
• Jogador VIP tem 10% de desconto
• Pagará apenas 9.000 coins (10.000 - 10%)

Múltiplos níveis de desconto:

discounts:
  vip:
    order: 1
    permission: 'yrankup.vip'
    discount: 10.0
  vip_plus:
    order: 2
    permission: 'yrankup.vip.plus'
    discount: 20.0
  mvp:
    order: 3
    permission: 'yrankup.mvp'
    discount: 30.0

O jogador receberá apenas o desconto de maior prioridade (menor order) que tiver permissão.

bonus

Sistema de bônus para fragmentos e heads baseado em permissões. Aumenta a quantidade dropada ao matar mobs ou quebrar blocos.

bonus:
  vip:
    # Ordem de prioridade (menor = maior prioridade)
    order: 1
    # Permissão necessária
    permission: 'yrankup.vip'
    # Bônus em porcentagem
    bonus: 10.0

Como funciona:

• Mob dropa 100 fragmentos
• Jogador VIP tem 10% de bônus
• Receberá 110 fragmentos (100 + 10%)

Múltiplos níveis de bônus:

bonus:
  vip:
    order: 1
    permission: 'yrankup.vip'
    bonus: 10.0
  vip_plus:
    order: 2
    permission: 'yrankup.vip.plus'
    bonus: 25.0
  mvp:
    order: 3
    permission: 'yrankup.mvp'
    bonus: 50.0

O jogador receberá apenas o bônus de maior prioridade (menor order) que tiver permissão.

formats

Formatadores de texto para diferentes situações, controlando como informações são exibidas quando não há dados disponíveis.

formats:
  # Quando estiver com o progresso 100%
  progress-bar-full: '&a/rankup &7({progressbar}&7)'
  percentage-full: '{percentage}'
  # Quando não tiver próximo rank disponível
  progress-bar-none: ''
  percentage-none: ''
  tag-none: '&cÚltimo'
  name-none: '&cÚltimo'
  # Quando não tiver rank disponível
  actual-tag-none: '&cÚltimo'
  actual-name-none: '&cÚltimo'
  # Quando o jogador for um staff e estiverem bloqueados os ranks para staff
  staff-tag: ''
  staff-name: ''
  staff-progressbar: ''
  staff-percentage: ''

Uso dos formatos:

• progress-bar-full: Exibido quando o jogador pode upar (100% de progresso)
• progress-bar-none: Exibido quando não há próximo rank (último rank)
• tag-none/name-none: Texto exibido para "próximo rank" quando está no último
• staff-*: Valores exibidos para staff quando staff-block: true

progress-bar

Configuração visual da barra de progresso exibida nos placeholders e menus.

progress-bar:
  # Quantidade de símbolos na barra
  amount: 10
  # Símbolo usado na barra
  symbol: ':'
  # Cor dos símbolos completados
  color-yes: '&a'
  # Cor dos símbolos não completados
  color-no: '&7'

Exemplos de resultado:

Com as configurações padrão:

• 0% → &7:&7:&7:&7:&7:&7:&7:&7:&7:&7 (tudo cinza)
• 30% → &a:&a:&a:&7:&7:&7:&7:&7:&7:&7 (3 verdes, 7 cinzas)
• 60% → &a:&a:&a:&a:&a:&a:&7:&7:&7:&7 (6 verdes, 4 cinzas)
• 100% → &a:&a:&a:&a:&a:&a:&a:&a:&a:&a (tudo verde)

Personalização criativa:

# Barra com blocos
progress-bar:
  amount: 20
  symbol: '█'
  color-yes: '&a'
  color-no: '&8'

# Barra com setas
progress-bar:
  amount: 15
  symbol: '▶'
  color-yes: '&e'
  color-no: '&7'

# Barra minimalista
progress-bar:
  amount: 5
  symbol: '●'
  color-yes: '&b'
  color-no: '&8'

Resumo das configurações mais importantes