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.ymlfiltrando 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
| Arquivo | Função |
|---|---|
addons/categorias.yml | Define as categorias, seus ícones e quais plantações pertencem a cada categoria. |
plantacoes.yml | Define as plantações disponíveis e o identificador usado pela categoria. |
menus/principal.yml | Menu onde os ícones das categorias são exibidos. |
menus/categoria.yml | Menu 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
| Campo | Obrigatório | Descrição |
|---|---|---|
categorias.<id> | Sim | ID interno da categoria. Exemplo: farm, mineracao, madeiras. |
material-list | Sim | Lista de plantações que aparecem dentro da categoria. |
icon.slot | Sim | Slot do ícone da categoria no menu principal. |
icon.material | Sim | Material do ícone da categoria. |
icon.name | Sim | Nome exibido no ícone. |
icon.lore | Não | Lore 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:DATAEsse valor precisa bater com o item gerado em plantacoes.yml:
Plantacoes:
cacto:
ID: CACTUS
Data: 0Nesse 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: falseCom 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
- O servidor inicia ou o plugin é recarregado.
- O
yArmazemverifica seyArmazemCategoriasAddonestá ativo. - Se estiver ativo,
addons/categorias.ymlé carregado. - Cada categoria é registrada com ID, lista de materiais, ícone e slot.
- O menu principal adiciona os ícones das categorias nos slots configurados.
- Ao clicar em uma categoria, o menu de categoria abre exibindo apenas as plantações presentes em
material-list.
Menu de categoria
O layout do menu aberto ao clicar em uma categoria é configurado em:
menus/categoria.ymlEsse 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:
| Placeholder | Descriçã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
yArmazemCategoriasAddonpara ser detectado. - O arquivo
addons/categorias.ymlsó é carregado quando o addon está ativo. - O valor em
material-listdeve ser igual aoID:Datada plantação. - Slots de categorias podem sobrescrever itens do menu principal se usarem o mesmo slot.
- Se
MostrarPrincipalestiver comofalse, 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
yArmazemCategoriasAddonestá instalado e ativo. - Se existe o arquivo
addons/categorias.yml. - Se o YAML está válido.
- Se
icon.slotestá 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-listexistem emplantacoes.yml. - Se o formato está correto, por exemplo
CACTUS:0. - Se a plantação foi carregada sem erros.
- Se
Aparecer semou 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: falseErro ao carregar categorias
Se aparecer no console a mensagem abaixo:
Há um erro na sua categorias.ymlRevise 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çõesaparece no slot8do menu principal. - O cacto não aparece diretamente no menu principal.
- Ao clicar na categoria, o cacto aparece no menu
menus/categoria.yml.