generated from Lazy-Bing-Server/Sprout-MCDRTemplate
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4e7cc6c
commit 5b131c2
Showing
8 changed files
with
301 additions
and
242 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,66 +1,66 @@ | ||
| **English** | [简体中文](README_cn.md)（WIP) | ||
|
|
||
| Where Is | ||
| ------- | ||
|
|
||
| A [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) plugin | ||
|
|
||
| ## Dependencies | ||
|
|
||
| [MinecraftDataAPI](https://github.com/MCDReforged/MinecraftDataAPI/) | ||
|
|
||
| [MCDReforged] >= 2.1.3 | ||
|
|
||
| ## Commands | ||
|
|
||
| `!!whereis` or `!!vris`（can be modified in config）：Show coordinate of other player | ||
|
|
||
| `-a` or `-s` arguments are allowed（can be called in one command as `-as` or `-sa`） | ||
|
|
||
| `-a` means broadcasting coordinate to **a**ll the players and highlight target player | ||
|
|
||
| `-s` means sudo, allow to query coordinate of protected players | ||
|
|
||
| Both 2 arguments requires `admin` permission level in the config file of this plugin | ||
|
|
||
| ## 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 | ||
|
|
||
| | Keys | Value type | Default value | Introduction | | ||
| | ------------------------- | ------------------------------ | ----------------------- | ------------------------------------------------------------ | | ||
| | `command_prefix` | `list` | `'!!vris', '!!whereis'` | Command prefix of this plugin | | ||
| | `permission_requirements` | `dict`(which includes 2 items) | In the following sheets | Minium permission of commands | | ||
| | `hightlight_time` | `int` | `0` | Highlight player time when command with `-a` called | | ||
| | `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 | | ||
|
|
||
| In the sheet above, the items which have stable items is showing below: | ||
|
|
||
| | Keys of`permission_requirements` | Value type | Default value | Introduction | | ||
| | -------------------------------- | ---------- | ------------- | ------------------------------------------------------------ | | ||
| | `where_is` | `int` | `1` | Permissions which allows command calls without extra arguments | | ||
| | `admin` | `int` | `3` | Permissions which allows command calls with extra arguments | | ||
|
|
||
| | Keys of`display_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](https://www.curseforge.com/minecraft/mc-mods/voxelmap) | | ||
| | `xaero_minimap` | `bool` | `true` | If it is `true` a text (`[+X]`) will be displayed, click to add waypoint to [Xaero's Minimap](https://chocolateminecraft.com/minimap2.php) | | ||
|
|
||
| | Keys of`location_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 | ||
|
|
||
|  | ||
| **English** | [简体中文](README_zh.md) | ||
|
|
||
| Where Is | ||
| ------- | ||
|
|
||
| A [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) plugin | ||
|
|
||
| ## Dependencies | ||
|
|
||
| [MinecraftDataAPI](https://github.com/MCDReforged/MinecraftDataAPI/) | ||
|
|
||
| [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) >= 2.1.3 | ||
|
|
||
| ## Commands | ||
|
|
||
| `!!whereis` or `!!vris`（can be modified in config）：Show coordinate of other player | ||
|
|
||
| `-a` or `-s` arguments are allowed (can be called in one argument as `-as` or `-sa`) | ||
|
|
||
| `-a` means broadcasting coordinate to **a**ll the players and highlight target player | ||
|
|
||
| `-s` means **s**udo, allows querying coordinate of protected players | ||
|
|
||
| Both 2 arguments requires `admin` permission level in the config file of this plugin | ||
|
|
||
| ## 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 | ||
|
|
||
| | Keys | Value type | Default value | Introduction | | ||
| | ------------------------- | ------------------------------ | ----------------------- | ------------------------------------------------------------ | | ||
| | `command_prefix` | `list` | `'!!vris', '!!whereis'` | Command prefix of this plugin | | ||
| | `permission_requirements` | `dict`(which includes 2 items) | In the following sheets | Minium permission of commands | | ||
| | `hightlight_time` | `int` | `0` | Highlight player time when command with `-a` called | | ||
| | `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 | | ||
|
|
||
| In the sheet above, the items which have stable items is showing below: | ||
|
|
||
| | Keys of`permission_requirements` | Value type | Default value | Introduction | | ||
| | -------------------------------- | ---------- | ------------- | ------------------------------------------------------------ | | ||
| | `where_is` | `int` | `1` | Permissions which allows command calls without extra arguments | | ||
| | `admin` | `int` | `3` | Permissions which allows command calls with extra arguments | | ||
|
|
||
| | Keys of`display_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](https://www.curseforge.com/minecraft/mc-mods/voxelmap) | | ||
| | `xaero_minimap` | `bool` | `true` | If it is `true` a text (`[+X]`) will be displayed, click to add waypoint to [Xaero's Minimap](https://chocolateminecraft.com/minimap2.php) | | ||
|
|
||
| | Keys of`location_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 | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| **简体中文** | [English](README.md) | ||
|
|
||
| Where Is | ||
| ------- | ||
|
|
||
| 一个 [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) 的插件 | ||
|
|
||
| ## 依赖 | ||
|
|
||
| [MinecraftDataAPI](https://github.com/MCDReforged/MinecraftDataAPI/) | ||
|
|
||
| [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) >= 2.1.3 | ||
|
|
||
| ## 指令 | ||
|
|
||
| `!!whereis` 或者 `!!vris`（可在配置文件中修改）：显示一个其他玩家的坐标。 | ||
|
|
||
| 可以加`-a` 或者 `-s`（可以合成一个参数写作 `-as` 或者 `-sa`）。 | ||
|
|
||
| `-a` 意为向所有(**a**ll)玩家发送坐标并高亮该玩家； | ||
|
|
||
| `-s` 意为提权(**s**udo)，允许查看受保护的玩家的坐标。 | ||
|
|
||
| 两个参数均需要插件配置中设置的 `admin` 等级来执行。 | ||
|
|
||
| ## 配置文件 | ||
|
|
||
| 部分特性可由配置文件控制，默认自动生成于 `config/where_is/config.json`。 | ||
|
|
||
| 修改配置文件之后需要使用`!!MCDR plg reload here`重载方可生效。 | ||
|
|
||
| 以下为配置文件内容 | ||
|
|
||
| | 键 | 值的类型 | 默认值 | 说明 | | ||
| | ------------------------- | --------------------- | ----------------------- | --------------------------------------- | | ||
| | `command_prefix` | `list` | `'!!vris', '!!whereis'` | 插件指令前缀 | | ||
| | `permission_requirements` | `dict`(含固定的2个值) | 见下表 | 指令要求的最小权限等级 | | ||
| | `hightlight_time` | `int` | `0` | 当包含 `-a` 参数时高亮玩家的时间 | | ||
| | `display_waypoints` | `dict`(含固定的2个值) | 见下表 | 是否显示小地图坐标点 | | ||
| | `query_timeout` | `int` | `3` | Minecraft Data API的超时时间 | | ||
| | `click_to_teleport` | `bool` | `true` | 允许玩家点击补全传送指令 (仍需OP以执行) | | ||
| | `location_protection` | `dict`(含固定的5个值) | 见下表 | 玩家坐标保护相关设定 | | ||
|
|
||
| 上述提到的含固定键值对的的配置项如下: | ||
|
|
||
| | `permission_requirements` 的键 | 值类型 | 默认值 | 说明 | | ||
| | ------------------------------ | ------ | ------ | -------------------------------------- | | ||
| | `where_is` | `int` | `1` | 玩家可执行不含参数的本插件指令的最小值 | | ||
| | `admin` | `int` | `3` | 玩家可执行含参数的本插件指令的最小值 | | ||
|
|
||
| | `display_waypoints`的键 | 值类型 | 默认值 | 说明 | | ||
| | ----------------------- | ------ | ------ | ------------------------------------------------------------ | | ||
| | `voxelmap` | `bool` | `true` | 为 `true` 时显示一个附带点击事件的文本 (`[+V]`) 点击高亮坐标，Ctrl点击添加坐标点到 [Voxelmap](https://www.curseforge.com/minecraft/mc-mods/voxelmap) | | ||
| | `xaero_minimap` | `bool` | `true` | 为 `true` 时显示一个附带点击事件的文本 (`[+x]`) , 点击添加路径点到 [Xaero's Minimap](https://chocolateminecraft.com/minimap2.php) | | ||
|
|
||
| | `location_protection` 的键 | 值类型 | 默认值 | 说明 | | ||
| | -------------------------- | ------ | ------------------------------------------------------------ | ---------------------------------------------------------- | | ||
| | `enable_whitelist` | `bool` | `false` | 启用查询白名单，启用时限制白名单外的玩家被查询 | | ||
| | `enable_blacklist` | `bool` | `true` | 启用查询黑名单，启用时限制黑名单外的玩家被查询 | | ||
| | `whitelist` | `list` | 空列表 | 白名单，限制除此之外的玩家被查询 | | ||
| | `blacklist` | `list` | 空列表 | 黑名单，限制该列表内的玩家被查询 | | ||
| | `protected_text` | `dict` | `'en_us': 'He/She\'s in your heart!' 'zh_cn': 'Ta在你心里!'` | 当玩家被阻止查询时显示的信息，提供了MCDR语言偏好设置的支持 | | ||
|
|
||
| ## 示例 | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| where_is.err: "Error occurred: {}" | ||
| where_is.hover.tp: ': Click to teleport to' | ||
| where_is.hover.voxel: "§bVoxelmap§r: Click to highlight the location, or Ctrl-Click to add waypoint" | ||
| where_is.err: "Error occurred: {}" | ||
| where_is.err.not_online: "Required player is not online" | ||
| where_is.hover.tp: ': Click to teleport to' | ||
| where_is.hover.voxel: "§bVoxelmap§r: Click to highlight the location, or Ctrl-Click to add waypoint" | ||
| where_is.hover.xaero: '§6Xaeros Minimap§r: Click to add waypoint' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| where_is.err: "出现错误: {}" | ||
| where_is.hover.tp: ': 点击以传送到' | ||
| where_is.hover.voxel: "§bVoxelmap§r: 点此以高亮坐标点, 或者Ctrl点击添加路径点" | ||
| where_is.err: "出现错误: {}" | ||
| where_is.err.not_online: "这玩家不在线啊" | ||
| where_is.hover.tp: ': 点击以传送到' | ||
| where_is.hover.voxel: "§bVoxelmap§r: 点此以高亮坐标点, 或者Ctrl点击添加路径点" | ||
| where_is.hover.xaero: '§6Xaeros Minimap§r: 点击添加路径点' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| { | ||
| "id": "where_is", | ||
| "version": "1.0.0-alpha.1", | ||
| "name": "Where Is", | ||
| "description": { | ||
| "en_us": "Query other players' coordinates", | ||
| "zh_cn": "查询其他玩家的坐标" | ||
| }, | ||
| "author": [ | ||
| "Ra1ny_Yuki" | ||
| ], | ||
| "link": "https://github.com/Lazy-Bing-Server/WhereIs-MCDR", | ||
| "dependencies": { | ||
| "minecraft_data_api": "*", | ||
| "mcdreforged": ">=2.1.3" | ||
| }, | ||
| "entrypoint": "where_is.entry", | ||
| "resources": [ | ||
| "lang", "LICENSE" | ||
| ] | ||
| { | ||
| "id": "where_is", | ||
| "version": "1.0.0", | ||
| "name": "Where Is", | ||
| "description": { | ||
| "en_us": "Query other players' coordinates", | ||
| "zh_cn": "查询其他玩家的坐标" | ||
| }, | ||
| "author": [ | ||
| "Ra1ny_Yuki" | ||
| ], | ||
| "link": "https://github.com/Lazy-Bing-Server/WhereIs-MCDR", | ||
| "dependencies": { | ||
| "minecraft_data_api": "*", | ||
| "mcdreforged": ">=2.1.3" | ||
| }, | ||
| "entrypoint": "where_is.entry", | ||
| "resources": [ | ||
| "lang", "LICENSE" | ||
| ] | ||
| } |
Oops, something went wrong.