syntax-sdk
v1.0.0
Published
SDK oficial para integração de bots com a economia e telemetria da Syntax
Maintainers
Readme
Syntax SDK (Node.js & Bun)
O SDK oficial para integração de bots de Discord com a API da Syntax Bot List & Economia.
Com esta biblioteca, você pode facilmente verificar se os usuários votaram no seu bot (para liberar recompensas ou comandos exclusivos) e enviar pings de telemetria/uptime ativos para atualizar o status e exibir gráficos de latência no painel da Syntax.
🔗 Links Úteis
📦 Instalação
Instale o pacote usando seu gerenciador de pacotes favorito:
npm install syntax-sdk
# ou
yarn add syntax-sdk
# ou
bun add syntax-sdk🚀 Como Usar
1. Inicialização
Obtenha a sua Chave Secreta do SDK na aba de configurações do seu bot no Dashboard da Syntax e configure no construtor:
import { SyntaxClient } from "syntax-sdk";
const syntax = new SyntaxClient({
token: "SUA_CHAVE_SECRETA_DO_SDK", // Mantenha isso em segredo (env vars)
guildId: "724823792794337301", // ID do servidor da botlist
appId: "847178737010344006" // ID do seu bot
});2. Verificar Voto de Usuário
Use o método checkVote para verificar se o usuário votou recentemente. Isso é ideal para bloquear comandos VIP ou recompensar usuários ativos.
try {
const vote = await syntax.checkVote("ID_DO_USUARIO_DISCORD");
if (vote.voted) {
console.log("Usuário já votou!");
console.log(`Cooldown expira em: ${vote.cooldownExpiresAt}`);
console.log(`Tempo restante: ${vote.timeRemaining}ms`);
} else {
console.log("Usuário ainda não votou.");
}
} catch (error) {
console.error("Erro ao validar voto:", error.message);
}3. Enviar Telemetria Ativa (Opcional)
Você pode enviar pings de telemetria periódicos para registrar a latência em tempo real e atualizar a quantidade de servidores do bot na vitrine. Isso garante o status online no monitor de uptime!
// Exemplo em um evento 'ready' ou com setInterval a cada 2 minutos:
setInterval(async () => {
try {
await syntax.sendPing({
latency: client.ws.ping, // Latência em milissegundos
guildCount: client.guilds.cache.size // Quantidade total de servidores
});
console.log("Telemetria enviada com sucesso para a Syntax!");
} catch (error) {
console.error("Falha ao enviar telemetria:", error.message);
}
}, 120_000);💰 Economia de Syntax Coins
A Syntax Bot List conta com um sistema ativo de moedas! Ao votar no seu bot pelo site ou pelo Discord, o usuário recebe Syntax Coins diretamente na carteira dele como recompensa. Divulgar o link de votação do seu bot ajuda a impulsionar sua aplicação e distribui recompensas para sua comunidade!
📄 Licença
Distribuído sob a licença MIT.
