Map History Bot

A Simple Discord / A2S Bot
Explore the docs 📖 Report Bug 🐛 Request Feature ✋ Latest Release 📥

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• Contact

About The Project

This is a simple implementation of a discord bot using A2S to query Source (Steam) Game-Servers for Maps.

Built With

• Discord.py
• Python A2S

Getting Started

1. Clone the project
2. Edit your configuration.json
3. launch main.py

Prerequisites

Youll need the following packages and Python 3.9.7 in order to run the bot:

• discord.py

pip3 install discord.py

• python-a2s

pip3 install python-a2s

• jaraco.docker

pip3 install jaraco.docker

Installation

1. Get a discord Bot free Token at Discord Developer Portal, you can follow this guide by the Discord.py team
2. Clone the repo and create a configuration.json

gh repo clone immervoll/maphistory-bot

{
    "TOKEN": "",
    "PREFIX": "!",
    "SERVER": {
        "IP": "",
        "PORT": 27165
    },
    "INTERVAL": 600.0
}

3. Install all the required packages

pip3 install -r requirements.txt

4. Enter your Token in configiguration.json

"TOKEN": "your token here",

5. Enter your Server IP and PORT in configiguration.json

    "SERVER": {
        "IP": "194.26.183.182",
        "PORT": 27165
    }

6. Invite the Bot to your discord via the Discord Developer Portal
7. Profit 💯

Usage

use !history or !maps on your discord in order to display the last 10 Maps

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Immervoll - @immervoll

Project maphistory-bot: https://github.com/immervoll/maphistory-bot