README.md

LiveUnderflowBot

A bot to monitor LiveOverflow's minecraft server using discord.

Current Features

• beacon monitor
  • mining alerts
• view the server world from a browser.

Setup

Installation

Clone repository and run

npm install

in the project root directory to install node packages.

Configuration

Create src/secrets.json with contents:

{
    "token": "...",
    "botid": "...",
    "outputChannels": [
        "..."
    ],
    "inputChannels": [
        "..."
    ],
    "connectionData": {
        "host": "some.ip.or.domain",
        "port": 25565,
        "username": "Player",
        "password": "password",
        "auth": "microsoft"
    },
    "viewerPort": 3000
}

• "token": The Discord bot token (string).
• "botid": the user ID (string) of the Discord bot.
• "outputChannels": List of Discord channel IDs (string) the bot should send it's messages to.
• "inputChannels": List of Discord channel IDs (string) to listen for bot commands.
• "connectionData": Connection and login data for the Minecraft bot.

Connection data

When logging in to a server in offline mode, any username can be chosen and the password can be left empty.

When logging in using a Microsoft account the username has to be your Microsoft account email and the password the Microsoft account password. The optional "auth" field also has to have the value "microsoft", otherwise it will try to log in using a mojang account.

When logging in using a Mojang or Legacy account, the username has to be your account email or player name and the password your Mojang account password. The "auth" field has to be empty or set to "mojang". (Also you should migrate your account)

Running

Run the project from the project root directory:

node .