Skip to content

How to Install

Jump to bottom
Earnest Angel edited this page Feb 27, 2024 · 12 revisions
Web Installer is now out ⭐ might make your life a bit easier 😊

Requirements

Before starting, you'll need a couple of things:

  1. Install these software into your server/pc:
  2. Of course, your own Discord bot tokens. Create a bot here if you still didn't have one: Discord Developer Portal — My Applications. Create a new application, and bot for the new application.
  3. Your own OpenAI or NLPCloud API keys. Get OpenAI key here: Sign Up for OpenAI) OR NLPcloud Sign Up for NLPCloud)
  4. A MongoDB server OR cloud. Get it here: MongoDB Cloud Database (Official). Then get the URI / connection string. They looks like this: mongodb+srv://yourownuser:[email protected]/?retryWrites=true&w=majority
  5. LTS version of Node.js: Download | Node.js (nodejs.org)
  6. Twitch Client ID and Client Secret. Get it here: Twitch Developers - Twitch API v5
  7. (optional) Genius token - if you want the lyrics feature: http://genius.com/api-clients
  8. (non-optional) A little bit of patience. Keep calm and learn to ask for help. Read the instructions properly, ⚠️ DO NOT SKIP A SINGLE PART. No matter how smart you think you are⚠️

Download and Setup

Step 1: Clone the project

There are two choices to download the files. Use the git command. Skip this if you already have the files.

  git clone https://github.com/RirikoAI/RirikoBot.git

OR Use the npx command:

  npx ririko RirikoBot

OR Just download the zip files from the releases page: Releases · RirikoAI/RirikoBot (github.com)

Step 2: Go to the project directory and install the dependencies

Open your command prompt and change directory to where you downloaded / cloned Ririko:

  cd RirikoBot

Install the dependencies (including the dev dependencies):

  npm install --dev

Step 3: Configure settings - Using Web Installer

  1. Copy .env.example into .env
  2. Run the bot to open the Web Installer npm run start:dev
  3. Follow the tutorial on the Web Installer

Alternatively, you can also configure the config file manually, by copying config.example.js into config.js.

Also good to note that .env file will override config.js file (for deployments). Upgrading to a major version (e.g from 0.13.0 to 0.14.0) will require a reconfiguration.

Step 4: FFMPEG for Linux users

FFMPEG is required to be installed manually on Linux-based distros. Please follow these steps to get the Music bot working: (For Ubuntu/Debian based distros)

apt install ffmpeg
npm uninstall ffmpeg-static
npm uninstall ffmpeg
npm update

Step 5: Start the server

  npm run start

Generally, if you've reached to this point, the bot should work already. It is also advisable to run the bot in production mode:

npm run build
npm run start:prod

Good luck, and enjoy!

If you believe there is a bug in the codes, please report them here: New Issue · RirikoAI/RirikoBot (github.com)

Clone this wiki locally