From f34f04360487f2538983012984cb2bd5c77da10d Mon Sep 17 00:00:00 2001 From: zhangyuheng Date: Tue, 22 Oct 2024 11:45:09 +0800 Subject: [PATCH] Translate some docs of en-us. --- docs/en-us/SUMMARY.md | 22 ++++++++-------- docs/en-us/create-dominion.md | 29 +++++++++++---------- docs/en-us/developer.md | 38 ++++++++++++++-------------- docs/en-us/manage-dominion/README.md | 21 ++++++++------- docs/en-us/migration-residence.md | 29 +++++++++++---------- docs/zh-cn/developer.md | 13 +++++----- docs/zh-hk/developer.md | 12 ++++----- 7 files changed, 85 insertions(+), 79 deletions(-) diff --git a/docs/en-us/SUMMARY.md b/docs/en-us/SUMMARY.md index fda0d4bc..68d7e109 100644 --- a/docs/en-us/SUMMARY.md +++ b/docs/en-us/SUMMARY.md @@ -1,24 +1,24 @@ # Summary * [Preface](README.md) -* [Creating a Dominion](README.md) -* [Territory Management](manage-dominion/README.md) +* [Creating a Dominion](create-dominion.md) +* [Dominion Management](manage-dominion/README.md) * [Environment Settings](manage-dominion/environment.md) * [Permission Management](manage-dominion/permission/README.md) * [Guest Permissions](manage-dominion/permission/guest.md) - * [Territory members](manage-dominion/permission/member.md) + * [Dominion Members](manage-dominion/permission/member.md) * [Permission Groups](manage-dominion/permission/permission-group.md) * [Permission Templates](manage-dominion/permission/template.md) - * [Territory Teleport](manage-dominion/teleport.md) + * [Dominion Teleport](manage-dominion/teleport.md) * [Resize](manage-dominion/resize.md) - * [Setting the territory reminder message](manage-dominion/message.md) - * [Permission group title](manage-dominion/group-title.md) - * [Subdominion](manage-dominion/sub-dominion.md) -* [Migration from residence](migration-residence.md) -* [Command list](command-list.md) + * [Dominion Message](manage-dominion/message.md) + * [Group Title](manage-dominion/group-title.md) + * [SubDominion](manage-dominion/sub-dominion.md) +* [Migration from Residence](migration-residence.md) +* [Command List](command-list.md) * [Administrator's Guide](operator/README.md) - * [Configuration file reference](operator/config.md) + * [Configuration File Reference](operator/config.md) * [flags.yml](operator/flags.md) * [Privileged Player Configuration](operator/privilege.md) - * [Cross-group teleportation (global-tp in testing)](operator/global-tp.md) + * [Multi Server Teleportation (no-release)](operator/global-tp.md) * [Developer](developer.md) \ No newline at end of file diff --git a/docs/en-us/create-dominion.md b/docs/en-us/create-dominion.md index 54e24b7e..890e5d14 100644 --- a/docs/en-us/create-dominion.md +++ b/docs/en-us/create-dominion.md @@ -1,23 +1,24 @@ -# 创建领地 +# Create A Dominion -## 名称规则 +## Naming Rules -- 领地名称不可与其他领地重复； -- 领地名称不可包含空格； -- 领地名称不可包含特殊字符； +- Should not duplicate with other dominions; +- Should not contain spaces; +- Should not contain special characters; -## 手动创建 +## Manual Creation -需要使用圈地工具（默认为箭矢），依次使用左键点选领地长方体区域的第一个点、右键点击长方体区域的第二个点。然后使用： -`/dominion create <领地名称>`创建领地，领地名称不可与其他领地重复。 +Using tool (default is arrow), left-click the first point of the rectangular area of the dominion, and right-click the +second point of the rectangular area. Then use: +`/dominion create ` to create a dominion, the dominion name cannot be the same as other dominions. -## 自动创建 +## Automatic Creation -不需要选择对角线点，会以玩家为中心自动创建一定区域的领地。 +Don't need to select the diagonal points, the dominion will be created automatically with the player as the center. -1. 使用 `/dominion` 打开主菜单，点击`【创建领地】`; -2. 在弹出的 UI 中输入你要创建的领地名称; -3. 输入完成后左键点击下方中间的绿色混凝土，即可自动创建一块领地; +1. Open the main menu with `/dominion`, click `【CREATE】`; +2. Enter the name of the dominion you want to create in the pop-up UI; +3. After entering, left-click the green concrete in the middle below to automatically create a dominion; -> 自动创建半径是由服务器管理员在配置文件中设置的； +> The radius of automatic creation is set by the server administrator in the configuration file; diff --git a/docs/en-us/developer.md b/docs/en-us/developer.md index 24caf8de..e8faf199 100644 --- a/docs/en-us/developer.md +++ b/docs/en-us/developer.md @@ -1,12 +1,15 @@ -# 开发者文档 +# Developer Reference -> DominionAPI 自 Dominion-2.9.0-beta 开始支持。 +[![Javadoc](https://img.shields.io/badge/Javadoc-Link-70f3ff?logo=readthedocs)](https://coldezhang.github.io/DominionAPI/) +[![DemoPlugin](https://img.shields.io/badge/DemoPlugin-GitHub-blue?logo=github)](https://github.com/ColdeZhang/DominionAddonExample) -## 一、接入 DominionAPI +> Since Dominion-2.9.0-beta, DominionAPI is supported. -### 1. 引入依赖 +## First: Import DominionAPI -如果您使用 gradle，可以在您的 `build.gradle` 文件中添加如下代码： +### 1. Add Dependency + +For gradle, you can add the following code to your `build.gradle` file: ```groovy // build.gradle @@ -15,11 +18,11 @@ repositories { } dependencies { - compileOnly("cn.lunadeer:DominionAPI:2.1-SNAPSHOT") + compileOnly("cn.lunadeer:DominionAPI:2.3-SNAPSHOT") } ``` -或者你使用的是 gradle kotlin dsl： +Or if you use kotlin, you can add the following code to your `build.gradle.kts` file: ```kotlin // build.gradle.kts @@ -28,11 +31,11 @@ repositories { } dependencies { - compileOnly("cn.lunadeer:DominionAPI:2.1-SNAPSHOT") + compileOnly("cn.lunadeer:DominionAPI:2.3-SNAPSHOT") } ``` -再或者您使用 maven，可以在您的 `pom.xml` 文件中添加如下代码： +For maven, you can add the following code to your `pom.xml` file: ```xml @@ -47,24 +50,25 @@ dependencies { cn.lunadeer DominionAPI - 2.1-SNAPSHOT + 2.3-SNAPSHOT provided ``` -### 2. plugin.yml 配置 +### 2. Add Plugin Dependency -在您的插件的 `plugin.yml` 文件中添加如下配置，以确保在 Dominion 准备完成后再加载您的插件： +Add the following configuration to your plugin's `plugin.yml` file to ensure that your plugin is loaded after Dominion +is ready: ```yaml # plugin.yml depend: [ Dominion ] ``` -## 二、使用 DominionAPI +## Second: Implement DominionAPI -可以通过如下方法直接获取 DominionAPI 实例： +Get the DominionAPI instance directly as follows: ```java import cn.lunadeer.dominion.api.Dominion; @@ -73,7 +77,7 @@ import cn.lunadeer.dominion.api.DominionAPI; DominionAPI dominionAPI = Dominion.getInstance(); ``` -例如，获取某个位置的领地信息： +Then you can use the API, for example, to get the dominion information at a certain location: ```java @@ -93,7 +97,3 @@ public void onEnable() { } } ``` - -[示例项目地址](https://github.com/ColdeZhang/DominionAddonExample)。 - -[Javadoc地址](https://coldezhang.github.io/DominionAPI/)。 diff --git a/docs/en-us/manage-dominion/README.md b/docs/en-us/manage-dominion/README.md index a27de856..dc26303a 100644 --- a/docs/en-us/manage-dominion/README.md +++ b/docs/en-us/manage-dominion/README.md @@ -1,14 +1,17 @@ -# 领地管理 +# Dominion Management -领地的管理可以通过领地菜单完成，通常来说您不需要任何指令就可以完成领地的管理。 +The management of the dominion can be completed through the dominion menu. +In general, you do not need any commands to complete the management of the dominion. -## 主菜单界面 `/dominion` +## Opening Menu with `/dominion` -使用 `/dominion` 可以打开领地系统的可视化操作菜单界面（TUI）。单击`【我的领地】`可以查看自己创建的所有领地。 +Using `/dominion` can open the visual operation menu interface (TUI) of the dominion system. +Click `【DOMINIONS】` to view all the dominions you have created. -## 领地管理界面 `/dominion manage [领地名称]` +## Dominion Management Interface `/dominion manage [dominion_name]` -单击对应领地的【管理】即可进入对应领地的管理界面，通过管理界面可以管理此领地的权限等信息。 也可以直接输入 -`/dominion manage [领地名称]` 来快速打开当前所在领地的管理界面。 - -> 领地名称是可选的，不填写则自动打开你当前所在的领地管理界面。 +Click `【MANAGE】` of the corresponding dominion to enter the management interface of the corresponding dominion. +Through the management interface, you can manage the permissions and other information of this dominion. You can also +directly enter `/dominion manage [dominion_name]` to quickly open the management interface of the dominion you are +standing +in. diff --git a/docs/en-us/migration-residence.md b/docs/en-us/migration-residence.md index bf0ba0eb..06024cdb 100644 --- a/docs/en-us/migration-residence.md +++ b/docs/en-us/migration-residence.md @@ -1,20 +1,23 @@ -# 将领地从 Residence 迁移到 Dominion +# Migration from Residence -## 注意事项 +## Notice -1. 迁移采取的“玩家自助”方案，即由玩家自行决定要迁移自己的哪些领地； -2. 目前支持迁移：领地、tp点、欢迎/离开提示消息、子领地； -3. 由于对权限的存储、索引方式不同，目前**不支持**对权限进行迁移； -4. 迁移领地**不会产生二次消费**； +1. Instead of automatically migrating all data, the player can choose which residence of his own to migrate; +2. Currently supported data migration: residence, tp points, welcome/leave messages, sub-residence; +3. Due to the different storage and indexing methods of permissions, **permission migration is currently NOT SUPPORTED + **; +4. Migrating residence **will NOT incur secondary consumption**; -## 服主要做的事 +## For Server Owner -1. 删除 Residence 插件，保留其数据文件 `plugins/Residence`; -2. 在 Dominion 配置中将 `ResidenceMigration` 打开（设置为true）； +1. Delete the Residence plugin and keep its data file `plugins/Residence`; +2. Open `ResidenceMigration` in the Dominion configuration (set to true); +3. Restart the server to take effect; -## 玩家要做的事 +## For Player -1. 上线，打开 Dominion 菜单 `/dom`，点击`【迁移数据】`： -2. 选择要迁移的 Residence 领地，点击前面的`【迁移】`； -3. 完成后即可前往领地列表进一步配置领地的权限等信息： +1. Log in and open the Dominion menu `/dom`, click `【MIGRATE】`: +2. Select the residence you want to migrate, click `【MIGRATE】` after it; +3. After completion, you can go to the dominion list to further configure the permissions and other information of the + dominion: diff --git a/docs/zh-cn/developer.md b/docs/zh-cn/developer.md index 0bf00ade..656a3728 100644 --- a/docs/zh-cn/developer.md +++ b/docs/zh-cn/developer.md @@ -1,5 +1,8 @@ # 开发者文档 +[![Javadoc](https://img.shields.io/badge/Javadoc-Link-70f3ff?logo=readthedocs)](https://coldezhang.github.io/DominionAPI/) +[![示例插件](https://img.shields.io/badge/示例插件-GitHub-blue?logo=github)](https://github.com/ColdeZhang/DominionAddonExample) + > DominionAPI 自 Dominion-2.9.0-beta 开始支持。 ## 一、接入 DominionAPI @@ -15,7 +18,7 @@ repositories { } dependencies { - compileOnly("cn.lunadeer:DominionAPI:2.1-SNAPSHOT") + compileOnly("cn.lunadeer:DominionAPI:2.3-SNAPSHOT") } ``` @@ -28,7 +31,7 @@ repositories { } dependencies { - compileOnly("cn.lunadeer:DominionAPI:2.1-SNAPSHOT") + compileOnly("cn.lunadeer:DominionAPI:2.3-SNAPSHOT") } ``` @@ -47,7 +50,7 @@ dependencies { cn.lunadeer DominionAPI - 2.1-SNAPSHOT + 2.3-SNAPSHOT provided @@ -93,7 +96,3 @@ public void onEnable() { } } ``` - -[示例项目地址](https://github.com/ColdeZhang/DominionAddonExample)。 - -[Javadoc地址](https://coldezhang.github.io/DominionAPI/)。 diff --git a/docs/zh-hk/developer.md b/docs/zh-hk/developer.md index 24caf8de..b8501cdf 100644 --- a/docs/zh-hk/developer.md +++ b/docs/zh-hk/developer.md @@ -1,5 +1,8 @@ # 开发者文档 +[![Javadoc](https://img.shields.io/badge/Javadoc-Link-70f3ff?logo=readthedocs)](https://coldezhang.github.io/DominionAPI/) +[![示例插件](https://img.shields.io/badge/示例插件-GitHub-blue?logo=github)](https://github.com/ColdeZhang/DominionAddonExample) + > DominionAPI 自 Dominion-2.9.0-beta 开始支持。 ## 一、接入 DominionAPI @@ -15,7 +18,7 @@ repositories { } dependencies { - compileOnly("cn.lunadeer:DominionAPI:2.1-SNAPSHOT") + compileOnly("cn.lunadeer:DominionAPI:2.3-SNAPSHOT") } ``` @@ -28,7 +31,7 @@ repositories { } dependencies { - compileOnly("cn.lunadeer:DominionAPI:2.1-SNAPSHOT") + compileOnly("cn.lunadeer:DominionAPI:2.3-SNAPSHOT") } ``` @@ -47,7 +50,7 @@ dependencies { cn.lunadeer DominionAPI - 2.1-SNAPSHOT + 2.3-SNAPSHOT provided @@ -94,6 +97,3 @@ public void onEnable() { } ``` -[示例项目地址](https://github.com/ColdeZhang/DominionAddonExample)。 - -[Javadoc地址](https://coldezhang.github.io/DominionAPI/)。