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.

colors.yml

commands.yml

config.yml

json-messages.json

market.yml

menus.yml

messages.yml

permissions.yml

subcommands.yml

Configuração do plugin (config.yml)

O arquivo config.yml é o coração do plugin, onde você controla todos os aspectos do funcionamento dos clans. 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

Mantenha desativado em produção, pois pode gerar muitos logs e afetar a performance.

database

Define como e onde os dados dos clans 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/yClans/data.db.

Define se o comando /clan abre um menu ou exibe mensagens de ajuda.

# Ativar o sistema de menus do comando /clan
clan-menu: true

true - Abre menu interativo
false - Exibe mensagens de ajuda no chat

always-active-ff

Lista de mundos onde o Friendly Fire (dano entre membros do mesmo clan) está sempre ativo.

# Mundos em que o Friendly-Fire é sempre ativo
always-active-ff: [ 'none' ]

Exemplo de uso:

always-active-ff: ['world_pvp', 'arena']

Útil para arenas de treino ou eventos PvP internos.

proxy-chat

Ativa o sistema de chat na proxy (Velocity e BungeeCord).

# Ativar o sistema de chat na proxy (Velocity e BungeeCord)
proxy-chat: true

Necessário para chat de clan funcionar entre servidores em redes BungeeCord/Velocity.

proxy-chat-server-blacklist

Lista de servidores onde o chat da proxy não será enviado.

# Lista de servidores onde o proxy-chat não será enviado
proxy-chat-server-blacklist: []

Útil para excluir servidores específicos da rede (como lobbies ou servidores de minigames) do recebimento das mensagens de chat de clan/aliados.

Exemplo com servidores bloqueados:

proxy-chat-server-blacklist:
  - 'lobby'
  - 'minigames'

Só tem efeito quando proxy-chat: true está ativo.

mohist-chat

Ativa compatibilidade com plugins de chat específicos no Mohist.

# Ativar a troca do sistema de chat quando estiver no mohist
# compatível apenas com: UltimateChat, nChat e Legendchat
mohist-chat: false

Compatível com: UltimateChat, nChat e LegendChat.

Apenas ative se estiver usando Mohist e um dos plugins de chat listados.

chats

Configuração de formato dos chats do clan e aliados.

# Sistema de chats
# Placeholders disponíveis:
# {own_tag} - Retorna a tag customizada do jogador
# {clan_tag} - Retorna a tag do clan
# {clan_colortag} - Retorna a tag colorida do clan
# {clan_name} - Retorna o nome do clan
# {role} - Retorna o cargo do jogador
# {role_symbol} - Retorna o símbolo do cargo do jogador
# {player} - Retorna o nome co jogador
# {message} - Retorna a mensagem enviada pelo jogador
chats:
  clan-format: '&b[C] &7[{clan_colortag}&7] &b{role} &f{player}: &7{message}'
  ally-format: '&a[A] &7[{clan_colortag}&7] &b{role} &f{player}: &7{message}'
  clan-spy-format: '&8[C] [{clan_colortag}&8] [{clan_name}] [{role}&8]{player}: {message}'
  ally-spy-format: '&8[A] &8- [{clan_colortag}&8] [{clan_name}] [{role}&8]{player}: {message}'
  # Desativa códigos de formatação na mensagem do jogador (clan/aliado)
  # Remove: bold (&l), underline (&n), italic (&o), strikethrough (&m), obfuscated (&k) e reset (&r)
  # Cores (&0-&f, hex) continuam permitidas
  disable-formats: true

Placeholders disponíveis:

Placeholder	Descrição
`{own_tag}`	Tag customizada do jogador
`{clan_tag}`	Tag do clan (sem cor)
`{clan_colortag}`	Tag do clan com cor
`{clan_name}`	Nome completo do clan
`{role}`	Cargo do jogador
`{role_symbol}`	Símbolo do cargo
`{player}`	Nome do jogador
`{message}`	Mensagem enviada

Quando true, desativa códigos de formatação na mensagem do jogador nos chats de clan e aliados. Remove bold (&l), underline (&n), italic (&o), strikethrough (&m), obfuscated (&k) e reset (&r). Cores (&0-&f e hex) continuam permitidas.

execute-commands

Sistema de comandos executados automaticamente em eventos específicos.

execute-commands:
  # Quando criar um clan
  create: []
  # Quando desfazer o clan
  disband: []
  # Quando entrar num clan
  enter: []
  # Quando sair dum clan
  leave: []

Exemplo de uso:

execute-commands:
  create: ['broadcast &a{player} criou o clan {clan_tag}!']
  enter: ['give {player} diamond 5']
  leave: ['eco take {player} 100']

