westrany / Lotro-Server-Status-Discord-Bot

A bot for Discord servers that updates you with server status for the Lord of the Rings Online mmorpg
MIT License
0 stars 0 forks source link

Lotro Server Status Discord Bot

A Discord bot built to monitor and provide updates on the server statuses for the game Lord of the Rings Online (LOTRO). The bot allows users to check server statuses, monitor server changes, and receive real-time notifications when server statuses change.

πŸ”—πŸ€– Add this bot to your Discord server here! πŸ€–πŸ”—

Update 24 Sep 2024: bot seems to be working as inteded (I recommend adding /monitor to it's own dedicated channel). New features added: bot now tracks status for Bullroarer and I added a /stop command that you can use in the same channel as /monitor to stop the auto monitoring server status updates

image

Index

  1. Features
  2. Technologies Used
  3. Getting Started
    3.1. Prerequisites
    3.2. Clone the Repository
    3.3. Install dependencies with NPM install
    3.4. Environment Variables
    3.5. Bot Commands
  4. How to Run the Bot Locally
  5. Commands Overview
    5.1. /status
    5.2. /monitor
  6. Known Issues
  7. Contributions
  8. License
  9. Acknowledgements
  10. Final Notes

Features

image

Technologies Used

Getting Started

Prerequisites

To get started, you’ll need:

Clone the Repository

git clone https://github.com/yourusername/Lotro-Server-Status-Discord-Bot.git

Install dependencies with NPM install

npm instal

Environment Variables

Create a .env file in the root of the project and add the following environment variables:

DISCORD_TOKEN=your_discord_bot_token
DISCORD_CLIENT_ID=your_discord_application_id
DISCORD_APPLICATION_ID=your_discord_application_id

Bot Commands

The bot offers the following commands:

  1. /status: Check the status of LOTRO servers.

    • Optional server argument to check the status of a specific server.
  2. /monitor: Enable real-time monitoring of LOTRO servers.

    • The bot will notify you when servers go down or come back up.
    • Can only be called in 1 channel per Discord server.
  3. /stop: Disable the real-time monitoring of LOTRO servers.

    • Use on the same channel where you called /monitor.

How to Run the Bot Locally

  1. Register Commands (only needed when setting up or updating commands): To register commands globally, run: node register.js

  2. Start the Bot: To run the bot locally, use the following command:
    npm run start The bot will now be live and ready to interact in your Discord server.

Commands Overview

/status

Description: Check the status of all LOTRO servers or a specific server.

image

image

/monitor

Description: Starts monitoring the status of LOTRO servers. The bot sends notifications when server statuses change.

image

/stop

Description: Stops monitoring the status of LOTRO servers. Use in same channel as /monitor.

image

Known Issues

  1. Bot is currently being hosted for free on FPS. This means that I have to manually click on a button to add more running time to the bot (so if the bot is suddently offline my depest apologies). I am working on a better alternative.

  2. I can't really tell if /monitor is working as intended since servers don't seem to go up and down all the time. Any feedback on this is very much appreciated!

Contributions

Feel free to fork this repository and submit pull requests. Issues and feature requests are always welcome!

License

This project is free to use under the MIT Licence. Just remember to give credit where credit is due!

Acknowledgements

A very special thanks to dt192 for helping me brainstorm, structure and debug this bot.

Final Notes