Uma bot de discord criada com finalidade de aprender um pouco mais sobre typescript, e ainda ganhar um bot pra colocar no meu próprio servidor 🤭
Descrição | Iniciando | O que tem dentro?
A Kurisu é uma bot que não é focada em algo específico, porém ela possui alguns comandos bem interessantes de se usar, tendo comandos interativos, informativos, manipulação de imagem, dentre outros. Ela foi feita em typescript usando a biblioteca discord.js, suas principais inspirações foram GarticBot, Mantaro e Loritta, em especial a Mantaro, que deu a base inicial inteira e o conceito de como são mostradas as MessageEmbed's.
Os comandos presentes podem ser consultados usando o comando ks.help que lista todos os comando presentes (caso você precise saber algo mais especifico pode digitar ks.help <comando>, que mostra o que o comando faz e como deve ser usado) ou no site da bot que inclusive foi muito inspirado no site do GarticBot juntamente com a forma de usar os comandos que parece que você está acessando algum método presente no bot literalmente ks.comando.
A personagem usada para ser o rosto desse bot foi a Makise Kurisu de Steins Gate, sim esse desafio foi tudo com a intenção de indicar o anime pra a comunidade 🤪
- Baixando o repositório
- Usando Git
git clone https://github.com/jpalvesl/kurisu.git- Usando Github CLI
gh repo clone jpalvesl/kurisu💡 ou qualquer outra forma que você preferir
- Variáveis de ambiente
Se tudo estiver certo, crie um arquivo com o nome de .env seguindo o exemplo do .env.example com o seguinte comando:
Para Windows: $ copy .env.example .env
Para Linux: $ cp .env.example .env
| Opção | Descrição | Obrigatório? |
|---|---|---|
| TOKEN | Token de autenticação do seu bot | sim |
| CLIENT_ID | ID da aplicação no discord | sim |
| PREFIX | Prefixo dos comandos | sim |
| TENORKEY | Key da Tenor API gif | sim |
| WEATHERAPIKEY | Key do OpenWeatherMap API | sim |
| NEWSAPIKEY | Key da NewsAPI | sim |
| LOGINMEME | Login do ImgFlip API | sim |
| PASSWORDMEME | Senha do ImgFlip API | sim |
- Instalação e execução
- Usando npm
npm install
npm run dev- Usando yarn
yarn
yarn dev./src
├── assets
├── commands
index.ts
-
assets: Pasta que guarda a ultima imagem filtrada que foi enviada para o discord. -
commands: Todos os comandos que a bot possui.
This project is under the UNLICENSE. See the file UNLICENSE for more details.
Construido com 💙 por João Lima
Baseado no readme template por Henrique Miranda