fixing indents

Merge branch 'testing' of https://gitlab.rickelobe.com/Bots/r0b3BOT into testing
not properly handling non jason response
2021-04-04 15:01:48 -04:00 · 2021-04-04 14:54:55 -04:00 · 2021-04-04 14:54:38 -04:00 · 2021-03-23 19:11:00 -04:00 · 2021-03-22 14:40:18 +00:00 · 2021-03-22 00:10:35 +00:00
14 changed files with 838 additions and 56 deletions
@@ -4,3 +4,6 @@ stages:
 deploy:
    stage: deploy
    script: /var/lib/gitlab-runner/deploy_r0b3bot.sh
+    only:
+      - dev
+      - master
@@ -2,11 +2,20 @@

 [![pipeline status](http://gitlab.rickelobe.com/Bots/r0b3BOT/badges/master/pipeline.svg)](http://gitlab.rickelobe.com/Bots/r0b3BOT/commits/master)

-# Screenshot
-![](images/Discord_Printstat_Command.png)
-
 # Description
-This is R0b3's Discord Bot.  It's creation was basically a challenge posed a coworker who said "Hey, you can write Discord Bots in Python... Make one to display your 3D printer status!".
+This is R0b3's Discord Bot.  It's creation was basically a challenge posed a coworker who said "Hey, you can write Discord Bots in Python... Make one to display your 3D printer status!".  But as time went on, a few more features were added.  Aside from being able to query and monitor your 3D printer, it can also fetch the current status of a service monitroed by your [StatPing](https://github.com/statping/statping) instance.  In addition to just fetching the current status of a service, you can subscribe to receive alerts for any StatPing service state change.  All subscriptions are persistent and will remain even after the bot is restarted.
+
+# Features
+*  Query & Monitor 3D Printer Status using `$printstat` command(Requires that your printer is connected to [Octoprint](https://octoprint.org/))<br>
+![](images/Discord_Printstat_Command.png)
+*  Query serivces states on StatPing using the `$spstatus`
+*  Use `$spsub` to "Subscribe" to service change alerts for StatPing services.  Subscribed alerts are persistent and are not lost on bot restart.<br>
+![Example service alert](images/Service_alert.png)
+*  Use `$mmrsub` to "Subscribe" to a League of Legends handle's Ranked Average.  As with the StatPing feature, the subscriptions are persistent.
+*  Play a selection of sound clips to voice channel members using the various commands (`$torololo`, `$oops`, `$promoted`, etc)
+
+# Commands
+![Screenshot of $help](images/command_list.png)

 # Requirements
 1. discord.py version 1.2.4 or greater<br>
@@ -14,6 +23,6 @@ This is R0b3's Discord Bot.  It's creation was basically a challenge posed a cow

 # Configuration
 1. Create a Discord Bot via Developer tools<br>
-2. Enter various configuration parameters in bot_config.conf.example<br>
+2. Enter configuration parameters in bot_config.conf.example<br>
 3. Enter OctoPrint config parameters in octoapi.conf.example<br>
-4. Rename *.example files as *.conf<br>
+4. Rename *.example files as *.conf and setup your config<br>
@@ -3,14 +3,23 @@
 # Replace the placeholders with your information.  Do not use quotes.
 #
 #   discord_auth_token   - this is the bot token generated via the Discord development console.
+#   bot_command_prefix   - The prefix used identify commands for this bot
 #   hass_url             - URL to your home assistant instance.  This is used to turn on the light by your 3d printer
 #   hass_token           - Long Lived Access Token used to authenticate with the REST API for your Home assistant instance
 #   hass_light           - Entity name of the light you want to control
 #   octoprint_ip_address - IP Address of you OctoPrint (or OctoPi) host.  Used to get 3D printer stats.  
+#   statping_url      - Server hostname of the StatPing instance we will be querying w/ the REST API
+#   statping_api_key     - API Key for Statping to query for service status
 #
 discord_auth_token = <Discord Auth Token>
+bot_command_prefix = <!/$/#/etc>
 hass_url = <URL to HomeAssistant>
 hass_token = <HomeAssistant Long Lived Access Token>
 hass_light = <Entity_ID of the light @ your printer>
 octoprint_ip_address = <OctoPrint IP Address>
-
+statping_enable = <trues/false>
+statping_url = <Statping URL>
+statping_api_key = <Statping API Key>
+mmr_checker_enable = <true/false>
+mmr_checker_interval = <number of seconds between checks>
+mmr_api_url = <MMR API URL>