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.

forest_suit.yml

nether_suit.yml

ocean_suit.yml

royal_suit.yml

shadow_suit.yml

fire_aura.yml

galaxy_aura.yml

heart_aura.yml

lightning_aura.yml

magic_aura.yml

smoke_aura.yml

sparkle_burst.yml

water_aura.yml

flame_burst.yml

heart_burst.yml

join_burst.yml

burst_orb.yml

firework_cannon.yml

lightning_wand.yml

particle_blaster.yml

tnt_cannon.yml

crown_hat.yml

devil_hat.yml

halo_hat.yml

pumpkin_hat.yml

tnt_hat.yml

chicken_mount.yml

cow_mount.yml

donkey_mount.yml

horse_mount.yml

pig_mount.yml

wolf_mount.yml

blaze_pet.yml

cat_pet.yml

chicken_pet.yml

dog_pet.yml

ender_pet.yml

ghost_pet.yml

pig_pet.yml

slime_pet.yml

confetti_trail.yml

flame_trail.yml

heart_trail.yml

notes_trail.yml

rainbow_trail.yml

smoke_trail.yml

snow_trail.yml

angel_wings.yml

butterfly_wings.yml

demon_wings.yml

dragon_wings.yml

ice_wings.yml

phoenix_wings.yml

commands.yml

config.yml

menus.yml

messages.yml

Configuração do plugin (config.yml)

O arquivo config.yml controla banco de dados, Redis, visibilidade, categorias e raridades. Abaixo estão todas as opções disponíveis.

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 cosméticos 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/yCosmeticos/data.db.

redis

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

enabled — true para conectar, false para desligar
host / port — endereço e porta do Redis
username / password — credenciais (deixe vazio se não usar)

Tempo de espera em ticks antes de carregar os dados do jogador após o login. Necessário para usar em servidor de mina separado.

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

general

Sistemas gerais de renderização, visibilidade, sons e integração com o yLobby.

general:
  # Intervalo (em ticks) do motor de animação. 1 = a cada tick
  render-tick-interval: 1
  # Distância máxima de visualização dos effects
  view-distance: 48.0
  # Esconder cosméticos quando o jogador está vanished
  hide-on-vanish: true
  # Se true, todos os jogadores podem usar qualquer cosmético sem precisar receber
  give-all-by-default: false
  # Esconder cosméticos no 1v1 do yLobby
  hide-in-battle: true
  # Esconder cosméticos no FFA/arena do yLobby
  hide-in-ffa: true
  # Esconder cosméticos no parkour do yLobby
  hide-in-parkour: true
  # Esconder cosméticos no vanish do yLobby
  hide-in-vanish: true
  # Esconder cosméticos no modo espectador
  hide-in-spectator: true
  # Bloquear menu/equipar enquanto estiver em combate/parkour/vanish
  block-menu-when-hidden: true
  # Mundos onde os cosméticos não aparecem
  disabled-worlds: []
  sounds:
    equip: 'ENTITY_EXPERIENCE_ORB_PICKUP'
    unequip: 'ENTITY_ITEM_BREAK'
    fail: 'ENTITY_VILLAGER_NO'

render-tick-interval

Intervalo (em ticks) do motor de animação. 1 = a cada tick.

view-distance

Distância máxima de visualização dos effects.

hide-on-vanish

Esconde os cosméticos quando o jogador está vanished.

give-all-by-default

Se true, todos os jogadores podem usar qualquer cosmético sem precisar receber por /give ou permissão individual.

give-all-by-default: false

hide-in-battle / hide-in-ffa / hide-in-parkour / hide-in-vanish

Integração com o yLobby. Esconde os cosméticos no 1v1, FFA/arena, parkour e vanish.

hide-in-spectator

Esconde os cosméticos no modo espectador.

Bloqueia o menu e o equipar enquanto o jogador estiver em combate, parkour ou vanish.

disabled-worlds

Mundos onde os cosméticos não aparecem.

Exemplo:

disabled-worlds: ['world_nether', 'world_the_end']

sounds

Sons tocados ao equipar, desequipar e falhar.

sounds:
  equip: 'ENTITY_EXPERIENCE_ORB_PICKUP'
  unequip: 'ENTITY_ITEM_BREAK'
  fail: 'ENTITY_VILLAGER_NO'

categories

Categorias do menu principal. Crie quantas quiser. Cada chave (asas, auras, etc.) é o ID da categoria.

No YAML do cosmético use type: <id da categoria> (ou o behavior, ex: WINGS).

