MarketCompass (中文)

老是找不到其他玩家和 NPC 以及节日 NPC 的位置在哪里？那么你肯定需要这个指南针模组来帮助你！

主要功能

• 在屏幕上方显示指南针，具体如下
  • 显示其他玩家的位置距离和玩家名称（默认显示距离为：无限）
  • 显示固定 NPC 的位置距离和名称（默认显示距离为：20 米）
  • 在节日期间如果有可购买的物品的 NPC，会显示节日 NPC 的位置距离以及节日名字（默认显示距离为：20 米）

其他功能

• 配置文件
  • 可以启用/禁用玩家、NPC和节日 NPC 的显示
  • 可以设置玩家和 NPC 的名字的显示距离
  • 可以设置是否显示其他模组通过 API 新增的标记
  • 配置文件路径：BepInEx\config\IceBoxStudio.MarketCompass.cfg
• 多语言支持
  • 默认支持简体中文、繁体中文、英语和日语，根据游戏语言自动切换模组语言
  • 如果你想贡献其他语言可以联系我加入到模组中，当前游戏支持的语言的语言代码：fr, de, ko, pt, ru, es, tr, uk

API

• 提供了添加、移除和清除外部标记的 API 接口，推荐使用反射的方式，这样可不引用本模组的 DLL 文件
  • 方法签名
    • SetMarkers(string source, string[] ids, Vector3[] positions, string[] names)：设置多个外部标记
    • AddMarker(string source, string id, Vector3 position, string name)：添加一个外部标记
    • RemoveMarker(string source, string id)：移除一个外部标记
    • ClearMarkers(string source)：清除所有来自指定来源的外部标记
  • 参数定义
    • Source (string): 你的模组标识符。用于区分不同来源的标记，并在清理时只移除你自己的标记
    • Id (string): 标记的唯一 ID
    • Position (Vector3): 世界坐标
    • Name (string): 显示在指南针下方的名称（可选）

特别感谢

• foxneko
• Isabella

兼容性

• 游戏版本: 2.0.0+

Bug 反馈

• 如果您发现了任何问题，请通过 GitHub Issues 提交，或直接通过邮箱 [email protected] 联系我

MarketCompass (English)

Can't find where other players, NPCs, and event NPCs are? You definitely need this compass mod to help you!

Major Features

• Displays a compass at the top of the screen with the following details:
  • Shows the position, distance, and names of other players (default display distance: infinite).
  • Shows the position, distance, and names of fixed NPCs (default display distance: 20 meters).
  • During festivals, if there are NPCs with purchasable items, it shows the position, distance, and festival name for these Festival NPCs (default display distance: 20 meters).

Other Features

• Configuration File
  • Toggle the display of Players, NPCs, and Festival NPCs on/off.
  • Set the display distance for Player and NPC names.
  • Toggle whether to show markers added by other mods via API.
  • Configuration file path: BepInEx\config\IceBoxStudio.MarketCompass.cfg
• Multi-language Support
  • Built-in support for Simplified Chinese, Traditional Chinese, English, and Japanese; automatically switches the mod language based on the game language.
  • If you would like to contribute other languages, please contact me to have them added to the mod. The language codes currently supported by the game are: 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 single external marker.
    • RemoveMarker(string source, string id): Removes a single external marker.
    • ClearMarkers(string source): Clears all external markers from a specific source.
  • Parameter Definitions
    • Source (string): Your mod identifier. Used to distinguish markers from different sources and to ensure you only remove your own markers when clearing.
    • Id (string): The unique ID of the marker.
    • Position (Vector3): World coordinates.
    • Name (string): The name displayed below the compass (optional).

Special Thanks

• foxneko
• Isabella

Compatibility

• Game version: 2.0.0+

Bug Reports

• If you find any issues, please submit through GitHub Issues, or contact me directly at [email protected]