Route suggestions

A mod designed for "Slay the Spire 2" that will highlight the optimal route in gold/red on the map interface.

RouteSuggest 🗺️

A module designed for "Slay the Spire 2", it will highlight the optimal route in gold/red on the map interface to help you make more informed decisions!

**Supported game versions:** v0.99.1 and v0.102.0 (Public Beta)

---

✨ Core Functions

• **Dual Route Suggestion**: Provides two optimal routes - **Safe Route** and **Aggressive Route**.
• **Visual Highlighting**:
• **Gold**: Safe route (minimizes risk)
• **Red**: Aggressive route (prioritize fighting to get rewards)
• **Smart Scoring**: Set different weights for different play styles (safe vs aggressive).
• **Expert Rating**: Optional location-adjacent bonus that rewards specific node sequence patterns (e.g. resting before elite battles).
• **GUI Configuration**: Full in-game configuration via **ModConfig** (optional).
• **Manual Configuration**: Advanced users can edit the JSON configuration file directly.

---

🚀 How it works

The module uses different scoring systems to calculate two optimal paths:

Safe Path (Gold) 🛡️

Minimize encounters and prioritize safety:

| Room Type | Rating | Reason |

|:--- |:--- |:--- |

| **Rest Point** | +1 | Healing and Upgrade Cards |

| **Treasure Chest Room** | +1 | Free Relics |

| **Shop** | +1 | Buy cards, relics and potions |

| **Monster** | -1 | Avoid combat |

| **Elite** | -3 | Avoid difficult encounters |

| **Boss** | 0 | Final Destination |

Radical Path (Red) ⚔️

Prioritize combat rewards and unknown encounters:

| Room Type | Rating | Reason |

|:--- |:--- |:--- |

| **Rest Point** | +1 | Healing and Upgrade Cards |

| **Treasure Chest Room** | +1 | Free Relics |

| **Shop** | +1 | Buy cards, relics and potions |

| **Monster** | +2 | Gold coins and card rewards |

| **Elite** | +3 | Relics and better rewards |

| **Unknown** | +2 | Potential fighting chance |

| **Boss** | 0 | Final Destination |

When two paths share the same edge, it appears golden.

Expert Rating (Adjacent Rewards) 🧠

Each path has the option to enable **Expert Mode**, which applies positional adjacency bonuses on top of base weights. Expert mode is a global switch that affects all paths. These reward specific node sequences:

| Mode | Description | Default Value |

|:--- |:--- |:--- |

| **Rest -> Elite** | Rest point immediately before elite encounter | 0 |

| **Elite -> Rest** | Elite encounter immediately before rest point | 0 |

| **Treasure Chest -> Elite** | The treasure chest room immediately before the elite encounter | 0 |

| **Rest -> Any -> Elite** | The rest point is two steps before the elite encounter (one node in between) | 0 |

| **Elite -> Any -> Rest** | Elite encounter is two steps before the rest point (one node in between) | 0 |

The default value for all rewards is 0 (disabled). When expert mode is turned off, the ratings are the same as before. Switches and rewards can be configured via the ModConfig GUI or JSON.

---

⚙️ Configuration options

GUI settings (recommended) 🎮

RouteSuggest optionally integrates with **ModConfig**. After installing ModConfig, RouteSuggest will appear in the game's **Settings > Mods** menu. If ModConfig is not installed, the mod will still work normally, but you will need to manually edit the JSON configuration file.

Through the ModConfig GUI you can:

• **General Settings**:
• **Highlight Type**: Choose to highlight one optimal path or all paths with the best scores.
• **Enable Expert Rating**: Global switch that enables adjacent bonuses (affects all paths).
• **Configure each path**:
• **Enable**: Enable/disable this path (disabled paths will not be calculated or displayed).
• **Name**: Path identifier.
• **Color**: Enter a hexadecimal color code (for example, `#FFD700` for gold, `#FF0000` for red).
• **Priority**: The slider sets the rendering priority (the higher the value, the upper layer will be displayed when the paths overlap).
• **Rating Weight**: Slide …