Can players leave - Map Bounds Checker

This is a tool designed for map makers to detect if a player is able to go out of bounds in a map. Curious players are also welcome.

Can The Player Leave - Out of Bounds Checker

🎯 **Boundary detection tool specially built for map makers**

This mod is primarily designed for map makers, whether you're making a new greenhouse, a map patch, or an entirely new collection of maps from the entire expansion.

---

🎮 Features

✨ **SMAPI Console Commands**: Added "escapemap" command, available without in-game UI

✨ **Multiple parameter options**: Supports multiple parameter combinations to meet different detection needs

✨ **Smart Map Scanning**: Automatically detect map locations that players can reach via various means

---

📝 Command usage guide

**Basic command syntax**:

```

escapemap [parameter]

```

**Optional parameters** (can be combined in any order):

• `"print"` or `"grid"` - displays the requested location in a graphical grid
• `"any"` or `"all"` - contains all currently loaded maps (except Farmhouse)
• `"farmhouse"` - when used alone only displays a graphical grid for farmhouses

**Usage Example**:

• `escapemap any grid` - displays information and grids for all currently loaded locations (except farmhouses)
• `escapemap farmhouse any grid` - Show only the farmhouse grid
• `escapemap` - only displays text information at the current location (no grid)

---

🔍 How it works

**in short**:

The mod detects out of bounds points by scanning all travel methods available to the player in the current save (including walking, teleporting, etc.) to find map tiles that the player can reach, and then performs a flood fill algorithm based on walkability.

**Technical Details**:

• Create a directed graph where nodes are tiles for travel (teleports, minecarts, etc.)
• Define directed edges based on available travel modes
• Process each tile in the map based on "walkability" using a flood fill algorithm

---

⚠️ IMPORTANT NOTES

🔸 **Map Detection Limitation**: The mod will only detect locations it thinks the player can reach by walking or teleporting. For new custom maps, it may not be detected unless a teleport point is set up or the player is teleported there.

🔸 **Ignored Locations**: Automatically ignore special locations such as mines, volcano dungeons, and locations not in Game1.locations.

🔸 **False Positive Handling**: If a certain tile is reported but you can't understand how to get there, try using the print parameter. If you still can't figure it out, it's possible that another loaded map has a teleport point near that tile.

🔸 **Warning message**: Other modules may print a warning when using the "escapemap" command for the first time. These warnings usually only appear once and are harmless and can be ignored.

---

🌟 Usage suggestions

If you are a map maker:

• Use this tool to secure your map borders
• Test all possible player movement paths
• Use the grid display function to visually view problem areas

If you are an ordinary player:

• When you find out-of-bounds issues, please report them to the map maker in a patient and friendly manner
• Can recommend developers to use this module for self-testing

---

💡 **TECHNICAL TIP**: The mod takes into account all types of touch action effects, including off-map touch teleports, which means it knows about these teleports to prevent out-of-bounds as well. If your map is missing off-map touch teleport, this mod will find it!

---

Special thanks to the Stardew Valley modders on the Sunberry Village team for their encouragement and insights during development!