Skip to content

Latest commit

 

History

History
111 lines (72 loc) · 3.22 KB

BUILDING.md

File metadata and controls

111 lines (72 loc) · 3.22 KB
Raw

Building ShrekBot

Installing prerequisites

The instructions below installs:

Microsoft Windows

Microsoft Windows 7 or later is required

Chocolatey

  1. Follow the installation steps on docs.chocolatey.org/choco/setup.

  2. After installation, run the script below.

choco install nodejs git

Scoop

  1. Follow the installation steps on lukesampson/scoop.

  2. After installation, run this scrpt below.

scoop install nodejs git

macOS

macOS Mojave (10.14) or later is required

Homebrew

  1. Follow the installation steps on brew.sh.

  2. After installation, run this script below in a terminal.

brew install node git

Linux

Installing prerequisites via built-in package managers

Distribution Command Package Manager
Arch Linux / Manjaro sudo pacman -S nodejs git pacman
CentOS / RHEL sudo yum install nodejs git yum
Debian / Ubuntu sudo apt install nodejs git apt
Fedora sudo dnf install nodejs git dnf
Gentoo emerge net-libs/nodejs dev-vcs/git portage

Getting the files / Cloning shrekbot

  1. Open a Terminal (Command Prompt, Terminal.app, etc.)
  2. Change the current working directory to the location where you want ShrekBots folder to be (git will auto create a folder called shrek-bot)
# This command below will change the current directory to the Desktop!
cd Desktop/
  1. Type the command below
git clone https://github.com/BiizoNinja/shrek-bot.git
  1. Press the Enter Key to execute the command (Don't close the terminal yet!)
$ git clone https://github.com/BiizoNinja/shrek-bot.git
> Cloning into `shrek-bot`...
> remote: Counting objects: 10, done.
> remote: Compressing objects: 100% (8/8), done.
> remove: Total 10 (delta 1), reused 10 (delta 1)
> Unpacking objects: 100% (10/10), done.

Setting up ShrekBot

  1. Run the command below
# This will change your directory to "shrek-bot" then will install the packages required to run ShrekBot!
cd shrek-bot && npm install
  1. Replace TOKEN with the bot token you obtained from the Discord Developer Portal
echo "BOT_TOKEN = 'TOKEN'" > .env
  1. Run the command below to run shrekbot!
node .

After this the bot should be online. If you have any problems feel free to ask in our discord server. Or if you do not want to do all this, we recommend inviting the public version.