README.md

Nanami

A Discord bot for the Microsoft Community server that does.. a bunch of stuff. Modularly!

Setup

Use sudo on the global install commands where necessary.

npm install -g typescript@next rimraf npm-run-all
npm install
npm start

Requesting a feature

Open an issue in the issues tab.

Voice Channel Helper

This bot comes with a module named Voice Channel Helper. If you wish to create modules, you can use it as an example! It has a database file with the following schema:

CREATE TABLE channels (
    voice_id TEXT PRIMARY KEY,
    channel_id TEXT NOT NULL,
    set_to_purge INTEGER NOT NULL
);

As well as configuration options in the config.

The given database is currently set up to work with a private development server, so make sure you overwrite the entries with applicable entries for your own servers! :)

Creating a Module

It's pretty messy, at the moment.

To create a module you need to:

Create a class that extends Module in the Modules directory.
Then, export an interface with your module configuration options.
Add this configuration interface to the Config structure.
Update the config.json with a new object containing your module configuration options.
Push your module to the Module Collection in the initializeModule helper.

You're done!