Maple Bot (Grendel)

Description

Grendel is a discord bot.

It is meant to provide information about Maplestory, and may typically be invoked using various slash commands. As a proof of concept, it will only fetch ranking information directly from Nexon, for now. In the future, more functionality will be added, such as the ability to request specific information about game items, NPCs, and quests.

Requirements

• Python version 3.10+ - required for the discord-py-interactions package
• discord-py-interactions - A highly extensible, easy to use, and feature complete framework for Discord.
• selenium - Python language bindings for the Selenium WebDriver
• bs4 - Package to handle XPath and Html pathing

Setup

Python3.10+ is required for the bot to run. Run python --version to verify this. Download and install it if the python version is insufficient.

1. Clone this repository
   git clone https://github.com/AE-Mapuro/Maple-Bot.git
2. Navigate to the folder
   cd Maple-Bot
3. Instantiate a python virtual environment^[1]
   python -m venv pyenv
4. Activate the virtual environment^[2]
   • Windows - .\pyenv\Scripts\activate
   • Linux/Mac - source ./pyenv/bin/activate
5. Install the required python packages pip install -r requirements.txt
6. Create an env.py file to contain the bot credentials. Do this by copying the existing barebones env_template.py file.
   cp resources/env_template.py resources/env.py
7. Configure resources/env.py with the appropriate credentials:
   • discord_bot_token - String value of your bot token from the discord developer portal
   • discord_bot_guild - String Guild Name - Optional
   • discord_guild_ids - List of guild ids the bot has access to
8. Start up the bot python -m src.bot.py

---

^[1] Instead of pyenv, you can specify a literal path to where you want the virtual environment folder to reside (e.g. ~/path/to/env_fol)
^[2] Replace the pyenv path with the actual path to your virtual environment folder, if necessary

Slash Commands

Maple Ranking Commands

The commands in this section are for retrieving player data based on several parameters

Other Commands

Additional Commands to be added