Code Monkey home page Code Monkey logo

aquarius's Introduction

Aquarius

If you run a Discord server and would like the bot, click here to add it!

A highly configurable Discord bot. ARX-7's younger sibling.

Development Guide

Setup

If you'd like to get a local version of Aquarius up and running, you'll need to do the following:

  1. Install PostgreSQL
  2. Install Node.js (v6+)
  3. Register a bot user on discord (https://discordapp.com/developers/applications/me)
  4. Add the bot to your server
  5. Create a .env file

Note when you're creating the Discord bot you'll need to convert your bot to a App Bot User account - it will warn you about the process being irreversible when you do this.

Once you have PostgreSQL installed, create a aquarius_dev database. You'll need to add the connection string to the .env file.

The .env file should look like the following:

TOKEN=[Discord "Token"]
CLIENT_ID=[Discord "Client/Application ID"]
OWNER_ID=[Your Discord User ID]
DATABASE_URL=postgresql://ianm@localhost/aquarius_dev

The bot should work across all OS environments and is controlled via the following npm scripts.

  1. $ npm start Starts the bot.
  2. $ npm test Runs the test suite.

Adding a new Command

Adding new commands is detailed in the wiki.

Adding Database Tables

We use Sequelize and the Sequelize CLI. To generate a table, you can run

$ node_modules/.bin/sequelize model:create --config ./.sequelizerc --name quotes --attributes name:string,quote:text

To migrate the changes, you can run

$ node_modules/.bin/sequelize db:migrate --config ./.sequelizerc

Enabling Commands

By default all commands are disabled. To enable a command, DM the bot and tell it

add <command_name>

To enable all commands, run

add all

Disable commands by using remove instead of add

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.