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 pagamentos. 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 das transações 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: ''

general

Configurações gerais do sistema de pagamentos. Estes valores controlam a frequência de verificação de pagamentos e o tempo de alertas.

general:
  # Delay para checagem da notificação de pagamento (automático)
  # Em segundos
  notification-delay: 10
  # Delay para checagem da aprovação de pagamento (automático)
  # Em segundos
  verification-delay: 30
  # Delay para checagem da notificação de pagamento (manual)
  # Em segundos
  manual-delay: 30
  # Delay para realizar novas compras por um mesmo jogador
  # Em segundos
  buy-delay: 30
  # Embed do yDiscorHook para enviar a cobrança no privado
  dm-charge-embed: 'ypayments_private'
  # Embed do yDiscordHook para enviar a pré-compra no privado
  dm-pre-charge-embed: 'ypayments_pre_charge'
  # Tempo para enviar a mensagem de alerta de coleta
  # em minutos
  alert-message-time: 600

Como funciona o sistema de verificação:

• notification-delay: Intervalo de checagem para novos pagamentos pendentes. Valores menores = aprovação mais rápida, mas maior uso de recursos.
• verification-delay: Intervalo de verificação para confirmar pagamentos aprovados pelos gateways.
• manual-delay: Intervalo para pagamentos que requerem confirmação manual (ex: transferências bancárias).
• buy-delay: Intervalo realizar novas compras por um mesmo jogador.
• dm-charge-embed: Embed enviado no privado quando a cobrança é criada.
• dm-pre-charge-embed: Embed enviado no privado antes da cobrança, durante a pré-compra.
• alert-message-time: A cada 600 minutos (10 horas), jogadores com produtos não coletados recebem um lembrete.

mercado-pago

Configuração do MercadoPago para pagamentos via PIX, cartão de crédito e outras formas brasileiras.

mercado-pago:
  secret: ''
  id: ''
  notification-url: 'https://ystoreteste.000webhostapp.com/notification_mp.php'

Como obter as credenciais:

1. Acesse o Painel do MercadoPago
2. Crie uma aplicação
3. Copie o Access Token (secret) e o Public Key (id)
4. Configure uma URL de notificação (webhook) para receber atualizações automáticas

picpay

Configuração do PicPay para pagamentos instantâneos via aplicativo.

picpay:
  picpay-token: ''
  seller-token: ''
  notification-url: 'https://ystoreteste.000webhostapp.com/notification_picpay.php'

Como obter as credenciais:

1. Crie uma conta empresarial no PicPay
2. Acesse o painel de desenvolvedores
3. Gere seu PicPay Token e Seller Token

paypal

Configuração do PayPal para pagamentos internacionais.

paypal:
  email: ''
  notification-url: 'https://ystoreteste.000webhostapp.com/notification_paypal.php'

Configuração:

• email: Email da conta PayPal que receberá os pagamentos
• notification-url: URL para receber notificações IPN (Instant Payment Notification)

coinbase

Configuração do Coinbase para pagamentos com criptomoedas (Bitcoin, Ethereum, etc).

coinbase:
  version: '2018-03-22'
  api-key: ''

Como obter a API Key:

1. Acesse Coinbase Commerce
2. Crie uma conta e verifique sua identidade
3. Gere uma API Key nas configurações
4. A versão '2018-03-22' é a versão estável da API

stripe

Configuração do Stripe para pagamentos internacionais com cartão de crédito.

stripe:
  secret-key: ''
  success-url: 'https://ystoreplugins.com.br'

Configuração:

• secret-key: Chave secreta obtida no painel do Stripe
• success-url: URL para onde o jogador será redirecionado após o pagamento bem-sucedido

Limitações:

• Valor mínimo de R$ 0,50 por transação (limitação da plataforma Stripe)

short-io

Configuração do encurtador de links Short.io. Usado principalmente para links do PayPal, deixando-os mais limpos e fáceis de compartilhar.

short-io:
  enabled: true
  # Deixe vazio para usar o da yStore
  secret-key: ''
  # Deixe vazio para usar o da yStore
  domain: ''

Como funciona:

• Links do PayPal são muito longos: https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=...
• Com Short.io ficam assim: https://seu.dominio/abc123

Configuração opcional:

• Deixe os campos vazios para usar o encurtador padrão da yStore
• Ou configure suas próprias credenciais no Short.io para usar seu domínio personalizado

npc

Sistema de NPC interativo para abrir a loja. Cria um personagem no spawn que os jogadores podem clicar para acessar a loja.

npc:
  skin: 'Pitombaa'
  hologram:
    offset: 3.4
    hologram:
      - '&6&lLOJA VIRTUAL'
      - '&7Seu site agora ingame!'
      - '[item]EMERALD'

Configuração do NPC:

• skin: Nick de um jogador do Minecraft cuja skin será usada no NPC
• offset: Distância em blocos entre o NPC e o holograma (3.4 = 3.4 blocos acima)
• hologram: Linhas de texto exibidas acima do NPC

Recursos do holograma:

• Use códigos de cor (&a, &b, etc) normalmente
• Use [item]MATERIAL para exibir itens flutuantes (ex: [item]EMERALD, [item]DIAMOND)

Como usar:

1. Configure a skin e o texto do holograma
2. Use /shop setnpc na localização desejada
3. Para remover, use /shop delnpc

lores

Sistema de descrições (lore) para mapas de QR-Code. Quando um pagamento é gerado via PIX ou PicPay, o jogador pode receber um mapa com QR-Code no inventário.

lores:
  map:
    - ''
    - ' &fGerado em: &7{date} às {hour}'
    - ' &fProduto: &b{product}'
    - ' &fReferência: &b{reference}'
    - ''
  transaction-not-completed:
    - ''
    - ' &aBotão &fESQUERDO &apara atualizar.'
    - ' &aBotão &fDIREITO &apara pegar o mapa.'
    - ''

Lores disponíveis:

• map: Lore exibida no mapa quando a transação está completa
• transaction-not-completed: Lore exibida quando o pagamento ainda está pendente

Placeholders disponíveis:

Interação com mapas pendentes:

• Botão esquerdo: Atualiza o status da transação
• Botão direito: Remove o mapa antigo e gera um novo (se ainda pendente)

status

Formatação visual dos diferentes status de transações. Define as cores e símbolos usados nos menus e mensagens.

status:
  approved: '&aAprovado'
  processing: '&bProcessando...'
  pending: '&ePendente...'
  canceled: '&cCancelado'
  refunded: '&cReembolsado'
  in-mediation: '&dEm mediação...'

Status explicados:

Ordem de configuração recomendada

Para configurar o plugin pela primeira vez, siga esta ordem: