Skip to content

Commit

Permalink
增加 en-us 文档
Browse files Browse the repository at this point in the history
  • Loading branch information
ColdeZhang committed Sep 10, 2024
1 parent bb5d95a commit 0a8e193
Show file tree
Hide file tree
Showing 20 changed files with 698 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/en-us/command-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 指令列表
23 changes: 23 additions & 0 deletions docs/en-us/create-dominion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# 创建领地

## 名称规则

- 领地名称不可与其他领地重复;
- 领地名称不可包含空格;
- 领地名称不可包含特殊字符;

## 手动创建

需要使用圈地工具(默认为箭矢),依次使用左键点选领地长方体区域的第一个点、右键点击长方体区域的第二个点。然后使用:
`/dominion create <领地名称>`创建领地,领地名称不可与其他领地重复。

## 自动创建

不需要选择对角线点,会以玩家为中心自动创建一定区域的领地。

1. 使用 `/dominion` 打开主菜单,点击`【创建领地】`;
2. 在弹出的 UI 中输入你要创建的领地名称;
3. 输入完成后左键点击下方中间的绿色混凝土,即可自动创建一块领地;

> 自动创建半径是由服务器管理员在配置文件中设置的;
14 changes: 14 additions & 0 deletions docs/en-us/manage-dominion/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 领地管理

领地的管理可以通过领地菜单完成,通常来说您不需要任何指令就可以完成领地的管理。

## 主菜单界面 `/dominion`

使用 `/dominion` 可以打开领地系统的可视化操作菜单界面(TUI)。单击`【我的领地】`可以查看自己创建的所有领地。

## 领地管理界面 `/dominion manage [领地名称]`

单击对应领地的【管理】即可进入对应领地的管理界面,通过管理界面可以管理此领地的权限等信息。 也可以直接输入
`/dominion manage [领地名称]` 来快速打开当前所在领地的管理界面。

> 领地名称是可选的,不填写则自动打开你当前所在的领地管理界面。
16 changes: 16 additions & 0 deletions docs/en-us/manage-dominion/environment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# 环境设置

## 简介

领地环境设置主要包含了领地内的一些非玩家行为的设置,例如TNT爆炸、火焰蔓延等等。

## 设置方法

1. 打开领地菜单 `/dominion`
2.`【我的领地】` 中点击对应领地的 `【管理】`
3. 在领地管理界面中选择 `【环境设置】`
4. 点击对应设置项的权限前的 ☑/☐ 来允许或者禁止对应的领地环境行为。

## 注意事项

- 鼠标移动到权限名称上可以显示此权限的详细(描述)信息;
26 changes: 26 additions & 0 deletions docs/en-us/manage-dominion/group-title.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 权限组称号

## 简介

权限组称号可以用来对外展示玩家在领地的角色/地位/身份,有利于提高领地内的社交性、增强玩家的归属感。

## 领地主要做的事

参照文档完成领地[权限组的配置](permission/permission-group.md),并且添加对应成员;

> 领地主玩家可以使用自己领地的所有权限组称号,所以如果领地主想给自己一个称号可以建一个空权限组专门用来给自己作称号用。
## 成员玩家要做的事

1. 打开领地菜单 `/dominion`
2. 在主菜单点击`【称号列表】`,此处会列出所有你拥有的领地权限组称号,以及该称号来源于哪个领地:
3. 点击对应称号前的【使用】,即可;

## 管理员要做的事

1. 在配置文件中启用 `GroupTitle.Enable`
2. 安装 PlaceholderAPI 插件;
3. 在你想要显示称号的地方(如聊天前缀、TAB列表)添加占位符:`%dominion_group_title%`

> 通常来说你还需要安装一个聊天插件来显示占位符,例如 InteractiveChat、TAB 之类的。
17 changes: 17 additions & 0 deletions docs/en-us/manage-dominion/message.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 领地提示消息

## 进入消息

