NOTE: I've decided to put this project to rest, after getting busy with other stuff and not having the time to continue this project (which I imagine would need major changes as well after the updates to Discord's API since I last worked with it).

Overview

Citrine is a powerful, and highly extensible Discord bot.

(I'll add more later. If you wanna help with this or other docs stuff, feel free)

Installation

The docs and installation guides aren't ready yet, but here's a quick guide on installation and setup. You should have Node.js (version 10 or above) installed, and preferably git.

If you want to spend minimal time on set-up, clone/download the stable branch, which contains only the transpiled code. By default, Citrine will store data in memory (meaning all your settings will be lost after the bot shuts down), but it has support for SQLite-based persistence (more will be added later on) with the help of Keyv.

For SQLite, you'll have to install additional packages: npm install keyv @keyv/sqlite

Then, open ./bin/citrine.js and edit the options for the CitrineClient:

const options = {
    // Edit the DbProvider option and set it to 'SQLiteKV'
    DbProvider: 'SQLiteKV'
}

And that's about it. Run the launcher file and it will ask for your bot token and the prefix (which can be changed later, of course). The launcher will then create the necessary files needed to run Citrine. Once it's finished, you should have a start_citrine file in the folder. You can start citrine using that file, or using the launcher, or entering npm run citrine in the console, or entering node ./bin/citrine.js in the console.

If you have any troubles, feel free to join the support server for help.

Contribute

See note at the top.

Citrine is still in development stages. Testing, built-in Chips, documentation, installation & usage guides, and much more still needs work. If you feel like contributing, feel free to open a PR, or drop by at the support server!.

License