Skip to content

Bot.Discord

The Web UI module is a supplemental service to the PEON project.

This is a Discord bot to manage orchestrators.

RELEASED

Design Objectives

  • Non-programmer friendly

Software Stack Diagram

Software Stack

Dev Notes

Improved bots

interactions.py

Links to various project-related resources.

GitHub GitHub GitHub GitHub

Features

  • 🛠 All basic server control functionality (start, stop, restart...)
  • 🛠 API calls respond with builder/based on cards (embeds)

Roadmap

  • CHANGED 🛠 Bot is re-written for slash commands (see interactions.py)

Release Notes

  • ADDED 🆕 !save to share a zipped copy of the user's folder (for backup)
  • ADDED 🆕 !restore upload a user's save folder to be restored to the server.
  • ADDED 🆕 !modify the settings of a server

2.0.0 - DEVELOPMENT

âš¡ IMPACT RELEASE âš¡

  • ADDED 🆕 Deploy server from discord
  • CHANGED 🛠 Updated response of getall to be like import as we are starting to hit character limits

  • ADDED 🆕 !deregister to remove an orchestrator

  • CHANGED 🛠 âš¡ Reworked entire bot interaction/behaviour âš¡

  • ADDED 🆕 !update *full/*image/*server/*reinit to allow for granular server updates (full is default)

  • ADDED 🆕 !register to link the Discord bot to additional orchestrators

  • ADDED 🆕 !refresh to trigger updating the plans on the orcs
  • ADDED 🆕 Port usage details
  • ADDED 🆕 !import available warcamps.
  • ADDED 🆕 Container type and version information into response.
  • ADDED 🆕 Command !get time will now return just the shutdown time (if any)
  • ADDED 🆕 Get version number from Orc (API required)
  • ADDED 🆕 Get specific plan details.
  • ADDED 🆕 Get a list of available plans.
  • ADDED 🆕 An !about bot directive with version details and links.
  • ADDED 🆕 VERSION environment variable
  • CHANGED 🛠 Moved several modules around and renamed several files to be more dev friendly.
  • CHANGED 🛠 Fail on !stop * if invalid timevalue provided
  • CHANGED 🛠 Removed internal settings.json in favour of environment variables.
  • CHANGED 🛠 Reworked the MOTD
  • CHANGED 🛠 Completed admin/user flow
  • CHANGED 🛠 Reworked entire server filtering flow
  • BUGFIX 🪲 Servers with same/different game are overwriting each other
  • BUGFIX 🪲 Fixed an issue where the control channel wasn't being informed when the bot connected.
  • BUGFIX 🪲 Fixed an issue where the plans were not being collected from the orchestrator correctly.
  • BUGFIX 🪲 Fixed an issue with the !getall command

1.2.7

  • BUGFIX 🪲 Fixed an issue where the local orc's API key would not be updated in the config file.

1.2.6

  • CHANGE 🛠 Built on the latest python/package codebase

1.2.5

  • CHANGE 🛠 Updated to latest OS/package combinations.

1.2.4

  • TYPO 🪲 Fixed a bad response example in !usage command

1.2.3

  • ADDED 🆕 Usage response

1.2.2

  • ADDED 🆕 Update game server command.

1.2.1

  • BUGFIX 🪲 Fixed an issue with the regex matching for a minute interval (would match any possible string)

1.2.0

âš¡ IMPACT RELEASE âš¡

  • CHANGED 🛠 Added language localization. Completely re-wrote messaging language module.
  • CHANGED 🛠 Moved localization files to /app/reference/
  • CHANGED 🛠 Moved from /api/1.0 to /api/v1
  • ADDED 🆕 Get a list of available game plans

1.1.0

âš¡ IMPACT RELEASE âš¡

  • CHANGED 🛠 Moved logging into container logs
  • ADDED 🆕 Added DEV_MODE flag to enable/disable logging/dev mode.

1.0.1

  • BUGFIX 🪲 Auto append minute time unit to request, if no time unit is provided.

1.0.0

  • CHANGED 🛠 Improved data response legibility on get.
  • CHANGED 🛠 Updated bot to handle changes to the Orc API (since Orc release v1.0.1)
  • REMOVED ✂ Removed dev_mode switch

âš¡ IMPACT RELEASE âš¡

0.2.8

  • CHANGED 🛠 Messaging - Reworked error messages
  • BUGFIX 🪲 Scheduling past event times.

0.2.7

  • ADDED 🆕 Added shutdown scheduler

0.2.6

  • CHANGED 🛠 Better natural language support

0.2.5

  • ADDED 🆕 Added aliases for commands

0.2.2

  • CHANGED 🛠 Reformatted info in the message feed
  • ADDED 🆕 Server_Config - Allowed for json formatted content

0.2.1

  • ADDED 🆕 Discord - Added message cleaner clear [int]

0.2.0

  • ADDED 🆕 Orc - control start/stop/restart

0.1.1

  • ADDED 🆕 Added devMode switch

0.1.0

  • ADDED 🆕 First version of the bot
  • ADDED 🆕 Basic get-all/get the functionality
  • SECURITY 🔓 Hardcoded bot key

0.0.0

  • INITIALISED ✈ Initial commit