ShopTracker

A client-side shop management mod for MysticMC.

ShopTracker is built for server shop owners who want to monitor their stock levels, manage multiple player shops, and get alerted on Discord when items run low — all without ever having to physically visit each chest.

---

Features

📦 Stock Scanning

• Automatically reads stock levels from your shop signs without interacting with barrels
• Scans all signs within render distance matching your shop owner name
• Sends Discord webhook alerts when stock falls below your threshold
• Per-item and per-zone threshold customisation
• Configurable alert cooldown to prevent spam

🗺️ Zone Minimap

• Custom in-game minimap showing a top-down terrain view of your surroundings
• Draw shop zones directly on the map or by walking the corners in-world
• Zones render as polygons following your exact drawn shape
• Colour-coded stock overlays — green (stocked), orange (low), red (empty)
• Click to select zones, Ctrl+click for multi-select
• Scan specific zones only with the zone-scoped scan

🏪 Multi-PW Management

• Register multiple player warps (PWs) each with their own manager
• Each zone can have its own watched owner name, separate from the global setting

👥 Role System

• Admin — full control, manages all PWs and players via an in-game admin panel
• Manager — manages their assigned PW, adds restockers and controls their permissions
• Restocker — can scan and view stock by default, with optional extra permissions granted by their manager
• Roles are persistent and tied to Minecraft accounts via a backend API
• Admins can preview any role to test what managers and restockers can see

---

Setup

1. Install the mod in your Fabric mods folder
2. Launch the game once to generate config/shoptracker.json
3. Fill in your config:
   • watchedOwner — your in-game username (the name on your shop signs)
   • webhookUrl — your Discord webhook URL for stock alerts
   • defaultThreshold — stock level that triggers an alert
   • apiUrl — your ShopTracker Role API URL (optional, for multi-user setups)

---

Controls

Key	Action
V	Scan all signs in render distance
M	Open the zone minimap
N	Open the admin panel (admin only)
B	Open the manager panel (managers only)

All keybinds can be changed in Minecraft's controls settings.

---

Commands

Command	Description
/shoptracker scan	Scan all signs
/shoptracker map	Open minimap
/shoptracker owner <name>	Set watched owner
/shoptracker threshold <amount>	Set default threshold
/shoptracker zone start <name>	Begin defining a zone
/shoptracker zone corner	Add a corner at your position
/shoptracker zone finish	Save the zone
/shoptracker zone list	List all zones
/shoptracker zone assign <zone> <item>	Assign item to zone
/shoptracker exportzones	Export zones to a share code
/shoptracker importzones <code>	Import zones from a share code
/shoptracker manager	Open manager panel
/shoptracker stopreview	Stop role preview mode

---

Requirements

• Minecraft 1.21.8
• Fabric Loader
• Fabric API

---