categories:
  asas:
    display: '&6Asas'
    # behavior: WINGS | AURA | TRAIL | PET | HAT | EFFECT | ARMOR | MOUNT | GADGET
    behavior: WINGS
    slot: 10
    icon:
      material: f1e508f3873ce46427269acae036c4eae0ad7e74155552af09579839eeaa266b
      name: '&6&lAsas'
      lore:
        - ''
        - ' &7Equipe wings animadas'
        - ' &7ao redor do personagem.'
        - ''
        - ' &eClique para abrir'
        - ''
  auras:
    display: '&dAuras'
    behavior: AURA
    slot: 11
    icon:
      material: 38919ff0454c800f2209cc6f962b17a4db0165c1bb61ae326f3b9aaf0cea3ddb
      name: '&d&lAuras'
      lore:
        - ''
        - ' &7Círculos e partículas'
        - ' &7que acompanham você.'
        - ''
        - ' &eClique para abrir'
        - ''
  trails:
    display: '&bTrails'
    behavior: TRAIL
    slot: 12
    icon:
      material: f70d7a8fee1d9e36f40a91dcc91848e6410a95ff2067e416fc8ffada128bc519
      name: '&b&lTrails'
      lore:
        - ''
        - ' &7Deixe um rastro enquanto'
        - ' &7você caminha.'
        - ''
        - ' &eClique para abrir'
        - ''
  roupas:
    display: '&cRoupas'
    behavior: ARMOR
    slot: 13
    icon:
      material: LEATHER_CHESTPLATE
      name: '&c&lRoupas'
      lore:
        - ''
        - ' &7Armaduras customizadas'
        - ' &7no seu personagem.'
        - ''
        - ' &eClique para abrir'
        - ''
  pets:
    display: '&aPets'
    behavior: PET
    slot: 14
    icon:
      material: ec4410791995cd77207e5c307782ea60d50bcfbb4d4b3101427ddf97ae75b0
      name: '&a&lPets'
      lore:
        - ''
        - ' &7Companheiros flutuantes'
        - ' &7que orbitam você.'
        - ''
        - ' &eClique para abrir'
        - ''
  chapeus:
    display: '&eChapéus'
    behavior: HAT
    slot: 15
    icon:
      material: f2dc08de0cdd2340d7f5f84ddeb4a56652c4e9c1d3f98f720cfe612440fc18f0
      name: '&e&lChapéus'
      lore:
        - ''
        - ' &7Cosméticos na cabeça:'
        - ' &7coroas, halos e mais.'
        - ''
        - ' &eClique para abrir'
        - ''
  efeitos:
    display: '&fEfeitos'
    behavior: EFFECT
    slot: 16
    icon:
      material: b55ea43e592785d016acdeea9a4a6f9cf22c2753e695405e8c83d2e09ebcf647
      name: '&f&lEfeitos'
      lore:
        - ''
        - ' &7Efeitos de entrada e'
        - ' &7teleporte.'
        - ''
        - ' &eClique para abrir'
        - ''
  montarias:
    display: '&2Montarias'
    behavior: MOUNT
    slot: 22
    icon:
      material: SADDLE
      name: '&2&lMontarias'
      lore:
        - ''
        - ' &7Animais para montar'
        - ' &7e cavalgar.'
        - ''
        - ' &eClique para abrir'
        - ''
  engenhocas:
    display: '&6Engenhocas'
    behavior: GADGET
    slot: 21
    icon:
      material: BLAZE_ROD
      name: '&6&lEngenhocas'
      lore:
        - ''
        - ' &7Armas visuais: partículas,'
        - ' &7TNT e outros efeitos.'
        - ''
        - ' &eClique para abrir'
        - ''

Campo	Descrição
`display`	Nome da categoria no menu
`behavior`	`WINGS`, `AURA`, `TRAIL`, `PET`, `HAT`, `EFFECT`, `ARMOR`, `MOUNT` ou `GADGET`
`slot`	Slot do ícone no menu principal
`icon`	Item do menu (`material`, `name`, `lore`)

behavior:

WINGS — asas de partículas atrás do jogador
AURA — partículas ao redor do corpo
TRAIL — rastro só enquanto anda
PET — armor stand invisível + head orbitando
HAT — anel/partículas na cabeça (halo)
EFFECT — explosão ao entrar/teleportar
ARMOR — armaduras customizadas no personagem
MOUNT — animais para montar e cavalgar
GADGET — armas visuais: partículas, TNT e outros efeitos

No YAML do cosmético: type: asas (ou type: WINGS).

rarities

Raridades usadas nos cosméticos. A chave é o ID usado no YAML (rarity: legendary). Crie quantas quiser.

rarities:
  common: '&7Comum'
  uncommon: '&aIncomum'
  rare: '&9Raro'
  epic: '&5Épico'
  legendary: '&6Lendário'
  mythic: '&cMítico'

O valor é o nome colorido exibido no placeholder {rarity}.

Exemplo:

rarities:
  seasonal: '&bSazonal'

No YAML do cosmético: rarity: seasonal.

Nesta página