BURG.L Discord Bot

A Discord resource management bot that augments the Grounded gaming experience.

---

About The Project

The BURG.L Discord Bot is a resource manager that aids Grounded players by tracking requirements and allocating tasks. BURG.L pulls data from the Grounded Wiki to get information for items, such as crafting costs.

Despite the recent introduction of slash commands by Discord, prefix commands are still used in this project as Discord’s in-game overlay does not work with slash commands.

The overall roadmap and development tracker for this project can be found on the Trello board below:

Planned Features

Feature	Description
Object Search	Retrieves object information (e.g. creatures, items, resources, status effects, mutations).
Creature Card Search	Retrieves a creature’s bestiary card.
Chopping List	Tracks player-required resources and their corresponding quantities.
Task Scheduler	Keeps track of user-inputted tasks.
Database Storage and Caching	Stores permanent data, as well as caching queried data from searches.

Built With

• Amazon DynamoDB
• Amazon EC2
• Discord.py
• GitHub REST API
• Google Custom Search JSON API
• Google Programmable Search Engine
• Python
• SteamCMD API

---

Usage

Bot Commands

• .help [page_number]
  • Displays the help menu.
• .search <object_name>
  • Displays any available information of the object, including its picture and description. Works with most things, like creatures, resources, equipment, structures, mutations, quests and more.
  • Use flag -o to override any binded shortcuts.
• .card <creature_name>
  • Displays the specified creature’s bestiary card.
  • Use flag -g to display the creature’s gold bestiary card.
  • Use flag -o to override any binded shortcuts.
• .weak <elemental_type> <damage_type>
  • Displays all creatures which match the specified weakness combination.
• .bind <object_name>, <shortcut_1>, [shortcut_2], ...
  • Binds an object name to one or more shortcut phrases.
  • Parameters are case-insensitive and must be separated by a comma.
  • Use flag -v to view all binded shortcuts (no arguments required).
  • Use flag -d to delete shortcuts for specified objects (at least one object_name required).
• .chop <item_name_1> <quantity_1>, [item_name_2] [quantity_2], ...
  • Adds one or more specified items to the Chopping List, which tracks player-required resources and quantities.
  • If a specified item is not already a natural resource, it will be broken down into its component materials before being added to the list.
  • Parameters are case-insensitive and there is a maximum of 9 parameters per entry.
  • Commas are optional unless two item_names are arranged consecutively.
  • Use flag -v to view all items in the Chopping List (no arguments required).
  • Use flag -d to check one or more specified items off from the Chopping List (quantity is optional; item will be marked as fully completed).
  • Use flag -r to reset the entire Chopping List (the word ‘confirm’ is required).
• .todo <task_description>, [priority_level]
  • Adds the given task to the Task Scheduler, which tracks both player-specified tasks as well as auto-generated tasks.
  • Valid task priority levels are:
    • Note
    • Low
    • Medium (Default)
    • High
  • Use flag -e to edit a task’s description and/or priority level (task_ID required).
  • Use flag -v to view all pending tasks in the Task Scheduler (no arguments required).
  • Use flag -d to check one or more specified tasks off the Task Scheduler (at least one task_ID is required).
  • Use flag -r to reset the entire Task Scheduler (the word ‘confirm’ is required).
• .clear
  • Clears the webpage data and object information caches.
• .purge [delete_number]
  • In a server channel: Purges the 25 most recent messages by default.
  • In a private message: Purges all of this bot’s messages.
• .sleep
  • Toggles sleep mode (ignores all other user commands).

Error Codes

Code	Description
101	Wiki page for the specified object cannot be located.
102	Wiki page for the specified object has an unsupported layout.
103	Daily limit of 100 queries for Google Custom Search JSON API has been exceeded.
104	Bestiary card for the specified creature cannot be located.
105	Specified object is not compatible with the Chopping List.
106	Specified item is not present in the list.

---

Copyright © 2022, Sorahawk