LFGScout

About

LFGScout is a Discord bot designed to monitor and notify when members of a guild start playing a specific game. The bot uses the Disnake (a Python wrapper for the Discord API) and SQLite3 for database management.

Features

• Monitor members' game activities in real-time.
• Notify a specified channel when someone starts playing a watched title.
• Admin commands to configure the notification channel and watched titles.
• Users can opt-out of notifications.
• Cooldown feature to prevent spamming notifications.

Setup & Installation

1. Clone the repository:

   git clone https://github.com/DJStompZone/LFGScout
   cd LFGScout

2. Set up a virtual environment (recommended):

   python3 -m venv venv
   source venv/bin/activate
   # On Windows use: venv\Scripts\activate

3. Install the required dependencies

   pip install -r requirements.txt

4. Configure your environment

   Copy the example.env file to .env and fill out the DISCORD_TOKEN and TEST_GUILD_IDS with appropriate values.

5. Run the bot

   python bot.py

Commands

Admin Commands:

• /lfgchannel <#channel>: Set the channel where notifications will be sent.

• /watchtitle <title>: Add a game title to the watch list.

• /unwatchtitle <title>: Remove a game title from the watch list.

User Commands:

• /optout: Allows a user to opt out of LFG notifications.

Contribution

Feel free to fork the project, make some improvements, and submit a pull request.

Issues & Bug Reports

Found a bug? Just create an issue and describe the problem. You can also join the StompZone Discord to see the bot in action or join our growing community.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

Disnake

A Python wrapper for the Discord API.
Docs | GitHub | Discord

SQLite

A C-language library that implements a small, fast, self-contained, high-reliability, full-featured, SQL database engine.
Homepage