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 VIPs. 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 VIPs serão armazenados. O plugin suporta três tipos de armazenamento:

• SQLITE: Armazena dados em um arquivo local. Ideal para servidores pequenos ou únicos.
• MYSQL: Conecta a um servidor MySQL externo. Recomendado para servidores médios.
• HIKARI: Usa pool de conexões para MySQL. Recomendado para servidores grandes ou redes por melhor performance e sincronização.

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

Quando usar cada tipo:

• SQLITE: Servidor único sem necessidade de sincronização
• MYSQL: Múltiplos servidores compartilhando VIPs
• HIKARI: Redes grandes com alto volume de transações

general

Configurações gerais que controlam o comportamento do sistema de VIPs.

general:
  # Usar salvamento em uuid
  uuid: false
  # Nome deste servidor na proxy
  proxy-name: 'rankup'
  # Reduzir o tempo dos vips que não estão equipados; reduzir apenas do vip ativo
  reduce-non-equiped: false
  # Setar o grupo do vip sempre ao logar
  login-set-group: true
  # Reduzir tempo dos vips nesse servidor (desative caso tenha vários no mesmo MYSQL -> deixe ativado apenas em um dos servidores)
  reduce-this: true
  # Delay para trocar VIP em segundos
  trade-delay: 300
  # Permitir o jogador ter ativado todos os vips ao mesmo tempo
  active-all: false
  # Tag para o jogador que mais ativou VIPs
  tag: '&e[R]'

Explicação detalhada:

uuid

Define se os dados serão salvos usando UUID ou nome do jogador.

• true - Usa UUID (recomendado, previne problemas com mudança de nome)
• false - Usa nome do jogador (compatibilidade com sistemas antigos)

proxy-name

Nome identificador deste servidor na rede BungeeCord/Velocity. Usado para comandos BungeeCord específicos e integração com yLeague.

Exemplo:

proxy-name: 'lobby'    # Servidor lobby
proxy-name: 'survival' # Servidor survival

reduce-non-equiped

Controla como o tempo dos VIPs é descontado quando o jogador possui múltiplos VIPs.

• true - Apenas o VIP ativo/equipado perde tempo
• false - Todos os VIPs do jogador perdem tempo simultaneamente

Exemplo prático:

Jogador possui VIP Diamante (ativo) e VIP Ouro (aguardando):

• Se true: Apenas Diamante perde tempo, Ouro mantém duração completa
• Se false: Ambos perdem tempo simultaneamente

login-set-group

Define se o grupo de permissões do VIP será aplicado automaticamente ao logar.

• true - Sempre aplica o grupo ao login (recomendado)
• false - Não reaplica automaticamente

Útil para garantir que o jogador sempre tenha as permissões corretas, mesmo após problemas ou reinicializações.

reduce-this

Importante para redes com múltiplos servidores!

Controla se este servidor específico irá descontar o tempo dos VIPs.

• true - Este servidor desconta tempo
• false - Este servidor não desconta tempo

Configuração recomendada para redes:

# No servidor principal (survival/factions):
reduce-this: true

# Nos servidores secundários (lobby/minigames):
reduce-this: false

trade-delay

Tempo de espera (cooldown) em segundos para trocar entre VIPs.

trade-delay: 300  # 5 minutos
trade-delay: 600  # 10 minutos
trade-delay: 0    # Sem cooldown

Previne que jogadores fiquem trocando VIPs constantemente para abusar de benefícios específicos.

active-all

Define se jogadores podem ter múltiplos VIPs ativos simultaneamente.

• true - Múltiplos VIPs ativos ao mesmo tempo (acumula benefícios)
• false - Apenas um VIP ativo por vez (padrão, recomendado)

tag

Tag especial exibida para o jogador no TOP 1 de ativações de VIPs.

tag: '&e[R]'      # Tag amarela [R]
tag: '&6&l[★]'    # Estrela dourada em negrito
tag: ''           # Sem tag

Aparece nos placeholders %yvips_tag_vips% e {vip_tag_vips}.

party-vip

Sistema colaborativo onde o servidor acumula valor de VIPs ativados pelos jogadores e executa recompensas quando atinge uma meta coletiva.

