Miki Discord Bot
Clone or download

README.md

Miki

lol oily fucked up Codacy Badge
Below you will find a basic workflow of how the branches should work. Please follow this to prevent bad merge conflicts on Miki and things constantly breaking.

Table of contents

Workflow for branches

Useful links

Getting Started

Useful links

Bot invite: https://discordapp.com/oauth2/authorize?&client_id=160185389313818624&scope=bot
Documentation: https://github.com/velddev/Miki/wiki
Issues: https://github.com/velddev/Miki/issues
Patreon: https://www.patreon.com/mikibot
Support server: https://discord.gg/39Xpj7K

Feature requests

Go to Suggestions.Miki.ai

Getting Started

Yes, in its current state this process is tedious. However, there will be an installer in the future that will make getting started much simpler.

Important:

Currently the Miki API is private, meaning you won't have access to the leaderboards until the API is released publicly. More information will be available here when that happens.

If you have any questions about the setup process do not ask in the support server, as a majority of the people there will not be able to assist you. DM Xetera#9596 for questions instead.

Installation Steps:

  1. Clone the Miki repository.

  2. Install Miki.Framework and Miki.Rest through NuGet or clone them as well, along with the other dependencies.

  3. Add your bot token in Miki/miki/settings.json.

  4. Download RabbitMQ and have the service running.

  5. Download Redis and get that running too.

  6. Download PostgreSQL and set up a database called Miki.

  7. Configure your connection string in Miki/miki/settings.json as such (if using localhost):

"connection_string": "Server=127.0.0.1;Port=5432;User Id=postgres;Database=Miki;"
  1. Install the uuid-ossp postgres extensions on the Miki database.
CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
  1. Run existing migrations inside the base Miki solution through the NuGet Package Manager Console with Update-Database

    • Tools -> NuGet Package Manager -> Package Manager Console
  2. Clone the gateway repository in a separate location.

  3. Download Node.js if you don't have it installed already.

  4. Run npm install in the sharder download location to setup the dependencies.

  5. Create a config.js by copy pasting the format from config.js.example and filling in your bot token.

  6. Run node gateway.js.

  7. Run Miki. 🎉

Possible issues:

These will likely be fixed in the near future (if it's not already by the time you're reading this):

  • A lack of API keys might be giving you issues in the DonatorModule and FunModule, the simplest way to solve it is to just comment out the lines that raise exceptions and the lines that reference the client (there shouldn't be more than 2 reference max, if so, you're doing something wrong).

  • If you're having trouble running migrations make sure your EntityFramework for both base Miki and Miki.Framework is on version 2.0.1-2.0.3 NOT 2.1.1.