Skip to content

README.md

Latest commit

 

History

History
34 lines (24 loc) · 1.66 KB

README.md

File metadata and controls

34 lines (24 loc) · 1.66 KB

forthebadge

Steam-Discord-Query-Bot

This bot's primary function is to query servers that are specified, obtain information about them, and update a Discord embed accordingly.

How to Setup the Discord Bot

  1. Create a Discord bot account. You can find more information on how to create a bot account here

  2. Download the program. You can do this by either downloading it as a zip and unzipping it, or running

    git clone https://github.com/zapdos26/Steam-Discord-Query-Bot.git

  3. Run pip install -r requirements.txt

  4. Open up configs/main.json.example and fill in the necessary information. Save this file as main.json.

  5. Run the discord_bot.py.

    • On Windows: py discord_bot.py
    • On Mac/Unix: python discord_bot.py

Congrats! You have set up the bot.

Add Server to Check

  1. Verify you have the Manage Channel(s) permission for where you want the Discord embed to be.
  2. Run the following !addserver [appid]
    • Ex: !addserver 127.0.0.1 1234 346110 would create an embed for the server with IP 127.0.0.1 and Query Port 1234 to the server list. The app id is necessary for the game's icon to show up.

Credits

Developers

License

Steam-Discord-Query-Bot is provided under the GNU GPLv3 License.

Contact

For any question, comments, or concerns, create an issue or open a pull request.