Code Monkey home page Code Monkey logo

gagbot.js's Introduction

gagbot.js

GaGBot is a utility bot for discord servers, written in JavaScript for Node.js

To get the latest stable release, check out the releases page.

Features

  • Module Loader - GaGBot can dynamically load modules that define new commands and events, making implementing custom features a breeze! (r20.1.0)
  • Permissions - Fine-tune access to custom commands with simple permission nodes per role. (r20.1.0)
  • Greet Module - Send new users a welcome message when they join the server. (r20.2.0)

Upcoming Features

  • Admin Module - Commands for managing the server, e.g. purging channels, muting users, and so on.
  • Reaction Roles - Allow users to assign themselves specific roles by reacting to messages.

Got a good idea? Open an issue and start the discussion!

Alternatively, you could contribute to one of these features! Look for open issues that are awaiting your action.

Getting Started

Prerequisites

  • Install git
  • Install node, version 14.0.0 or later
  • Install npm
  • A MongoDB server.

Installation

  1. Create a Discord Application and get a Bot Token
  2. Invite the bot to your server.
  3. Clone the repo or grab a stable release (recommended)
  4. Install the bot
  cd /gagbot.js
  npm install
  1. Create an environment variable named DISCORD_TOKEN, and set it to your bot's token.
  2. Add your MongoDB connection string to an environment variable named MONGO_DB_URI.
  3. Run the bot. If all goes well, you'll see the modules being loaded, followed by a message that your bot has logged in to Discord.
  npm start
  1. You can test your bot using the gb!ping command in your server chat, which is included in the core module.

  2. Configure GaGBot!

Built With

Versioning

We use MAJOR.MINOR.PATCH semantic versioning in two different flavours. One for versioning code, and the other for releases. For more information, visit the wiki.

The latest stable release is r20.1.0.

Contributors

License

This code is licensed under the ISC License - see LICENSE.md for details.

gagbot.js's People

Contributors

kylrs avatar

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.