Shaii Self host Tutorial

Introduction

On this wiki, we want to give you a tutorial about how to host Shaii on Windows & Linux machine.

Disclaimer

We are assuming that you already understand any of these, so if you got any errors then you should know what the current error you just occurred. You should fix the error by yourself. We DON'T provide direct installation support.

Prerequisite (On any machine)

• Runtime Environment (Required)
  • Node.js (v16.9.0 or newer)

  We recommend to use the latest LTS (Long-term Support) version.

• Multimedia Library (Required)
  • ffmpeg

  We don't recommend using ffmpeg-static, because ffmpeg-static is not stable.

• Main Node.js Library (Required)
  • discord.js (v14.11.0) npm install discord.js@14.11.0
  • distube npm install distube@latest
  • dotenv npm install dotenv@latest
  • @discordjs/voice npm install @discordjs/voice@latest
• Opus Encoding Library (Required)
  • @discordjs/opus npm install @discordjs/opus@latest
• Encryption Packages (Only choose ONE)
  • sodium npm install sodium

  Hard to install, but it's better than libsodium-wrappers

  • libsodium-wrappers npm install libsodium-wrappers

  Easy to install, but not good as sodium

  • sodium-native npm install sodium-native@latest

  Easy to install, but not good as libsodium-wrappers

• Other Dependencies
  • @discordjs/rest (Optional) npm install @discordjs/rest

  The @discordjs/rest dependency is for enabling the slash command feature. This dependency is optional to be installed, but if you want to use the slash command feature, this dependency MUST be installed.

  • @distube/yt-dlp (Required) npm install @distube/yt-dlp
  • @distube/spotify (Optional) npm install @distube/spotify
  • @distube/soundcloud (Optional) npm install @distube/soundcloud
  • bufferutil (Optional) npm install bufferutil
  • erlpack (Optional) npm install discord/erlpack
  • utf-8-validate (Optional) npm install utf-8-validate
• Process Management (Optional)
  • If you want to make the bot run 24/7 (non-stop), you can install this dependency by typing npm install --global pm2 in your console

Installation Steps (Windows)

1. All prerequisites MUST be done at first.
2. Download the .zip file from Releases page. If you want to choose the stable version (production ready), download the file that has Latest tag. For the unstable version (non-production ready), download the file that has Pre-release tag.
3. After the file got downloaded, then you should extract the .zip file.
4. After extracting the file, now, you should edit the .env file first (bot token & prefix), and after you edit it, you can do a test run by typing node index.js command on your console.
5. To make the bot run 24/7, first, you can type pm2 start index.js --name "Your Bot Name" command on your console.

Installation Steps (Linux)

Coming Soon!