diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7884d78..f078414f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,14 +23,18 @@ We welcome suggestions for new features or improvements. Please open an issue on 7. Open a pull request. 8. Wait for your pull request to be reviewed and merged. -#### Documentation +--- + +#### **Documentation** Documentations are located in the `docs` directory. Translate the files in the language you want to contribute to. - If the language you want to translate to does not exist, create a new directory with the language code (e.g., `zh-cn` for Simplified Chinese). - If the documentation is not up-to-date, please update it from the `zh-cn` directory. -#### Plugin Messages +--- + +#### **Plugin Messages** The plugin messages are located in the `languages` directory. Translate the files in the language you want to contribute to. diff --git a/docs/en-us/README.md b/docs/en-us/README.md index f5513694..78820e06 100644 --- a/docs/en-us/README.md +++ b/docs/en-us/README.md @@ -8,9 +8,9 @@ Dominion is a completely open-source, free, future-proof, territory protection p If you encounter any problems during use, or have any suggestions, please feel free to submit your questions or ideas at [GitHub ISSUE](https://github.com/ColdeZhang/Dominion/issues). -## Quick start for players +## Quick start (for players) -1. [How to create a territory](create-dominion.md) +1. [How to create a dominion](create-dominion.md) 2. [Managing your dominion](manage-dominion/README.md) ## Server Administrator Quick Start @@ -18,7 +18,7 @@ If you encounter any problems during use, or have any suggestions, please feel f 1. [Installation, Required Readings, FAQ](operator/README.md) 2. [Configuration File Reference](operator/config.md) -## Help us to translate the documentation +## Quick start (for server administrators) -If you want to help us translate the documentation, please refer to [CONTRIBUTING.md](../CONTRIBUTING.md#documentation). +If you want to help us translate the documentation, please refer to [CONTRIBUTING.md](https://github.com/ColdeZhang/Dominion/blob/master/CONTRIBUTING.md#documentation). diff --git a/docs/en-us/SUMMARY.md b/docs/en-us/SUMMARY.md index d5d89ef7..daa3f346 100644 --- a/docs/en-us/SUMMARY.md +++ b/docs/en-us/SUMMARY.md @@ -20,5 +20,4 @@ * [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) -* [Contributing to development](../CONTRIBUTING.md) \ No newline at end of file + * [Cross-group teleportation (global-tp in testing)](operator/global-tp.md) \ No newline at end of file diff --git a/docs/zh-cn/SUMMARY.md b/docs/zh-cn/SUMMARY.md index 921de281..91f3e8c9 100644 --- a/docs/zh-cn/SUMMARY.md +++ b/docs/zh-cn/SUMMARY.md @@ -21,5 +21,4 @@ * [flags.yml](operator/flags.md) * [特权玩家配置](operator/privilege.md) * [跨群组服传送(global-tp 测试中)](operator/global-tp.md) -* [参与开发](../CONTRIBUTING.md) diff --git a/docs/zh-hk/README.md b/docs/zh-hk/README.md index e779a36d..3dfb8d2f 100644 --- a/docs/zh-hk/README.md +++ b/docs/zh-hk/README.md @@ -20,4 +20,4 @@ Dominion 是一個完全開源、免費,專為高版本開發,面向未來 ## 幫助翻譯本文檔 -如果您想幫助翻譯本文檔,請參考 [翻譯指南](../CONTRIBUTING.md#documentation)。 +如果您想幫助翻譯本文檔,請參考 [翻譯指南](https://github.com/ColdeZhang/Dominion/blob/master/CONTRIBUTING.md#documentation)。 diff --git a/docs/zh-hk/SUMMARY.md b/docs/zh-hk/SUMMARY.md index b0747a1f..25302879 100644 --- a/docs/zh-hk/SUMMARY.md +++ b/docs/zh-hk/SUMMARY.md @@ -21,5 +21,4 @@ * [flags.yml](operator/flags.md) * [特權玩家配置](operator/privilege.md) * [跨群組服傳送(global-tp 測試中)](operator/global-tp.md) -* [參與開發](../CONTRIBUTING.md) diff --git a/docs/zh-hk/command-list.md b/docs/zh-hk/command-list.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/zh-hk/manage-dominion/environment.md b/docs/zh-hk/manage-dominion/environment.md new file mode 100644 index 00000000..b56590ba --- /dev/null +++ b/docs/zh-hk/manage-dominion/environment.md @@ -0,0 +1,16 @@ +# 環境設置 + +## 簡介 + +領地環境設置主要包含了領地內的一些非玩家行為的設置,例如TNT爆炸、火焰蔓延等等。 + +## 設置方法 + +1. 打開領地菜單 `/dominion`; +2. 在 `【我的領地】` 中點擊對應領地的 `【管理】`; +3. 在領地管理界面中選擇 `【環境設置】`; +4. 點擊對應設置項的權限前的 ☑/☐ 來允許或者禁止對應的領地環境行為。 + +## 註意事項 + +- 鼠標移動到權限名稱上可以顯示此權限的詳細(描述)信息; diff --git a/docs/zh-hk/manage-dominion/group-title.md b/docs/zh-hk/manage-dominion/group-title.md new file mode 100644 index 00000000..179a1746 --- /dev/null +++ b/docs/zh-hk/manage-dominion/group-title.md @@ -0,0 +1,26 @@ +# 權限組稱號 + +## 簡介 + +權限組稱號可以用來對外展示玩家在領地的角色/地位/身份,有利於提高領地內的社交性、增強玩家的歸屬感。 + +## 領地主要做的事 + +參照文檔完成領地[權限組的配置](permission/permission-group.md),並且添加對應成員; + +> 領地主玩家可以使用自己領地的所有權限組稱號,所以如果領地主想給自己一個稱號可以建一個空權限組專門用來給自己作稱號用。 + +## 成員玩家要做的事 + +1. 打開領地菜單 `/dominion`; +2. 在主菜單點擊`【稱號列表】`,此處會列出所有你擁有的領地權限組稱號,以及該稱號來源於哪個領地: +3. 點擊對應稱號前的【使用】,即可; + +## 管理員要做的事 + +1. 在配置文件中啟用 `GroupTitle.Enable`; +2. 安裝 PlaceholderAPI 插件; +3. 在你想要顯示稱號的地方(如聊天前綴、TAB列表)添加占位符:`%dominion_group_title%`; + +> 通常來說你還需要安裝一個聊天插件來顯示占位符,例如 InteractiveChat、TAB 之類的。 + diff --git a/docs/zh-hk/manage-dominion/message.md b/docs/zh-hk/manage-dominion/message.md new file mode 100644 index 00000000..f45faa80 --- /dev/null +++ b/docs/zh-hk/manage-dominion/message.md @@ -0,0 +1,17 @@ +# 領地提示消息 + +## 進入消息 + +可以為領地設置玩家進入時的歡迎語句,提示語將在玩家進入領地時彈出。 + +``` +/dominion set_enter_msg <提示語> [領地名稱] +``` + +## 離開消息 + +可以為領地設置玩家離開時的歡送語句,提示語將在玩家離開領地時彈出。 + +``` +/dominion set_leave_msg <提示語> [領地名稱] +``` diff --git a/docs/zh-hk/manage-dominion/permission/README.md b/docs/zh-hk/manage-dominion/permission/README.md new file mode 100644 index 00000000..e9a3ff22 --- /dev/null +++ b/docs/zh-hk/manage-dominion/permission/README.md @@ -0,0 +1,53 @@ +# 權限管理 + +## 簡介 + +Dominion 采用了 `訪客-成員-權限組` 的權限管理模型。通過此方案既可以滿足對於權限的細粒度控製,又可以保證權限的可維護性,減輕玩家的操作負擔。 + +- [訪客](guest):領地的訪客權限,不屬於領地成員的玩家將收到此權限的限製; +- [成員](member.md):領地的成員權限,屬於領地成員的玩家將收到此權限的限製; +- [權限組](permission-group.md):領地的權限組,將玩家添加到權限組中,可以為多個玩家配置相同的權限; + +## 權限模型透視 + +``` +┌───────────┐ +│ Player │ +└─────┬─────┘ + ▼ +┌───────────┐ ┌───────────┐ +│ IsMember? │───►│ HasGroup? │ +└─────┬─────┘ Y └──┬────┬───┘ + │N │ │ + ▼ │ │ +┌───────────┐ N│ Y│ +│ Visitor │ │ │ +└───────────┘ │ │ +┌───────────┐ │ │ +│ Member │◄──────┘ │ +└───────────┘ │ +┌───────────┐ │ +│ Group │◄───────────┘ +└───────────┘ +``` + +- 當一個玩家不屬於領地成員時將收到訪客權限的限製; +- 如果是領地成員那麽會判斷玩家是否屬於權限組; +- 如果玩家屬於權限組那麽將收到對應權限組的行為控製; +- 如果玩家不屬於權限組那麽將采用該玩家在此領地中的成員權限; + +## 領地管理員 + +管理員是領地成員權限中的一個特殊權限: + +- ✅管理員可以做的事: + - 該領地的其他所有權限 + - 修改領地權限 + - 修改領地的玩家權限(添加、刪除、修改) +- ❌管理員不可以做的事: + - 刪除領地 + - 修改領地尺寸 + - 將其他玩家設置為管理員 + +通過將一些玩家設置為管理員,可以讓他們幫助你管理領地的其他玩家,減輕領地所有人的操作負擔。同時不必擔心管理員會對領地進行破壞性操作(例如刪除、縮小領地)。 + diff --git a/docs/zh-hk/manage-dominion/permission/guest.md b/docs/zh-hk/manage-dominion/permission/guest.md new file mode 100644 index 00000000..22a6b8f3 --- /dev/null +++ b/docs/zh-hk/manage-dominion/permission/guest.md @@ -0,0 +1,19 @@ +# 訪客權限 + +## 簡介 + +訪客是相對於領地成員而言的,通過設置訪客權限,你可以控製非領地成員的玩家在領地內的行為。 + +例如:如果你是個大好人希望提供公共物資給服務器內的其他玩家使用,那麽你可以將該領地訪客權限中的【容器】權限打開。 +這樣其他玩家就可以在你的領地內使用你的箱子了,無需給他們領地成員的權限。 + +## 設置方法 + +1. 打開領地菜單 `/dominion`; +2. 在 `【我的領地】` 中點擊對應領地的 `【管理】`; +3. 在領地管理界面中選擇 `【訪客權限】`; +4. 點擊對應設置項的權限前的 ☑/☐ 來允許或者禁止對應的領地環境行為。 + +## 封禁一個玩家? + +Dominion自身並沒有直接提供封禁玩家的功能,但是你可以通過將玩家添加為領地成員,然後關閉他的【移動】權限來實現類似的效果。具體操作請參考[領地成員](member.md)。 \ No newline at end of file diff --git a/docs/zh-hk/manage-dominion/permission/member.md b/docs/zh-hk/manage-dominion/permission/member.md new file mode 100644 index 00000000..178d203c --- /dev/null +++ b/docs/zh-hk/manage-dominion/permission/member.md @@ -0,0 +1,32 @@ +# 領地成員 + +## 簡介 + +顧名思義。 + +## 添加成員 + +1. 打開領地菜單 `/dominion`; +2. 在 `【我的領地】` 中點擊對應領地的 `【管理】`; +3. 在領地管理界面中選擇 `【成員管理】`; +4. 點擊 `【添加成員】`,選擇或輸入玩家名稱添加為領地成員。 + +## 管理成員 + +1. 打開領地菜單 `/dominion`; +2. 在 `【我的領地】` 中點擊對應領地的 `【管理】`; +3. 在領地管理界面中選擇 `【成員管理】`,此處列出了領地的所有成員; + - 點擊 `【配置權限】` 可以配置此成員在領地內的權限; + - 點擊 `【移除成員】` 可以將此成員移出領地; + - 如果一個玩家屬於某[權限組](permission-group.md),那麽你不能單獨編輯他的權限,對應`【配置權限】`為灰色不可點擊; + +玩家名稱最前方標記含義: +- 【A】:該領地管理員 +- 【N】:普通成員 +- 【B】:黑名單成員(沒有移動權限) +- 【G】:屬於某個權限組 + +## 註意事項 + +- 選擇成員頁面只會顯示在安裝了Dominion後登錄過服務器的玩家名稱,因此暫時不支持對從沒有在服務器登錄過的玩家進行操作。 +- 通過搜索框添加成員不支持模糊搜索,需要輸入準確的玩家名稱(大小寫敏感)。 diff --git a/docs/zh-hk/manage-dominion/permission/permission-group.md b/docs/zh-hk/manage-dominion/permission/permission-group.md new file mode 100644 index 00000000..9b732fa1 --- /dev/null +++ b/docs/zh-hk/manage-dominion/permission/permission-group.md @@ -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:玩家會被自動移出權限組,成為領地一般成員。 + diff --git a/docs/zh-hk/manage-dominion/permission/template.md b/docs/zh-hk/manage-dominion/permission/template.md new file mode 100644 index 00000000..7f1fcb14 --- /dev/null +++ b/docs/zh-hk/manage-dominion/permission/template.md @@ -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:不會,模板應用是一次性的,類似於批量處理,不會產生連鎖影響。 \ No newline at end of file diff --git a/docs/zh-hk/manage-dominion/resize.md b/docs/zh-hk/manage-dominion/resize.md new file mode 100644 index 00000000..b6f5c991 --- /dev/null +++ b/docs/zh-hk/manage-dominion/resize.md @@ -0,0 +1,23 @@ +# 修改領地尺寸 + +## 擴大 + +面向想要擴大的方向,使用命令: + +``` +/dominion expand [大小] [領地名稱] +``` + +- 大小:可選,默認為10; +- 領地名稱:可選,默認為當前所在領地,如果在子領地內則需要指定領地名稱; + +## 縮小 + +面向想要縮小的方向,使用命令: + +``` +/dominion contract [大小] [領地名稱] +``` + +- 大小:可選,默認為10; +- 領地名稱:可選,默認為當前所在領地,如果在子領地內則需要指定領地名稱; diff --git a/docs/zh-hk/manage-dominion/sub-dominion.md b/docs/zh-hk/manage-dominion/sub-dominion.md new file mode 100644 index 00000000..082c41af --- /dev/null +++ b/docs/zh-hk/manage-dominion/sub-dominion.md @@ -0,0 +1,22 @@ +# 創建子領地 + +## 創建方法 + +創建方法與普通領地相同,可以使用自動創建,也可以手動創建。 + +命令分別為: + +`/dominion create_sub <子領地名稱> [父領地名稱]` + +`/dominion auto_create_sub <子領地名稱> [父領地名稱]` + +當不填寫父領地名稱時會嘗試以當前所在領地為父領地進行創建。 + +## 權限 + +當玩家處在一個子領地內時,其行為只收到子領地的權限控製。 +子領地的權限設置與傅領地完全相同,參考[權限管理](permission/README.md)。 + +## 關於子領地嵌套 + +子領地內部可以再創建子領地,但是子領地的嵌套深度是有限製的,具體嵌套深度由服務器管理員在[配置文件](../operator/config.md)中設置。 diff --git a/docs/zh-hk/manage-dominion/teleport.md b/docs/zh-hk/manage-dominion/teleport.md new file mode 100644 index 00000000..2c75479e --- /dev/null +++ b/docs/zh-hk/manage-dominion/teleport.md @@ -0,0 +1,17 @@ +# 領地傳送 + +## 設置傳送點 + +1. 打開領地菜單 `/dominion`; +2. 在 `【我的領地】` 中點擊對應領地的 `【管理】`; +3. 在領地管理界面中選擇 `【設置傳送點】`,此時你的位置會被設置為領地的傳送點。 + +## 配置權限 + +- 默認情況下,領地傳送的權限是關閉的; +- 如果你希望允許**所有人**都能夠傳送到你的領地,你可以直接在【訪客權限】中將【領地傳送】打開; +- 如果你**只希望部分玩家**能夠傳送過來,那麽你可以單獨為這部分玩家添加【成員權限】,然後打開他們的【領地傳送】權限。 + +## 傳送 + +使用指令傳到目標領地:`/dominion tp <領地名稱>` diff --git a/docs/zh-hk/migration-residence.md b/docs/zh-hk/migration-residence.md new file mode 100644 index 00000000..6f12e60b --- /dev/null +++ b/docs/zh-hk/migration-residence.md @@ -0,0 +1,19 @@ +# 將領地從 Residence 遷移到 Dominion + +## 註意事項 + +1. 遷移采取的「玩家自助」方案,即由玩家自行決定要遷移自己的哪些領地; +2. 目前支持遷移:領地、tp點、歡迎/離開提示消息、子領地; +3. 由於對權限的存儲、索引方式不同,目前**不支持**對權限進行遷移; +4. 遷移領地**不會產生二次消費**; + +## 服主要做的事 + +1. 刪除 Residence 插件,保留其數據文件 `plugins/Residence`; +2. 在 Dominion 配置中將 `ResidenceMigration` 打開(設置為true); + +## 玩家要做的事 + +1. 上線,打開 Dominion 菜單 `/dom`,點擊`【遷移數據】`: +2. 選擇要遷移的 Residence 領地,點擊前面的`【遷移】`; +3. 完成後即可前往領地列表進一步配置領地的權限等信息: diff --git a/languages/en-us.yml b/languages/en-us.yml index e69de29b..96f1b989 100644 --- a/languages/en-us.yml +++ b/languages/en-us.yml @@ -0,0 +1,5 @@ +# Help us to translate this file into your language. +# Guide: https://github.com/ColdeZhang/Dominion/blob/master/CONTRIBUTING.md#plugin-messages +# Don't forget to leave your name here, so that we can give you credit for your translation. +# Translated by: YOUR_NAME_HERE + diff --git a/languages/zh-hk.yml b/languages/zh-hk.yml index 8c93c579..80d24213 100644 --- a/languages/zh-hk.yml +++ b/languages/zh-hk.yml @@ -1,3 +1,8 @@ +# Help us to translate this file into your language. +# Guide: https://github.com/ColdeZhang/Dominion/blob/master/CONTRIBUTING.md#plugin-messages +# Don't forget to leave your name here, so that we can give you credit for your translation. +# Translated by: YOUR_NAME_HERE + Commands: Dominion: SetFlagUsage: '用法: /dominion set <權限名稱> [領地名稱]'