Installation

Prerequisites

• Git
• NodeJS >= 14
• Yarn >= 1.2
• A Minecraft account
• PM2 (Optional)

Initial setup

To get started, clone down the repository using:

git clone https://github.com/itsneyoa/fragrunning-bot.git

Next go into the fragrunning-bot folder.

cd fragrunning-bot

Then install all the dependencies using Yarn.

yarn

Create a new file called config.json in the root of the project, open it and refer to the Configuration section to set it up.

Running

Using PM2

Installation

This will install the process manager globally.

npm install pm2 -g

Starting the bot

The name is optional, however helps to clean up the running processes list.

pm2 start index.js --name "Fragrunning-Bot"

Checking logs

pm2 log Fragrunning-Bot

Stopping, starting and restarting the bot

The bot will run even if you close the terminal window unless you kill the process or turn off the host machine.

pm2 stop Fragrunning-Bot

pm2 start Fragrunning-Bot

pm2 restart Fragrunning-Bot

Standalone

The bot will run as long as the terminal window is open for. All events are logged directly into the terminal window.

node .

To stop either close the terminal window or press ctrl + c.