Skip to content

JonathanFeenstra/discord-modlinkbot

Repository files navigation

discord-modlinkbot

License Code style: black

A Discord bot for linking Nexus Mods search results.

Features

Retrieve search results from Nexus Mods for search queries in messages {between braces, separated by commas}, outside of any Discord markdown or spoiler tags, each query being between 3 and 100 characters in length. Queries cannot contain any of the following characters: \";:=*%$&_<>?`[]{}.

example1 example2

This functionality is based on u/modlinkbot on Reddit and the Nexus Mods Discord Bot quicksearch command. In addition, games to search for can be configured per server or channel by using commands.

Detailed descriptions of commands and their usage are provided by using the .help command.

Self-hosting

Configuration

Make a Discord bot account and enable the server members and message content intents. If you wish, you can use the included icon image for your bot. Create a config.py file in this directory and fill it in according to the example. Add the bot to a Discord server to make use of its features.

Local installation

The bot requires Python 3.11 and the libraries specified in Pipfile, which can be installed using pipenv:

pipenv install

The following command will start modlinkbot:

pipenv run bot

Docker

Alternatively, the bot can be deployed in a Docker container:

docker-compose up