Get Started

The first thing you need to do to use MatrixCord is ensure you're creating a MatrixClient rather than the regular discord.js Client (opens new window). A MatrixClient is just an extension of the CommandoClient (opens new window), so all options, properties, methods, and events on CommandoClient are also on MatrixClient.

You can provide the color option to the constructor, which is an option specific to MatrixClient, and should be set to an valid HEX color code. This will set the default color for all embeds used in MatrixCord's default commands.

Then, to make use of the multipurpose framework, you need to register Commando's default argument types, default Groups and MatrixCord's default commands, in addition to any of the built-in stuff that you want make use of. This will look something like this:

MatrixCord has a build-in color configuration per-guild. In order for this to persist across restarts, you should use a SettingProvider. You can find more information's and how to use a SettingProvider in the documentation of Commando (opens new window).

Finally, you must log in, just as if you were using a regular Client.

client.login('token goes here')