Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 11.5 KB

README.md

File metadata and controls

96 lines (66 loc) · 11.5 KB

English | 简体中文

Where Is

A MCDReforged plugin, inspired by Fallen_Breath's Here and Ivan-1F's Where

Dependencies

MinecraftDataAPI

MCDReforged >= 2.1.3

Commands

  1. !!whereis or !!vris（can be modified in config）：Show coordinate of other player

Command format: !!whereis <player> [args(optional)]

​ -a or -s arguments are allowed (can be called in one argument as -as or -sa)

​ -a means broadcasting coordinate to all the players and highlight target player

​ -s means sudo, allows querying coordinate of protected players

​ Both 2 arguments requires admin permission level in the config file of this plugin

  1. !!here (can be modified in config）: Broadcast your current coordinate

​ Any !!here divided with space in chat message can be responded if inline here is enabled in config. New in version 2.1

Config File

Several features can be modified with configuration file, which will be generated automatically in config/where_is/config.json

Calling !!MCDR plg reload where_is to reload is required to make it loaded after modifying

Here is the config items in the file

WARNING: These 2 items which are marked with asterisk below should be configured manually before you update to 2.x or you'll lose all the configuration during loading the new version!!! You can ignore this message if you haven't install this plugin before

Keys Value type Default value Introduction
enable_where_is bool true Set it to true to enable query other player location
enable_here bool true Set it to true to enable broadcast your location
enable_inline_here bool false Set it to true to make inline here enabled. New in version 2.1
*command_prefix dict(which includes 2 items) In the following sheets Command prefix of this plugin
broadcast_to_console bool true !!here or !!vris <player> -a will also send message to server console
permission_requirements dict(which includes 3 items) In the following sheets Minimum permission of commands
*hightlight_time ``dict`(which includes 2 items) In the following sheets Highlight player time when coordinates are broadcasted to all the ones.
display_waypoints dict(which includes 2 items) In the following sheets If the text would include waypoint text of minimap
query_timeout int 3 Timeout of Minecraft Data API (seconds)
click_to_teleport bool true Allow player click to fill the teleport command (still requires operator permission)
location_protection dict(which includes 5 items) In the following sheets Player coordinate protection configuration
dimension_translation_mode Literal['mcdr', 'minecraft'] 'mcdr' mcdr: MCDReforged translates dimension names; minecraft: Minecraft translates dimension names. In 1.19 and later versions, using mcdr will avoid translation failure due to these dimension key change.
custom_dimension_name Dict[str, Dict[str, str]] Too long to show A mapping of dimension name translation for mcdr translation mode. This fist layer keys are the languages. The second layer keys are the dimension IDs (Non-vanilla dimensions are allowed. vanilla dimensions are required to fill and should omit the namespace).
custom_vanilla_translation_key Dict[str, str] Too long to show A mapping of dimension translation keys for minecraft translation mode. (Non-vanilla dimensions are allowed. vanilla dimensions are required to fill and should omit the namespace). New in version 2.1

In the sheet above, the items which have stable items is showing below:

The asterisked items contents goes here:

Keys ofcommand_prefix Value type Default value Introduction
where_is str ['!!vris', '!!whereis'] Command prefix to query locations
here str ['!!here'] Command prefix to broadcast locations
Keys ofhighlight_time Value type Default value Introduction
where_is int 0 Highlight player time when querying other player's location and broadcast
here int 15 Highlight player time when broadcasting your location

The rest are the regular items:

Keys ofpermission_requirements Value type Default value Introduction
where_is int 1 Permissions which allows query location without extra arguments
here int 0 Permissions which allows broadcast your location without extra arguments
admin int 3 Permissions which allows query location with extra arguments
Keys ofdisplay_waypoints Value type Default value Introduction
voxelmap bool true If it is true a text ([+V]) will be displayed, click to highlight the location, ctrl-click to add waypoint to Voxelmap
xaero_minimap bool true If it is true a text ([+X]) will be displayed, click to add waypoint to Xaero's Minimap
Keys oflocation_protection Value type Default value Introduction
enable_whitelist bool false Enable querying whitelist, which blocks the player NOT in this list being queried
enable_blacklist bool true Enable querying whitelist, which blocks the player in this list being queried
whitelist list empty list whitelist, which blocks the player NOT in this list being queried
blacklist list empty list Enable querying whitelist, which blocks the player in this list being queried
protected_text dict 'en_us': 'He/She\'s in your heart!', 'zh_cn': 'Ta在你心里!' Text replied when querying blocked, supports language preference of MCDReforged

Example