可以为领地设置玩家进入时的欢迎语句,提示语将在玩家进入领地时弹出。

```
/dominion set_enter_msg <提示语> [领地名称]
```

## 离开消息

可以为领地设置玩家离开时的欢送语句,提示语将在玩家离开领地时弹出。

```
/dominion set_leave_msg <提示语> [领地名称]
```
53 changes: 53 additions & 0 deletions docs/en-us/manage-dominion/permission/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# 权限管理

## 简介

Dominion 采用了 `访客-成员-权限组` 的权限管理模型。通过此方案既可以满足对于权限的细粒度控制,又可以保证权限的可维护性,减轻玩家的操作负担。

- [访客](guest):领地的访客权限,不属于领地成员的玩家将收到此权限的限制;
- [成员](member.md):领地的成员权限,属于领地成员的玩家将收到此权限的限制;
- [权限组](permission-group.md):领地的权限组,将玩家添加到权限组中,可以为多个玩家配置相同的权限;

## 权限模型透视

```
┌───────────┐
│ Player │
└─────┬─────┘
┌───────────┐ ┌───────────┐
│ IsMember? │───►│ HasGroup? │
└─────┬─────┘ Y └──┬────┬───┘
│N │ │
▼ │ │
┌───────────┐ N│ Y│
│ Visitor │ │ │
└───────────┘ │ │
┌───────────┐ │ │
│ Member │◄──────┘ │
└───────────┘ │
┌───────────┐ │
│ Group │◄───────────┘
└───────────┘
```

- 当一个玩家不属于领地成员时将收到访客权限的限制;
- 如果是领地成员那么会判断玩家是否属于权限组;
- 如果玩家属于权限组那么将收到对应权限组的行为控制;
- 如果玩家不属于权限组那么将采用该玩家在此领地中的成员权限;

## 领地管理员

管理员是领地成员权限中的一个特殊权限:

- ✅管理员可以做的事:
- 该领地的其他所有权限
- 修改领地权限
- 修改领地的玩家权限(添加、删除、修改)
- ❌管理员不可以做的事:
- 删除领地
- 修改领地尺寸
- 将其他玩家设置为管理员

通过将一些玩家设置为管理员,可以让他们帮助你管理领地的其他玩家,减轻领地所有人的操作负担。同时不必担心管理员会对领地进行破坏性操作(例如删除、缩小领地)。

19 changes: 19 additions & 0 deletions docs/en-us/manage-dominion/permission/guest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 访客权限

## 简介

访客是相对于领地成员而言的,通过设置访客权限,你可以控制非领地成员的玩家在领地内的行为。

例如:如果你是个大好人希望提供公共物资给服务器内的其他玩家使用,那么你可以将该领地访客权限中的【容器】权限打开。
这样其他玩家就可以在你的领地内使用你的箱子了,无需给他们领地成员的权限。

## 设置方法

1. 打开领地菜单 `/dominion`
2.`【我的领地】` 中点击对应领地的 `【管理】`
3. 在领地管理界面中选择 `【访客权限】`
4. 点击对应设置项的权限前的 ☑/☐ 来允许或者禁止对应的领地环境行为。

## 封禁一个玩家?

Dominion自身并没有直接提供封禁玩家的功能,但是你可以通过将玩家添加为领地成员,然后关闭他的【移动】权限来实现类似的效果。具体操作请参考[领地成员](member.md)
32 changes: 32 additions & 0 deletions docs/en-us/manage-dominion/permission/member.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 领地成员

## 简介

顾名思义。

## 添加成员

1. 打开领地菜单 `/dominion`
2.`【我的领地】` 中点击对应领地的 `【管理】`
3. 在领地管理界面中选择 `【成员管理】`
4. 点击 `【添加成员】`,选择或输入玩家名称添加为领地成员。

## 管理成员