Placeholders: {player}, {clan_tag}, {clan_name}

default-values

Valores padrão para novos clans criados.

default-values:
  clan:
    # Cor padrão das letras da tag
    # O líder de cada clan poderá alterar posteriormente
    tag-color: '&7'

    # Dar por padrão a permissão de cores HEX na tag do clan
    # FORMATOS PARA USO NO CHAT:
    # <g:FF0000:00FF00>TAG
    # <gradient:00FFFF:FF00FF>TAG
    # &#54DAF4t&#549CD5a&#545EB6g
    hex-color: false

    # Descrição padrão do clan
    # O líder de cada clan poderá alterar posteriormente
    description: 'Nenhuma descrição configurada.'
    # Quantia padrão de slots que um clan vai ter
    max-players: 10
    # Quantia padrão de slots de alianças que um clan vai ter
    max-allies: 10
    # Quantia padrão de slots de rivais que um clan vai ter
    max-rivals: 10
    # Quantia de linhas que um baú vai ter por padrão
    chest-lines: 1
    # O clan já vai ser criado e verificado automaticamente?
    verified: false
    # PRIVATE = Apenas jogadores convidados poderão entrar
    # REQUEST = Jogadores poderão solicitar adesão ao clan
    # PUBLIC = Jogadores poderão entrar livremente ao clan
    # O líder de cada clan poderá alterar posteriormente
    entry-type: 'PRIVATE'

Tipos de entrada:

PRIVATE - Apenas por convite (recomendado)
REQUEST - Jogadores podem solicitar entrada
PUBLIC - Qualquer um pode entrar livremente

Cores Gradiente (HEX):

Quando hex-color: true, permite usar formatos especiais de cor:

<g:FF0000:00FF00>TAG - Gradiente vermelho para verde
<gradient:00FFFF:FF00FF>TAG - Gradiente ciano para magenta
&#54DAF4T&#549CD5A&#545EB6G - Cada letra com cor diferente

verify

Sistema de verificação de clans. Clans não verificados têm recursos bloqueados.

verify:
  # Bloquear o home quando não estiver verificado
  home: true
  # Bloquear o baú quando não estiver verificado
  chest: true
  # Bloquear o banco quando não estiver verificado
  bank: true
  # Bloquear o mercado quando não estiver verificado
  market: true
  # Bloquear mudar a cor da tag quando não estiver verificado
  modtag: true
  # Bloquear mudar o nome quando não estiver verificado
  name: true
  # Bloquear mudar a descrição quando não estiver verificado
  description: true
  # Bloquear aceitar/fazer alianças quando não estiver verificado
  ally: true
  # Bloquear fazer/receber rivalidades quando não estiver verificado
  rival: true

Use /clan verify <clan> (permissão admin) para verificar um clan.

Use o sistema de verificação para revisar clans antes de liberar recursos completos, evitando spam e nomes inadequados.

general

Configurações gerais do plugin.