party-vip:
  enable: true
  # Valor que precisa ser acumulado para executar a ação
  value: 100.0
  # Resetar ao atingir
  reset-completed: true
  # Somar valor ao utilizar /setvip
  set-sum: false
  # Comando que será executado
  command: [ 'alert &cAtingimos a META de R$ 100,00 em VIPs vendidos.' ]
  # Mensagens do party-vip
  message:
    disabled: '&cEste sistema foi desativado.'
    add: |

      &b&lPARTY VIP: &aUm novo VIP foi ativado!
      &eProgresso atual: &7(&fR$ {has}&7/&bR$ {need}&7)

    got: |

      &b&lPARTY VIP: &aA META foi atingida!
      &eValor alcançado: &7(&fR$ {has}&7/&bR$ {need}&7)

    progress: |

      &b&lPARTY VIP
      &eProgresso atual: &7(&fR$ {has}&7/&bR$ {need}&7)

Como funciona:

1. Configure o valor da meta (value: 100.0)
2. Configure o party-vip-value de cada VIP em vips.yml
3. Quando jogadores ativam VIPs, o valor acumula
4. Ao atingir a meta, os comandos são executados
5. Se reset-completed: true, o contador volta a zero

Exemplo de configuração de VIP:

# Em vips.yml
vips:
  diamante:
    party-vip-value: 50.0  # Cada VIP Diamante adiciona R$ 50,00

Placeholders disponíveis:

enable

Ativa ou desativa o sistema de Party VIP.

value

Meta a ser alcançada. Quando o acumulado atingir este valor, as recompensas são liberadas.

reset-completed

Define se o contador volta a zero após completar a meta.

• true - Reseta para iniciar nova meta
• false - Mantém acumulado (não recomendado)

set-sum

Define se comandos administrativos /setvip devem contar para o Party VIP.

• true - VIPs dados por admin contam
• false - Apenas VIPs ativados naturalmente contam (recomendado para evitar trapaças)

command

Lista de comandos executados quando a meta é atingida.

Exemplos de comandos:

command:
  - 'alert &aParty VIP completado! Todos ganham 3x XP por 1 hora!'
  - 'lp group default permission set some.boost.permission true'
  - 'give @a diamond 5'
  - 'eco give @a 1000'

progress-bar

Configuração visual da barra de progresso exibida em mensagens e placeholders do Party VIP.

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

Como funciona:

A barra de progresso é gerada dinamicamente baseada no progresso atual.

Exemplo visual:

Progresso: [&a::::::&7::::] 60%

Neste exemplo:

• 6 símbolos verdes (60% completo)
• 4 símbolos cinzas (40% faltando)

amount

Quantidade total de símbolos na barra.

amount: 10  # Barra pequena:  [:::::::::]
amount: 20  # Barra grande:   [::::::::::::::::::::]
amount: 5   # Barra mínima:   [:::::]

symbol

Caractere usado para cada segmento da barra.

symbol: ':'   # [:::::::::]
symbol: '|'   # [||||||||||]
symbol: '█'   # [██████████]
symbol: '='   # [==========]

color-yes

Cor dos segmentos completados.

color-yes: '&a'  # Verde
color-yes: '&2'  # Verde escuro
color-yes: '&e'  # Amarelo

color-not

Cor dos segmentos não completados.

color-not: '&7'  # Cinza
color-not: '&8'  # Cinza escuro
color-not: '&c'  # Vermelho

Resultado final:

Com a configuração padrão e 60% de progresso:

&a::::::&7:::: (60%)

Boas práticas

Configuração para servidor único

general:
  uuid: true
  reduce-this: true
  active-all: false

database:
  storage-type: SQLITE

Configuração para rede BungeeCord

Servidor principal (Survival):

general:
  uuid: true
  proxy-name: 'survival'
  reduce-this: true
  active-all: false

database:
  storage-type: HIKARI
  data:
    host: 'mysql.seuserver.com'
    port: 3306
    database: 'minecraft'
    username: 'minecraft'
    password: 'senha_segura'

Servidores secundários (Lobby, Minigames):

general:
  uuid: true
  proxy-name: 'lobby'  # ou 'minigames'
  reduce-this: false   # Importante!
  active-all: false

database:
  storage-type: HIKARI
  data:
    # Mesmas credenciais do servidor principal
    host: 'mysql.seuserver.com'
    port: 3306
    database: 'minecraft'
    username: 'minecraft'
    password: 'senha_segura'

Configuração para Party VIP ativo

party-vip:
  enable: true
  value: 500.0
  reset-completed: true
  set-sum: false
  command:
    - 'alert &a&lMETA ATINGIDA! &fTodos ganham &62x XP &fpor &e1 hora&f!'
    - 'lp group default permission set essentials.speed true'