1. 打开领地菜单 `/dominion`
2.`【我的领地】` 中点击对应领地的 `【管理】`
3. 在领地管理界面中选择 `【成员管理】`,此处列出了领地的所有成员;
- 点击 `【配置权限】` 可以配置此成员在领地内的权限;
- 点击 `【移除成员】` 可以将此成员移出领地;
- 如果一个玩家属于某[权限组](permission-group.md),那么你不能单独编辑他的权限,对应`【配置权限】`为灰色不可点击;

玩家名称最前方标记含义:
- 【A】:该领地管理员
- 【N】:普通成员
- 【B】:黑名单成员(没有移动权限)
- 【G】:属于某个权限组

## 注意事项

- 选择成员页面只会显示在安装了Dominion后登录过服务器的玩家名称,因此暂时不支持对从没有在服务器登录过的玩家进行操作。
- 通过搜索框添加成员不支持模糊搜索,需要输入准确的玩家名称(大小写敏感)。
51 changes: 51 additions & 0 deletions docs/en-us/manage-dominion/permission/permission-group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# 权限组

## 简介

权限组可以对一批玩家的权限进行统一的管理、设置,减少大量重复的操作,提高效率。

## 创建权限组

1. 打开领地菜单 `/dominion`
2.`【我的领地】` 中点击对应领地的 `【管理】`
3. 在领地管理界面中选择 `【权限组】`
4. 点击 `【创建权限组】`,输入权限组名称,左键点击绿色混凝土完成创建;

## 权限组成员管理

权限组成员只能是领地成员,因此需要**先将玩家添加为领地成员**,才能将其编入权限组。

- 添加成员:点击权限组后面的`【+】`,选择领地成员;
- 移除成员:点击玩家名字前面的`【-】`

## 管理权限组

- 编辑权限组:点击权限组前的`【编辑】`,配置此权限组的权限或修改权限组的名称;
- 删除权限组:点击权限组前的`【删除】`,删除此权限组;
- 配置权限:在编辑页面,点击对应权限前的 ☑/☐ 来允许或者禁止该权限组内的玩家的行为;

> 注意:删除权限组后,权限组内的成员会被自动移出权限组,成为领地普通成员。
## 其他