general:
  # Até quanto o clan poderá aumentar os slots
  # disponíveis para convidar membros.
  max-slots: 100
  # Até quanto o clan poderá aumentar os slots
  # disponíveis para fazer alianças.
  max-ally-slots: 100
  # Até quanto o clan poderá aumentar os slots
  # disponíveis para fazer rivalidades.
  max-rival-slots: 100
  # Preço para criar um clan (Vault)
  create-cost: 100.0
  # Tempo online necessário para criar um clan (yTempoOnline) (segundos)
  time-min: 0
  # Enviar mensagem dos boletins ao logar no servidor
  login-send-newsletters: true
  # A tag vai ser forçada a ser minúscula ou maiúscula? Ou vai seguir o que o player digitou?
  # Tipos:
  # UPPER - Força a tag a ser maiúscula
  # LOWER - Força a tag a ser minúscula
  # NONE - Não interfere no que o jogador digitou
  force-tag-case: 'NONE'
  # Regex dos caracteres disponíveis para a TAG do clan
  tag-regex: '[0-9a-zA-Z]*'
  # Regex dos caracteres disponíveis para o NOME do clan
  name-regex: '[0-9a-zA-Z _]*'
  # Regex dos caracteres disponíveis para a DESCRIÇÃO do clan
  description-regex: '[0-9a-zA-Z _]*'
  # Regex dos caracteres disponíveis para a CUSTOM-TAG do jogador em um clan
  own-tag-regex: '[0-9a-zA-Z _&§]*'
  # Quantia máxima de caracteres que uma tag poderá ter
  max-tag-length: 3
  # Quantia mínima de caracteres que uma tag deverá ter
  min-tag-length: 3
  # Quantia máxima de caracteres que um nome poderá ter
  max-name-length: 10
  # Quantia mínima de caracteres que um nome deverá ter
  min-name-length: 5
  # Quantia máxima de caracteres que uma descrição poderá ter
  max-description-length: 20
  # Quantia mínima de caracteres que uma descrição deverá ter
  min-description-length: 10
  # Quantia máxima de caracteres que uma custom_tag poderá ter
  max-own-tag-length: 20
  # Quantia mínima de caracteres que uma custom_tag deverá ter
  min-own-tag-length: 10
  # Quantia máxima de caracteres que uma mensagem de boletim poderá ter
  max-newsletter-length: 100
  # Contabilizar as kills civilian no kdr
  kdr-kills-civilian: true
  # Contabilizar as kills neutral no kdr
  kdr-kills-neutral: true
  # Contabilizar as kills rival no kdr
  kdr-kills-rival: true
  # Cores permitidas nas tags
  allowed-colors: ['&0', '&1', '&2', '&3', '&4', '&5', '&6', '&7', '&8', '&9', '&a', '&b', '&c', '&d', '&e', '&f', '&#', '<g>', '<gradient>']
  # Palavras proibidas no nome do clan
  # Coloque em minúsculo
  name-blocked-words: []
  # Tags proibidas de serem usadas
  # Coloque em minúsculo
  tag-blocked: ['stf', 'tsj', 'tse', 'gov', 'tcu']
  # Quantia máxima de linhas que o baú pode ter
  # Não pode ser maior que 6 (limite do mine)
  max-chest-lines: 6
  # Preço para expandir o baú
  chest-expand-money: 100.0
  # Habilitar o uso de teclas numéricas no baú
  chest-numkeys: false
  # Habilitar o uso de shift no baú
  chest-shift: false
  # Habilitar o uso de criativo no baú
  chest-creative: false
  # Prevenir de desfazer o clan com money no banco
  prevent-disband-money: true
  # Whitelist de itens que poderão ser colocados no baú
  # Deixe [] para não usar
  chest-item-whitelist: []
  # Blacklist de itens que não poderão ser colocados no baú
  # Deixe [] para não usar
  chest-item-blacklist: []
  # Mundos em que não irá contabilizar KDR
  kdr-world-blacklist: []
  # Mundos em que não poderá setar a base do clan
  home-world-blacklist: []
  # Contabilizar mortes naturais no KDR
  kdr-natural-death: true
  # Desativar o spy ao deslogar
  spy-quit-disable: false
  # Mundos em que o sistema de fly irá funcionar
  fly-world-whitelist: [ 'PlotWorld' ]
  # Delay para "criar/entrar" em um clan após sair de um
  # em segundos
  exit-delay: 3600

Destaques importantes:

create-cost: Defina um valor alto para evitar spam de clans
time-min: Requer plugin yTempoOnline instalado
tag-regex/name-regex: Use regex para controlar caracteres permitidos
tag-blocked: Bloqueie tags de organizações reais (STF, GOV, etc)
exit-delay: 3600 segundos = 1 hora de cooldown após sair
chest-numkeys/chest-shift: Desabilite para evitar bugs de duplicação

Nunca habilite chest-creative: true em produção! Pode permitir duplicação de itens.

kills

Sistema de kills e recompensas por matar jogadores de diferentes categorias.

kills:
  # Ativar o sistema de anti-free-kill
  anti-free-kill: true
  # Eventos que serão executados ao matar um civil
  civilian:
    # Money que o jogador irá receber
    money: 1.0
    # Comando que irá executar
    command: ''
  # Eventos que serão executados ao matar um neutro
  neutral:
    # Money que o jogador irá receber
    money: 3.0
    # Comando que irá executar
    command: ''
  # Eventos que serão executados ao matar um rival
  rival:
    # Money que o jogador irá receber
    money: 5.0
    # Comando que irá executar
    command: ''

Categorias de kills:

Civilian: Jogador sem clan
Neutral: Jogador de clan diferente (não é aliado nem rival)
Rival: Jogador de clan rival

Exemplo com comandos:

kills:
  anti-free-kill: true
  rival:
    money: 10.0
    command: 'give {player} diamond 1'

special-items

Itens especiais que podem ser dados aos jogadores para expandir recursos do clan.

