@aquarius-bot/messages v0.0.1

Aquarius is a general purpose Discord chat bot. If you have questions, concerns, suggestions, or need general assistance, please create an issue, tweet @IanMitchel1, or join Aquarius's Discord Server.

Overview

Aquarius is designed to be easy and intuitive to use for both users and new contributors. The goal is to reach feature parity with the mega-bots with much less code complexity. It is fully customizeable, allowing guilds to enable or disable commands in order to make the bot fit their exact needs.

Aquarius is written in Node.js and interacts with many different APIs and Services. It is hosted on Digital Ocean and uses a Google Firestore database.

Usage

For help using Aquarius, visit https://aquarius.sh/docs.

For generic help:

@Aquarius help

To add a command or plugin:

@Aquarius commands add <name>

Aquarius will prompt you with any additional information needed.

Community

Aquarius development happens on the Company Inc Discord Server - it's an active and diverse community that has far-ranging tastes. If you'd like to ask questions about Aquarius, learn more about programming, or have an idea for a new command come talk to us!

Join our Discord Server!

Announcements

Very rarely we'll announce new features or planned downtime in the Discord server linked above. You can follow to the announcement channel to receive these notifications.

Development

For help with local development of the bot, check the Getting Started Wiki Page.

If you are working on your own discord bot, Aquarius publishes several different packages that might be of interest.

• @aquarius-bot/discordjs-fixes - A library of fixes for the discord.js library.
• @aquarius-bot/loading - Helper methods to simulate loading on Discord.
• @aquarius-bot/messages - Helper methods for dealing with Message objects.
• @aquarius-bot/permissions - Helper methods and objects for dealing with Discord permissions.
• @aquarius-bot/progress-bar - A configurable progress bar to display in messages.
• @aquarius-bot/regex - A library of Regex patterns to use on Discord messages.
• @aquarius-bot/sentry - Wrappers to provide additional metadata in Sentry error reports.
• @aquarius-bot/triggers - A set of helpers that allow you to look for different bot command activation triggers.
• @aquarius-bot/users - Helper methods for dealing with User objects.
• jest-discord - WIP Jest integration.
• jest-discord-bot - WIP Jest integration.
• jest-discord-fakes - WIP Jest integration.
• jest-discord-environment - WIP Jest integration.