HexMaster is a powerful Discord bot designed for Foxhole logistics groups. It enables seamless stockpile management, cross-map item discovery, and intelligent supply chain comparison using OCR and real-time game data.
The bot follows a snapshot-based storage model, preserving full historical data of every stockpile update without ever overwriting.
- Installation & Deployment: Setup guides for Docker and local development.
- User Guide (Commands): Detailed info on
/report,/locate,/inventory, and more. - Admin Guide (Tools): How to configure the bot, shards, and priority lists.
- Technical Reference: Architecture, project structure, and technical details.
- Intelligence Reporting: File reports by uploading screenshots of stockpiles.
- Requisition Orders: Compare "Shipping Hubs" against "Receiving Bases" to identify supply gaps.
- Strategic Reconnaissance: Find specific items across the entire World Conquest map with proximity sorting.
- Priority Management: Track mission-critical items through customizable priority lists.
/report: Upload a screenshot to update stockpile data./locate: Find the nearest source of a specific item./inventory: View items currently held in a town or base./requisition: Calculate what supplies are missing from a destination.
/setup config: Set your server's faction and shard./setup priorities: Load standard priority templates.
HexMaster relies on several critical community-maintained tools:
- Foxhole Stockpiles (FS): OCR and screenshot-to-data logic.
- WarAPI: Official Foxhole API for town data and map status.
- Discord.py: Discord API wrapper.
- SQLAlchemy: Database abstraction.
While the core logic is now stable, the following UI and feature enhancements are planned:
- Dynamic Inventory Cleanup: Automatically remove or "grey out" inventories for Seaports or Storage Warehouses that the WarAPI reports as Destroyed or Captured by the enemy.
- Faction Tracking: Only show inventories that belong to the bot-owner's faction (Colonials/Wardens) in real-time.
- Logistics Threat Mapping: Overlay current "Front Line" map data to warn logistics drivers if a
/locateresult requires driving through contested or enemy-held territory. - Supply Drop Alerts: Automated pings when a critical frontline base (based on WarAPI status) is low on Soldier Supplies or AT weapons.
- Trend Charts: Visual graphs of stockpile changes over the last 24-48 hours.
HexMaster relies on several critical community-maintained tools:
- Foxhole Stockpiles (FS): OCR and screenshot-to-data logic.
- WarAPI: Official Foxhole API for town data and map status.
- Discord.py: Discord API wrapper.
- SQLAlchemy: Database abstraction.
- Bot Implementation:
src/hexmaster/bot/main.py - Database Schema:
src/hexmaster/db/models.py - Reference Data: Located in
data/(Towns, Regions, Catalog)
This project is licensed under the MIT License. See the LICENSE file for the full text.
HexMaster's implementation is intended for private logistics group use and follows all community safety standards for Foxhole third-party software.