From 803a315d7181ca8f108b439b88343573ace2e0f2 Mon Sep 17 00:00:00 2001 From: Larry Date: Wed, 12 Jan 2022 23:22:47 -0700 Subject: [PATCH] Update Readme.md for version 1.0.6 --- README.MD | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.MD b/README.MD index 4aecd14..4cb72eb 100644 --- a/README.MD +++ b/README.MD @@ -15,7 +15,8 @@ In order to get a steam API key, you will need a domain to link it to. Trying lo ![image](https://user-images.githubusercontent.com/24533882/103162963-c9304000-47b4-11eb-814e-c6156649b908.png) -![image](https://user-images.githubusercontent.com/24533882/103163310-cd129100-47b9-11eb-955a-d7a334159e19.png) +![image](https://user-images.githubusercontent.com/24533882/149275986-27063a6e-f1b0-4c52-87f3-cf0a5f9fa77d.png) + # Creating a bot(s) **You must repeat this step for each server you wish to track.** @@ -32,13 +33,19 @@ After you have created your bot and named it, you will need to copy the bots `To ![image](https://user-images.githubusercontent.com/24533882/103163390-9ab56380-47ba-11eb-9c44-ec7f83343078.png) -![image](https://user-images.githubusercontent.com/24533882/103163287-9b99c580-47b9-11eb-82d6-296d00dcf6fd.png) +![image](https://user-images.githubusercontent.com/24533882/149276159-a350543f-3091-4632-9597-7f24f362fce1.png) # Configuring Server's After you have added your Steam API key, and your bot's token you must add the `botAddress`, this address is your query address for the server. This is so we know what game server's player count to display in the status of each bot. In order to configure the bot to display the player count, you must add the IP, and the Port in the format `Address:Port` ex. `23.23.233.233:27015` where `127.0.0.1:2532` is located. This address is **NOT** the connection address. -![image](https://user-images.githubusercontent.com/24533882/103163337-14008680-47ba-11eb-86eb-94c8f66d49ff.png) +![image](https://user-images.githubusercontent.com/24533882/149276263-edc7a259-9751-4125-84c9-e949cad7324a.png) + +### Please note: + +You may use `localhost` or `hostname` as your server address for the application to automatically resolve the hosts IP. +![image](https://user-images.githubusercontent.com/24533882/149276420-04551e2b-7516-437b-960c-f2493463325d.png) + # Invite Your Bot After all configuration steps have been taken, we must start the bot and invite them into our discord. The bot needs no special permissions due to it's responsibility being to update it's status. In order to invite your discord bot, you must replace `{clientID}` with your bots client ID in the URL below, this means you must also remove the curly braces too. If you do not know where to obtain your bot's client ID, navigate to `General Information` tab on the Discord Developer Portal the bot you wish, and copy your Client ID from there. @@ -46,6 +53,8 @@ After all configuration steps have been taken, we must start the bot and invite ``` https://discord.com/oauth2/authorize?client_id={clientID}&scope=bot ``` +# Docker Support +### TBD # Issues All logging is tied behind _isDebug variable in the Config.json. Please report any issues to [Issues tab](https://github.com/GravityWolfNotAmused/PlayerCountDiscordBot/issues).