LogoyStore
yArmazemAddons

yArmazemCategoriasAddon

Sistema de categorias para o menu principal do yArmazem.

Visão geral

O yArmazemCategoriasAddon habilita categorias no menu principal do armazém.

Quando o addon está ativo, o yArmazem:

  • Carrega o arquivo addons/categorias.yml.
  • Registra as categorias configuradas.
  • Adiciona os ícones das categorias no menu principal.
  • Abre o menu menus/categoria.yml filtrando apenas as plantações daquela categoria.

A detecção do addon é feita pelo nome yArmazemCategoriasAddon. Se ele não estiver ativo, o arquivo addons/categorias.yml não é carregado.

Arquivos envolvidos

ArquivoFunção
addons/categorias.ymlDefine as categorias, seus ícones e quais plantações pertencem a cada categoria.
plantacoes.ymlDefine as plantações disponíveis e o identificador usado pela categoria.
menus/principal.ymlMenu onde os ícones das categorias são exibidos.
menus/categoria.ymlMenu aberto ao clicar em uma categoria.

Estrutura do categorias.yml

Exemplo padrão:

categorias:
  farm:
    material-list:
      - 'CACTUS:0'
    icon:
      slot: 8
      material: 'SEEDS'
      name: '&ePlantações'
      lore:
        - '&7Confira os seus drops de farm'
        - '&7e venda ou colete-os.'
        - ''
        - '&aClique para acessar'

Campos da categoria

CampoObrigatórioDescrição
categorias.<id>SimID interno da categoria. Exemplo: farm, mineracao, madeiras.
material-listSimLista de plantações que aparecem dentro da categoria.
icon.slotSimSlot do ícone da categoria no menu principal.
icon.materialSimMaterial do ícone da categoria.
icon.nameSimNome exibido no ícone.
icon.loreNãoLore exibida no ícone.

O bloco icon usa o mesmo padrão de item dos outros menus do yArmazem.

Como montar o material-list

Cada item da material-list deve seguir o formato:

MATERIAL:DATA

Esse valor precisa bater com o item gerado em plantacoes.yml:

Plantacoes:
  cacto:
    ID: CACTUS
    Data: 0

Nesse caso, a categoria deve usar:

material-list:
  - 'CACTUS:0'

Se a plantação usa outro material ou outra data, ajuste o valor da lista para o mesmo ID:Data.

Mostrar plantações apenas nas categorias

Em plantacoes.yml, o campo MostrarPrincipal controla se a plantação aparece diretamente no menu principal.

Plantacoes:
  cacto:
    ID: CACTUS
    Data: 0
    MostrarPrincipal: false

Com MostrarPrincipal: false, a plantação não aparece na listagem principal, mas continua aparecendo dentro das categorias que incluírem CACTUS:0 em material-list.

Com MostrarPrincipal: true, a plantação aparece no menu principal e também pode aparecer dentro das categorias.

Exemplo com múltiplas categorias

categorias:
  farm:
    material-list:
      - 'CACTUS:0'
      - 'SUGAR_CANE:0'
      - 'WHEAT:0'
    icon:
      slot: 8
      material: 'SEEDS'
      name: '&eFarm'
      lore:
        - '&7Veja suas plantações de farm.'
        - ''
        - '&aClique para acessar'

  madeiras:
    material-list:
      - 'OAK_LOG:0'
      - 'SPRUCE_LOG:0'
    icon:
      slot: 17
      material: 'OAK_LOG'
      name: '&6Madeiras'
      lore:
        - '&7Veja suas madeiras armazenadas.'
        - ''
        - '&aClique para acessar'

Fluxo de funcionamento

  1. O servidor inicia ou o plugin é recarregado.
  2. O yArmazem verifica se yArmazemCategoriasAddon está ativo.
  3. Se estiver ativo, addons/categorias.yml é carregado.
  4. Cada categoria é registrada com ID, lista de materiais, ícone e slot.
  5. O menu principal adiciona os ícones das categorias nos slots configurados.
  6. Ao clicar em uma categoria, o menu de categoria abre exibindo apenas as plantações presentes em material-list.

O layout do menu aberto ao clicar em uma categoria é configurado em:

menus/categoria.yml

Esse menu usa os mesmos placeholders principais de plantação e informações documentados em Placeholders.

Exemplos de placeholders disponíveis nos itens de plantação:

PlaceholderDescrição
{display}Nome configurado da plantação.
{quantia}Quantia armazenada da plantação.
{total}Valor total da venda.
{unitario}Valor unitário da plantação.
{bonus}Bônus de venda do jogador.
{bolsa}Valor atual da bolsa.

Cuidados importantes

  • O nome do addon precisa ser yArmazemCategoriasAddon para ser detectado.
  • O arquivo addons/categorias.yml só é carregado quando o addon está ativo.
  • O valor em material-list deve ser igual ao ID:Data da plantação.
  • Slots de categorias podem sobrescrever itens do menu principal se usarem o mesmo slot.
  • Se MostrarPrincipal estiver como false, a plantação só será acessível pelas categorias configuradas.
  • Em versões antigas, alguns materiais podem exigir IDs ou nomes compatíveis com a versão do servidor.

Problemas comuns

A categoria não aparece no menu principal

Verifique:

  • Se o addon yArmazemCategoriasAddon está instalado e ativo.
  • Se existe o arquivo addons/categorias.yml.
  • Se o YAML está válido.
  • Se icon.slot está dentro do tamanho do menu principal.
  • Se outro item não está usando o mesmo slot.

A categoria abre vazia

Verifique:

  • Se os valores de material-list existem em plantacoes.yml.
  • Se o formato está correto, por exemplo CACTUS:0.
  • Se a plantação foi carregada sem erros.
  • Se Aparecer sem ou configuração equivalente permite mostrar itens sem quantidade armazenada.

Uma plantação aparece no menu principal e na categoria

Isso acontece quando MostrarPrincipal está como true ou não foi definido.

Para deixar a plantação apenas dentro das categorias, configure:

MostrarPrincipal: false

Erro ao carregar categorias

Se aparecer no console a mensagem abaixo:

Há um erro na sua categorias.yml

Revise a indentação do YAML e confira se cada categoria possui material-list, icon.slot e um bloco icon válido.

Exemplo completo

plantacoes.yml:

Plantacoes:
  cacto:
    Ordem: 1
    ID: CACTUS
    Data: 0
    Display: '&aCacto'
    Preco: 10.0
    MostrarPrincipal: false
    ItemDisplay:
      material: 'CACTUS'
      name: '&aCacto'
      lore:
        - '&fQuantia: &a{quantia}&f.'
        - '&fPreço total: &a{total}&f.'
        - ''
        - '&7Clique com esquerdo para vender.'
        - '&7Clique com direito para coletar.'

addons/categorias.yml:

categorias:
  farm:
    material-list:
      - 'CACTUS:0'
    icon:
      slot: 8
      material: 'SEEDS'
      name: '&ePlantações'
      lore:
        - '&7Confira seus drops de farm.'
        - ''
        - '&aClique para acessar'

Resultado:

  • O ícone Plantações aparece no slot 8 do menu principal.
  • O cacto não aparece diretamente no menu principal.
  • Ao clicar na categoria, o cacto aparece no menu menus/categoria.yml.

Nesta página