katreque / bottotherobot

Botto is a Discord bot template made to help you build your community from scratch, with the tools you need.

Botto the Robot

Botto is a Discord bot template made to help you build your community from scratch, with the tools you need.

How it Works

Botto provides useful functions and tools to power-up your Discord bot, totally free. With Botto is possible to:

• Generate roles, channels and it's permissions based on your template with a single command.
• Users are able to get/remove the allowed roles to themselves.
• Add your own code.

All you need to deal with is the hosting. (AWS provides a 12 months free hosting if you need)

Getting Started

0. Install Node.js 16.6.0 or newer.
1. Fork and download the Botto Project.
2. Ajust the template file.
3. Setup your bot info on the .env file.
4. Run npm i and npm run commands before Botto's first execution.
5. Run npm start and invite the bot to your Discord server with the link provided on the console.
6. Run the /template command on any channel of your Discord server.
7. Done!

Documentation

• Template Setup
• .env Setup

Contributing

Code of Conduct

Our Code of Conduct is adapted from the Contributor Covenant with some aditions. Make sure to read it in order to be part of our Community.

Contributing Guide

We appreciate any kind of contribution! :3 Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Botto.

About

Botto was created as a project inside Terê AWS User Group as a way to help other communities to born and grow. If you have any interest in learning about the ideia, share thoughts or want to join the core team, feel free to join our Discord.

License

Botto is BSD 3-Clause Licensed.

bottotherobot's Issues

Save language info

Get the language parameters from the generation command (as described on #10) or use the default language of the User that sent the command (using the Discord API). This info needs to be stored and will be used in the future.

Command to generate default template

Create a command to call the template generation function and handle the size and the language for that template.

The size should be a Enum based on the small, medium, big and giant options.
The language should be a Enum based on the EN and pt_BR options.

Create Getting Started

Start the implementation of the Getting Started.

• Installing Botto the Robot. (Wait until our Package is published)
• Creating a Discord bot.
• Configuring Botto.
• Adding Botto to a Discord Server.
• Choosing a template and executing it.
• Link to a tutorial for hosting the bot on AWS. (Issue to create a tutorial here)

Remove console logs from warning

On the eslint, remove the console logs from the warning list. It should be accepted because we use it to show some important info to the user.

Template Execution

Time to implement the template execution on the user's command. It should get the template structure and replicate it on the Discord server.

Create permission handler

Create a Permission handler where we can map Discord permissions (the most important and used) into a JSON. And we can use it on our config file and the template generation.

Create Discord bot to internal tests

Link to Discord Developers: https://discord.com/developers
Post the id and secret on the private discord team's channel.

Updating Discord.js from v12 to v13

Bunch of new stuff to add and refactor.

https://discordjs.guide/additional-info/changes-in-v13.html#before-you-start

@everyone ignoring role rules

Members without a role can see and access all channels created by Botto. They should have only basic access depending on what each template offers.

Persist user's discord bot info

• Get User's Discord bot id and token (secret) and how to store it.
• Command to start the bot.
• Generate link to add the bot to the Discord Server.

Handle commands from Admin

Create a command handler to the bot.

• Check the bot prefix in the .env.
• Detect the bot commands.
• Only execute commands if the user has admin privileges.

Add the template creation command to the docs

Create a command list to the docs and add the template command with all it's parameters (#18).

Template structure

What Modules should be added to each Template and it's respective Size (small, medium, big or giant)?

Actual Templates:

• Default
• Tech
• Gaming