special-items:
  # Item para o resetkdr
  reset-kdr:
    material: 'NETHER_STAR'
    name: '&aReset KDR'
    lore: ['&7Ative para resetar seu KDR.']
  # Item para expandir baú
  expand-chest:
    material: '95732d3e57b9a62159b35d2754574452a32b4c221fc4fd363bff522ff04a577e'
    name: '&aExpandir baú'
    lore: ['&7Ative para expandir o baú do clan em 1 linha.']
  # Item para expandir vagas de membros
  expand-member:
    material: 'BRICK'
    name: '&aExpandir vagas de membros'
    lore: ['&7Ative para expandir a vaga de membros em 1.']
  # Item para expandir vagas de aliados
  expand-ally:
    material: 'QUARTZ'
    name: '&aExpandir vagas de aliados'
    lore: ['&7Ative para expandir a vaga de aliados em 1.']
  # Item para expandir vagas de rivais
  expand-rival:
    material: 'NETHER_STALK'
    name: '&aExpandir vagas de rivais'
    lore: ['&7Ative para expandir a vaga de rivais em 1.']
  # Item para habilitar o fly nas plots
  fly:
    material: 'FEATHER'
    name: '&aHabilitar o FLY nas plots'
    lore: ['&7Ative para permitir voar nas plots', '&7dos membros dos clans.']
  # Item para habilitar o uso de hex colors nas tags
  hex-color:
    material: 'NAME_TAG'
    name: '&aHabilitar a Tag Gradiente'
    lore: ['&7Ative para conseguir colocar GRADIENTE', '&7na TAG do seu clan.']
  # Item para verificar o clan
  verify-clan:
    material: 'EMERALD'
    name: '&aVerificador de Clan'
    lore: ['&7Ative para verificar o seu clan.']

Item	Descrição
`reset-kdr`	Reseta o KDR do jogador
`expand-chest`	Expande o baú do clan em 1 linha
`expand-member`	Expande a vaga de membros em 1
`expand-ally`	Expande a vaga de aliados em 1
`expand-rival`	Expande a vaga de rivais em 1
`fly`	Habilita fly nas plots dos membros
`hex-color`	Habilita tag gradiente no clan
`verify-clan`	Verifica o clan

Use /clan givespecialitem para dar estes itens a um jogador.

clan-type

Nomes de exibição para os tipos de entrada do clan.

clan-type:
  public: 'Público'
  semi-public: 'Semi-Público'
  private: 'Privado'

roles

Sistema de cargos do clan com nomes e símbolos.

roles:
  nothing:
    display-name: 'Nenhum'
    symbol: ''
  member:
    display-name: 'Membro'
    symbol: '&9-'
  trusted:
    display-name: 'Confiável'
    symbol: '&b='
  captain:
    display-name: 'Capitão'
    symbol: '&e+'
  leader:
    display-name: 'Líder'
    symbol: '&c#'

Hierarquia de permissões (menor para maior):

Nothing - Sem permissões
Member - Membro básico
Trusted - Confiável (mais permissões)
Captain - Capitão (gerenciar membros)
Leader - Líder (controle total)

newsletters

Sistema de boletins que registra eventos importantes do clan.

newsletters:
  create:
    message: '&bO jogador &f{player} &bcriou o clan {clan_tag} - {clan_name}.'
    item:
      material: 'EMPTY_MAP'
      name: '&aClan criado'
      lore: [ '', '&7{newsletter}', '&7Enviado em: &f{date} - {hour}', '' ]
  join:
    message: '&bO jogador &f{player} &bentrou para o clan {clan_tag}.'
    item:
      material: 'EMPTY_MAP'
      name: '&aJogador aderiu'
      lore: [ '', '&7{newsletter}', '&7Enviado em: &f{date} - {hour}', '' ]
  leave:
    message: '&bO jogador &f{player} &bsaiu do clan {clan_tag}.'
    item:
      material: 'EMPTY_MAP'
      name: '&aJogador saiu'
      lore: [ '', '&7{newsletter}', '&7Enviado em: &f{date} - {hour}', '' ]
  kicked:
    message: '&bO jogador &f{player} &bfoi expulso por &f{kicker}&b.'
    item:
      material: 'EMPTY_MAP'
      name: '&aJogador kickado'
      lore: [ '', '&7{newsletter}', '&7Enviado em: &f{date} - {hour}', '' ]
  banner:
    message: '&bO jogador &f{player} &bmudou o banner do clan.'
    item:
      material: 'EMPTY_MAP'
      name: '&aMudança de banner'
      lore: [ '', '&7{newsletter}', '&7Enviado em: &f{date} - {hour}', '' ]
  name:
    message: '&bO jogador &f{player} &balterou o nome do clan para {clan_name}.'
    item:
      material: 'EMPTY_MAP'
      name: '&aMudança de nome'
      lore: [ '', '&7{newsletter}', '&7Enviado em: &f{date} - {hour}', '' ]
  description:
    message: '&bO jogador &f{player} &balterou a descrição do clan para {clan_description}.'
    item:
      material: 'EMPTY_MAP'
      name: '&aMudança de descrição'
      lore: [ '', '&7{newsletter}', '&7Enviado em: &f{date} - {hour}', '' ]
  leadership:
    message: '&bO jogador &f{player} &btransferiu a liderança do clan para o jogador &f{player_to}&b.'
    item:
      material: 'EMPTY_MAP'
      name: '&aTransferência de liderança'
      lore: [ '', '&7{newsletter}', '&7Enviado em: &f{date} - {hour}', '' ]
  message:
    message: '{message}'
    item:
      material: 'EMPTY_MAP'
      name: '&a{player}'
      lore: [ '', '&7{newsletter}', '&7Enviado em: &f{date} - {hour}', '' ]

