Coder Social home page Coder Social logo

rolandudv / botranktir Goto Github PK

View Code? Open in Web Editor NEW

This project forked from truckersmp/botranktir

0.0 1.0 0.0 402 KB

Discord bot that manages roles after reacting to a message, and provides the emoji list and changelog

Home Page: https://discord.gg/truckersmp

License: MIT License

JavaScript 2.87% TypeScript 97.13%

botranktir's Introduction

Botranktir

Introduction

Botranktir is a Discord bot that takes care of reaction roles. It also provides a single-use reaction roles, very advanced configuration of a guild, an emoji list and changelog, and more.

Requirements

Installation

  1. Download the repository.
  2. Run the npm ci command in the root folder.
  3. Copy the example environment file (/.env.example) and create your own one (/.env).
  4. Create a new database.
  5. Create a Discord application. Set up a bot user and enable both Presence and Server Members Intents.
  6. Set up the environment properties.
  7. Run all migrations (knex migrate:latest).
  8. Invite the bot to the guild with necessary permissions.
  9. Move bot's role over all roles that are supposed to be granted by reacting to a message.
  10. Start the bot by running the command npm run prod.

Running

The bot is using PM2 and thus, it can be run under two different environments:

  • Production: npm run prod
  • Development: npm run dev

Inviting the Bot

As the bot has been built with keeping in mind it can be used in more than one Discord guild, other users can invite the bot to their server through the [p]join command. To make this possible, make sure you have enabled the Public Bot option in the Discord application settings. On top of that, the value of the invite configuration must equal to true (it is the default value as well).

If you want to use this bot just for yourself, disable the above-mentioned option in the Discord application settings, and change the value of the invite configuration to false.

Discord Intents

Botranktir needs both Presence and Server Members Intents to work flawlessly, as it is described in the installation process. Starting on 7th October 2020, using this bot without the Discord verification will not be possible if the bot is in more than 100 guilds.

Learn more about this topic here: https://support.discord.com/hc/en-us/articles/360040720412

License

This package is open-source and is licensed under the MIT license.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.