Ice_Box_Studio-MarketCompass icon

MarketCompass

老是找不到其他玩家和 NPC 以及节日 NPC 的位置在哪里?那么你肯定需要这个指南针模组来帮助你!| Can't find where other players, NPCs, and event NPCs are? You definitely need this compass mod to help you!

Last updated 2 weeks ago
Total downloads 1068
Total rating 1 
Categories Mods
Dependency string Ice_Box_Studio-MarketCompass-1.0.1
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2304 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2304

README

MarketCompass (中文)

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

主要功能

  • 在屏幕上方显示指南针、图标、文本信息和距离,具体如下
    • 显示其他玩家(图标、位置距离和名称显示距离为:无限)
    • 显示固定 NPC(图标永久显示,位置距离和名称显示距离为:20 米)
    • 显示节日 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): 显示在指南针下方的名称(可选)

特别感谢

兼容性

  • 游戏版本: 2.0.0+

Bug 反馈


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 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

Compatibility

  • Game version: 2.0.0+

Bug Reports