Alfie - TruckersMP Info Discord Bot

Overview

Alfie is a small yet modern companion for getting TruckersMP information straight to your Discord server.
This bot is free to add to your server or if you'd prefer, you can host your own instance.
Invite to your server: Click here!

Why Alfie?

• Implements Discord's latest features (eg. slash commands, autocomplete)
• Requires little permissions (no administrator in Discord)
• Nice-looking and clear responses
• Simple; just add to your server and it works
• Cute name & open source

Features

Dynamic Choices: not quite sure on the server name?

Smart Search: not sure how to spell something?

Responses: clean, detailed & modern

Deployment

Using the official, hosted version of Alfie bot is the easiest, recommended and my preferred way for you to use the bot. Simply invite the bot to your server using the link in the overview.
However, if you still wish to deploy your own instance, please see the instructions below.

1. Ensure you are running Python 3.11 (Alfie is untested in other Python versions, but may still work).
2. Set up a virtual environment using venv and install the dependencies.
   To setup venv: py -m venv venv (See docs for more)
   Install dependencies: pip install -U -r requirements.txt
3. Rename config.py.example to config.py and modify where applicable.
4. Rename .env.example to .env and modify where applicable.
   Get token from the Discord Developer Portal.
   Get a Steam API key here.
   Sentry support is optional, the variable can be left empty.
5. Run the bot using py main.py.

License

Released under the GNU GPL v3 license.

This project makes use of the following packages, which are distributed under the MIT & GPL-2.0 Licenses:

• interactions.py
• aiolimiter
• TheFuzz
• Async-TruckersMP

Credits

Alfie relies on the following APIs:

• TruckersMP
• TruckyApp