Os boletins são exibidos no menu do clan e enviados ao logar (se login-send-newsletters: true).

chat-placeholders

Formato dos placeholders do yClans quando usados em plugins de chat.

chat-placeholders:
  tag: '&7[{tag}]'
  colortag: '&7[{tag}&7]'
  name: '&7[{name}&7]'
  role: ' {role} '
  symbol: ' {role_symbol} '

Uso em plugins de chat:

# Exemplo no DeluxeChat
format: '%yclans_chat_colortag% {displayname}: {message}'
# Resultado: [ABC] Steve: Olá!

top-tag

Sistema de TAGs para identificar clans no ranking TOP CLANS.

# Sistema de TAGs para os TOP CLANS
top-tag:
  money: '&a[$]'
  spawners: '&d[S]'
  machines: '&e[M]'
  kdr: '&b[%]'

Funcionalidade:

Cada categoria de ranking exibe uma TAG colorida ao lado do clan no TOP CLANS:

money - TAG para top por dinheiro
spawners - TAG para top por quantidade de spawners
machines - TAG para top por máquinas
kdr - TAG para top por KDR (Kill Death Ratio)

Placeholders disponíveis:

Você pode usar:

Cores com & (ex: &a, &b, &c, etc.)
Códigos HEX com &# (ex: &#FF0000)
Símbolos especiais entre colchetes (ex: [$], [S], [M])

Exemplo customizado:

top-tag:
  money: '&6★'
  spawners: '&5✦'
  machines: '&e⚙'
  kdr: '&c⚔'

custom-placeholders

Crie placeholders customizados combinando outros placeholders.

custom-placeholders:
  custom1:
    # O formato ficará: %yclans_<placeholder>%
    # Por exemplo: %yclans_formatted_tag%
    placeholder: 'formatted_tag'
    from: '%yclans_has%'
    return-empty: '&7Sem clan'
    return-has: '%yclans_clan_tag%'
  custom2:
    # Use: %yclans_owntag_formatted%
    placeholder: 'owntag_formatted'
    from: '%yclans_own_tag%'
    return-empty: '%yclans_clan_tag%'
    return-has: '%yclans_own_tag%'

Como funciona:

O custom placeholder verifica o valor de from:

Se estiver vazio, retorna return-empty
Se tiver valor, retorna return-has

auto-leadership-transfer

Transferir a liderança automaticamente para outro jogador quando o líder se ausentar por X dias.

# Sistema de auto-transferência de liderança
# Quando o líder ficar offline por X dias, a liderança é transferida automaticamente
auto-leadership-transfer:
  # Ativar o sistema de auto-transferência de liderança
  enabled: false
  # Dias de inatividade do líder para transferir a liderança
  inactive-days: 30
  # Intervalo em minutos para verificar líderes inativos
  check-interval-minutes: 60
  # Prioridade de transferência: ROLE (cargo mais alto) ou ACTIVITY (mais ativo)
  priority: 'ROLE'
  # Notificar membros online quando a transferência ocorrer
  notify-members: true
  # Disbanda o clan se não houver nenhum membro elegível para assumir a liderança
  disband-if-no-successor: false

format

Sistema de formatação de números grandes.

format:
  type: 'LETTER' # Tipos: LETTER - NUMBER
  max-decimals: 4
  formats:
    - ''
    - ''
    - 'K'
    - 'M'
    - 'B'
    - 'T'
    - 'Q'
    - 'QQ'
    - 'S'
    - 'SS'
    - 'O'
    - 'N'
    - 'D'

Tipos:

LETTER: Formata com letras (1000 = 1K, 1000000 = 1M)
NUMBER: Formata com separador de milhar (1000 = 1,000)

Exemplos de formatação:

1500 → 1.5K
1000000 → 1M
1500000000 → 1.5B

Nesta página