A bot inspired by our favorite neko from the Shaman King manga.

• discord.js - A powerful node.js module that allows you to interact with the Discord API.
• node.js - Is a JavaScript runtime built on Chrome's V8 JavaScript engine.

Requires Node.js v12+ to run.

Install the dependencies and devDependencies

$ cd MatamuneBot
$ npm install -d

Copy and Setup config file

$ cp config.sample.json config.json
$ touch config.json

{
	"prefix": "your-prefix",
	"token": "your-token",
	"ownerID": "owner-id-here", //For owner specific commands/functions
	...
}

To setup bot application and get token, visit here.

Setup Discord Embed defaults

{
...
	"embed": {
		"author": {
			"icon_url": "your-default-icon-here",
			"url": "your-default-url-here"
		},
		"fields": []
	}
...
}

The bot utilizes Sequelize with SQLite as its ORM. You can create as many databases as you want, but for our purposes, we are utilizing only 1. Create your database.sqlite file on /database folder or modify the /utility/database.js file to use your prefered database engine.

Modify the config and specify your database name

{
	"db": "your-db-here"
}

For multiple databases

{
	"db": {
		"db1": "db1-name-here",
		"db2": "db2-name-here"
	}
}

$ npm start

To generate an invite url, follow this guide

Generating an invite url with the proper scope and permissions should add a role, the bot App Name, to the bot upon joining your selected server. It should look like this.

Save the invite link in your config file for safe keeping.

{
	...
	"inviteUrl": "your-invite-url",
	...
}

The bot needs atleast the following permissions:

• SEND_MESSAGES - to send messages to a channel/s.
• VIEW_CHANNEL - to view a channel, which includes reading messages in text channels.
• READ_MESSAGE_HISTORY - to read past messages.

The config has the above permissions as defaults, they're needed to run most commands.

It is also important to note that the user issuing the commands has the required permissions. To check for the specific command permission requirements, do [prefix]help [command] [arg].

For more information about discord permissions, visit here.

• TBA

Want to contribute? Great! Matamune is an open source project, feel free to fork, clone & download! Join the discord for more info!

• Dynamic topic trivia
• User profiles & more!
• Add more commands!
• Unravel spaghetti

ISC