- 权限组名称同时也可以作为称号,用来对外展示玩家在领地的角色/地位/身份,详见[权限组称号](../group-title.md)
- 权限组名称支持 RGB 彩色效果,详情参见 [彩色字符](https://ssl.lunadeer.cn:14448/doc/81/)

## Q&A 常见问题

Q:我将玩家 A 编入了权限组 G,还可以手动设置 A 的成员权限吗?

A:不可以,编入权限组 G 后此玩家的行为只能由此权限组控制。

---

Q:我将玩家 A 编入了权限组 G1,还能再编入权限组 G2 吗?

A:不可以,在一个领地内一个玩家只能属于一个权限组,不支持混合。

---

Q:我将玩家 A 编入了权限组 G,然后一不小心删除了权限组 G 会发生生么?

A:玩家会被自动移出权限组,成为领地一般成员。

37 changes: 37 additions & 0 deletions docs/en-us/manage-dominion/permission/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 权限模板

权限模板功能允许你预先配置好一组权限,然后直接将模板套用到成员身上,即可快速将此成员的权限设置为理想的状态。相比于权限组,模板主要适用于某些特殊的、非通用的权限组和。
例如:你并不喜欢权限组的统一性,你希望每个成员都有自己的权限设置,但是又不想每次都手动设置,这时候权限模板就派上用场了。

## 创建一个模板

1. 打开领地菜单 `/dominion`
2. 在主菜单点击`【权限模板】`
3. 点击`【创建成员权限模板】`,输入模板名称,点击绿色混凝土完成创建;
4. 点击模板前的`【管理】`,配置此模板的权限;

## 使用模板

1. 打开领地菜单 `/dominion`
2.`【我的领地】` 中点击对应领地的 `【管理】`
3. 在领地管理界面中选择 `【成员管理】`,此处列出了领地的所有成员;
4. 点击 `【配置权限】` 后,点击 `【套用模板】`
5. 在列表中点击你想要使用的模板,完成权限模板的套用;

## Q&A 常见问题

Q:我将模板 T 套用在了玩家 A 身上,还可以手动设置 A 的成员权限吗?

A:可以。

---

Q:我将模板 T 套用在了玩家 A 身上,修改玩家 A 的权限会同步修改模板 T 的权限吗?

A:不会,模板应用是单向的。

---

Q:我将模板 T 套用在了玩家 A 身上,修改模板 T 的权限会同步修改玩家 A 的权限吗?

A:不会,模板应用是一次性的,类似于批量处理,不会产生连锁影响。
23 changes: 23 additions & 0 deletions docs/en-us/manage-dominion/resize.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# 修改领地尺寸

## 扩大

面向想要扩大的方向,使用命令:

```
/dominion expand [大小] [领地名称]
```

- 大小:可选,默认为10;
- 领地名称:可选,默认为当前所在领地,如果在子领地内则需要指定领地名称;

## 缩小

面向想要缩小的方向,使用命令:

```
/dominion contract [大小] [领地名称]
```

- 大小:可选,默认为10;
- 领地名称:可选,默认为当前所在领地,如果在子领地内则需要指定领地名称;
22 changes: 22 additions & 0 deletions docs/en-us/manage-dominion/sub-dominion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# 创建子领地

## 创建方法

创建方法与普通领地相同,可以使用自动创建,也可以手动创建。

命令分别为:

`/dominion create_sub <子领地名称> [父领地名称]`

`/dominion auto_create_sub <子领地名称> [父领地名称]`

当不填写父领地名称时会尝试以当前所在领地为父领地进行创建。

## 权限

当玩家处在一个子领地内时,其行为只收到子领地的权限控制。
子领地的权限设置与傅领地完全相同,参考[权限管理](permission/README.md)

## 关于子领地嵌套

子领地内部可以再创建子领地,但是子领地的嵌套深度是有限制的,具体嵌套深度由服务器管理员在[配置文件](../operator/config.md)中设置。
17 changes: 17 additions & 0 deletions docs/en-us/manage-dominion/teleport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 领地传送

## 设置传送点

1. 打开领地菜单 `/dominion`
2.`【我的领地】` 中点击对应领地的 `【管理】`
3. 在领地管理界面中选择 `【设置传送点】`,此时你的位置会被设置为领地的传送点。

## 配置权限

- 默认情况下,领地传送的权限是关闭的;
- 如果你希望允许**所有人**都能够传送到你的领地,你可以直接在【访客权限】中将【领地传送】打开;
- 如果你**只希望部分玩家**能够传送过来,那么你可以单独为这部分玩家添加【成员权限】,然后打开他们的【领地传送】权限。

## 传送

使用指令传到目标领地:`/dominion tp <领地名称>`
20 changes: 20 additions & 0 deletions docs/en-us/migration-residence.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 将领地从 Residence 迁移到 Dominion

## 注意事项

1. 迁移采取的“玩家自助”方案,即由玩家自行决定要迁移自己的哪些领地;
2. 目前支持迁移:领地、tp点、欢迎/离开提示消息、子领地;
3. 由于对权限的存储、索引方式不同,目前**不支持**对权限进行迁移;
4. 迁移领地**不会产生二次消费**

## 服主要做的事

1. 删除 Residence 插件,保留其数据文件 `plugins/Residence`;
2. 在 Dominion 配置中将 `ResidenceMigration` 打开(设置为true);

## 玩家要做的事

1. 上线,打开 Dominion 菜单 `/dom`,点击`【迁移数据】`
2. 选择要迁移的 Residence 领地,点击前面的`【迁移】`
3. 完成后即可前往领地列表进一步配置领地的权限等信息:

Loading

0 comments on commit 0a8e193

Please sign in to comment.