MarketCompass
I can't always find other players and NPCs, and where are the festival NPCs? Then you definitely need this compass mod to help you! | Can't find where other players, NPCs, and event NPCs are? You definitely need this compass mod to help you!
About this mod Machine translation
MarketCompass (Chinese)
I can't always find other players and NPCs, and where are the festival NPCs? Then you definitely need this compass mod to help you!
Main functions
- Display compass, icons, text information and distance at the top of the screen as follows
- Display other players (icon, position distance and name display distance: unlimited)
- Display fixed NPC (icon permanently displayed, location distance and name display distance: 20 meters)
- Display festival NPC (icon is permanently displayed, location distance and name display distance are: 20 meters)
- Note: Only festivals with purchasable items will be displayed
Other functions
- Configuration file
- Can enable/disable display of players, NPCs and holiday NPCs
- You can set the display distance between player and NPC names
- You can set whether to display tags added by other modules through API
- Configuration file path: BepInEx\config\IceBoxStudio.MarketCompass.cfg
- Multi-language support
- Supports Simplified Chinese, Traditional Chinese, English and Japanese by default, and automatically switches the module language according to the game language
- If you want to contribute other languages, you can contact me to add them to the module. The language codes of the languages currently supported by the game: fr, de, ko, pt, ru, es, tr, uk
API
- Provides API interfaces for adding, removing and clearing external tags. It is recommended to use reflection so that the DLL file of this module is not referenced.
- method signature
- SetMarkers(string source, string ids, Vector3 positions, string names): Set multiple external markers
- AddMarker(string source, string id, Vector3 position, string name): Add an external marker
- RemoveMarker(string source, string id): Remove an external marker
- ClearMarkers(string source): Clear all external markers from the specified source
- Parameter definition
- Source (string): Your module identifier. Used to distinguish tags from different sources and only remove your own tags when cleaning
- Id (string): Unique ID of the tag
- Position (Vector3): world coordinates
- Name (string): Name displayed below the compass (optional)
special thanks
- foxneko
- Isabella
compatibility
- Game version: 2.0.0+
Bug feedback
- If you find any issues, please submit them through GitHub Issues, or contact me directly via email 764884112@qq.com
MarketCompass (English)
Can't find where other players, NPCs, and event NPCs are? You definitely need this compass mod to help you!
Main Features
- Display compass, icons, text information, and distances at the top of the screen, as follows:
- Display other players (icon, position distance, and name display distance: unlimited)
- Display fixed NPCs (icon permanently displayed, position distance and name display distance: 20 meters)
- Display festival NPCs (icon permanently displayed, position distance and name display distance: 20 meters)
- Note: Only festivals with purchasable items will be displayed
Other Features
- Configuration File
- Can enable/disable the display of players, NPCs, and festival NPCs
- Can set the display distance for player and NPC names
- Can set whether to display markers added by other mods through the API
- Configuration file path: BepInEx\config\IceBoxStudio.MarketCompass.cfg
- Multi-language Support
- Default support for Simplified Chinese, Traditional Chinese, English, and Japanese. The mod automatically switches language based on game language
- If you want to contribute other languages, contact me to add them to the mod. Current supported language codes: fr, de, ko, pt, ru, es, tr, uk
API
- Provides API interfaces for adding, removing, and clearing external markers. It is recommended to use Reflection so that you do not need to reference this mod's DLL file directly.
- Method Signatures
- SetMarkers(string source, string ids, Vector3 positions, string names): Sets multiple external markers.
- AddMarker(string source, string id, Vector3 position, string name): Adds a s …
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.
Install these first, or the mod will not work: