Skip to content

KeviNKvN-X/Template-de-Bot-em-TypeScript

Repository files navigation

🤖 Template de Bot em TypeScript

Uma base para criação de bots Discord em TypeScript, totalmente livre e de fácil utilização.

📋 Pré-requisitos

Este projeto requer Node.js e npm. Certifique-se de ter ambos instalados antes de prosseguir.

🛠 Instalação

Siga estes passos para configurar o bot para uso local.

Clone o Repositório

git clone https://github.com/KeviNKvN-X/Template-de-Bot-em-TypeScript
cd Template-de-Bot-em-TypeScript

Instale as Dependências

Na raiz do seu projeto, execute:

npm install

Isso instalará todas as dependências necessárias para rodar o bot.

⚙️ Configuração

Configure o Arquivo .env

Copie o arquivo .env.example para criar um novo arquivo .env:

cp .env.example .env

Edite o arquivo .env com as suas configurações específicas (tokens, chaves API, etc.).

Exemplo de variáveis no .env:

DISCORD_TOKEN=SEU_TOKEN_AQUI
CLIENT_ID=SEU_CLIENT_ID_AQUI

Inicie o Bot

Para iniciar o bot em modo de desenvolvimento, use:

npm run start:dev

🖥 Uso

Criação de Comandos

Para criar novos comandos para o bot, você pode seguir o exemplo fornecido em src/examples/commandExample.ts. Este arquivo contém um template básico para a estruturação de comandos.

// Exemplo simplificado da estrutura de um comando
import { typeCommand } from "../types";
import createCommand from "../../config/commands/createCommand";
import { categories } from "../../config/categories/category";

const commandExample = createCommand({
    name: "comando",
    description: "Descricão do comando",
    category: categories.category,
    usage: {
        prefix: "!comando [message]",
        slash: "/comando [message]",
    },
    isActive: true,
    cooldown: 0,
    type: typeCommand.all,
    slashCommandOptions?: [],
    permissions: [],
    execute: async (args: Message | CommandInteraction) =>{
        // codigo do comando
     }
})

Criação de Eventos

Para integrar novos eventos ao bot, siga o exemplo em src/events/eventExample.ts.

// Exemplo de implementação de um evento
import { Events } from "discord.js";
import { EventType } from "../types";

const EventExample: EventType = {
    name: Events.ClientReady,
    once: true,
    execute: async (client) => {
        console.log(`O bot ${client.user.tag} foi iniciado!`);
    }
}

export default EventExample;

🤝 Contribuindo

Contribuições são sempre bem-vindas! Veja CONTRIBUTING para mais informações sobre como contribuir para este projeto.

📄 Licença

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE para mais detalhes.

📞 Contato

Kevin Luan Damm

Para dúvidas, contatos e feedbacks, me chame no meu discord: kevinkvn_

URL do projeto: https://github.com/kevinkvn/bot-ts

About

Uma base para criação de bots Discord em TypeScript, totalmente livre e de fácil utilização.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published