/robozin

:gear: Just a simple discord bot

Primary LanguageTypeScript

pt-br

a little robot

About • Technologies • How to run • Contributions • License • Author


💡 About the project

A discord bot with commands in both english and brazilian portuguese and multiple functionalities, such as:

COMANDOS

  • ;help || ;ajuda - show available commands

  • ;pool || ;enquete "question" "answer1" "answer2" - to create a poll and let users vote

  • ;greet || ;hello || ;oi - say "hello" to the bot

  • ;repeat || ;fala - to repeat message (-d to delete initial message | -tts to enable speech-to-text)

  • ;loud || ;grita - to say "AAAAh" out loud

  • ;choose || ;escolhe param1 param2 - choose between parameters

  • ;quote || ;frase - quote a message when replied

The bot also welcomes someone when it enters the server


🚀 Technologies

. Discord.js

. Node.js


💻 How to run

FIRST OF ALL

  • You will need to have node.js installed in you machine;

  • Also, it's very important to have a package manager, such as npm;

  • To run the bot locally, you will need to configurate an valid token in src/config/config.json;

CLONE THIS REPOSITORY

$ git clone https://github.com/iaraoliveira/robozin.git

INSTALLING THE DEPENDENCIES

$ npm install

RUN THE APPLICATION

$ npm start

🤝 How to contribute

FORK THIS REPOSITORY

# if you're using GitHub CLI, run this command
# but using the website interface is also an option

$ gh repo fork iaraoliveira/NOME_DO_REPO

STEP BY STEP

# clone the repo you just forked
$ git clone your-fork-url && cd NOME_DO_REPO

# create a branch
$ git checkout -b my-feature

# add and commit your modifications
$ git add .
$ git commit -m 'feature: minha contribuição'

# send your brand new code to the created branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch.


📔 License

This project is under the MIT license, you can read more about it in LICENSE


With 🤍 by iara
Let's talk