更改了几个“插件”部分文章的格式和措辞 (#90)

* 更改“插件”部分格式

* 更新“插件选择”格式

* 更改”插件配置“

* 更改“插件特征文件”

* 更改“插件缩写”

* 格式

* 格式

* 编写“用户组”
This commit is contained in:
igoby 2024-06-15 16:32:35 +08:00 committed by GitHub
parent cf62d0d47a
commit c67943f335
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 145 additions and 117 deletions

View File

@ -7,15 +7,13 @@ sidebar_position: 3
插件的配置文件一般在 `/plugins/插件名字/` 文件夹中,常见的配置文件一般是 `config.yml`
> 一般插件会使用**Yaml**作为配置文件格式,建议先学习 [Yaml](/docs/sundry/YAML/overview.md)
> 插件一般会使用 **Yaml** 作为配置文件格式,建议先学习 [Yaml](/docs/sundry/YAML/overview.md) 语法。
我们在开始前所做的准备工作中,推荐你安装任意一款推荐的文档编辑软件。
(如果你还没有安装,请立刻查看[准备工作](/docs/preparation/text-editor.md)
我们在开始前所做的准备工作中,推荐你安装任意一款推荐的文档编辑软件:请查看[准备工作](/docs/preparation/text-editor.md)
如果你是 Windows ,现在让我们双击 .yml 文件就可以开始修改配置文件了!
如果你是 Linux 如果你认为这很难操作,可以通过 SFTP 下载到自己的电脑上编辑。
如果你是 Linux 并且认为这很难操作,可以通过 SFTP 下载到自己的电脑上编辑。
## 如何汉化插件?
@ -24,18 +22,18 @@ sidebar_position: 3
<details>
<summary>插件自己动♂</summary>
luckpermsessentials你服务器和客户端的语言设置成简体中文即可
Luckperms、 EssentialX 等,只要你的服务器和客户端的语言为简体中文,它们会自动设置为中文。
</details>
<details>
<summary>配置文件改语言</summary>
像 HoloMobHealth Gsit ,你可以在插件配置文件中(一般在 config.yml 中)找到 Language lang 等字眼
像 HoloMobHealth Gsit ,你可以在插件配置文件中(一般在 config.yml 中)找到 Language lang 等字眼
然后把把后面改成 zhcnzh-cnzh-CNchinese 啥的,具体应该写什么这地方的注释可能提到,没提到那得靠你自己寻找了
然后把语言项改成 zhcn、 chinese 等,具体应该写什么这地方。插件配置的注释可能提到,没提到那得靠你自己寻找了
比如**有时**可以用压缩软件打开插件jar文件找找
**有时**可以用压缩软件打开插件 jar 文件找找
![](_images/概览/拆开jar.png)
@ -44,9 +42,9 @@ sidebar_position: 3
<details>
<summary>自行汉化</summary>
有些插件不提供别的语言,只提供一个语言文件 如 lang.ymlmessage.yml
有些插件不提供别的语言,只提供一个语言文件 如 lang.yml、 message.yml 。
就需要你自行汉化里面的内容了,去一些论坛翻翻也许能找到别人分享的汉化
就需要你自行汉化里面的内容了,去一些论坛翻翻也许能找到别人分享的汉化
### GPT汉化
@ -57,7 +55,8 @@ sidebar_position: 3
```
备注:本教程并非推荐服主通过 GPT 等 AI 进行机翻,我们不对服主利用 AI 产生文本的行为及其内容负责。
在正常 Minecraft 服主群体中,使用 GPT 会被视作一种经济但欠缺考虑的行为,若有能力或财力充足,请尽力贡献人工翻译或自行翻译,万不可直接交由机翻,否则可能会对玩家的游玩体验造成极大的损害。
使用 GPT 可能会被视作一种经济但欠缺考虑的行为,若有能力或财力充足,请尽力贡献人工翻译或自行翻译,万不可直接使用机翻,轻则翻译错误,重则使插件读取不了 config 。
</details>
@ -66,6 +65,6 @@ sidebar_position: 3
如果你要用的这个插件没有以上所提到的所有情况...
他**可能**把你要改的语言直接写死在代码里了,你要自己去改代码
他**可能**把你要改的语言直接写死在代码里了,你要自己去改代码...
</details>

View File

@ -5,11 +5,11 @@ sidebar_position: 2
# 什么是权限
举个栗子你想要执行Essentials插件的tpa命令那么你需要 `essentials.tpa`这个权限
举个栗子,你想要执行 Essentials 插件的tpa命令那么你需要 `essentials.tpa` 这个权限
:::note
大佬们想要这个起作用当然需要装Essentials插件了
大佬们,想要这个起作用当然需要装 Essentials 插件了...
:::
@ -17,18 +17,18 @@ sidebar_position: 2
## 权限节点
形如 xxx.xxx 或者 xxx.xxx.xxx
形如 xxx.xxx 或者 xxx.xxx.xxx
比如上面提到的essentials.tpa 我们称为权限节点
比如上面提到的 essentials.tpa 我们称为权限节点
(当然你别认为所有xxx.xxx都是权限节点)
(当然你别认为所有 xxx.xxx 都是权限节点)
权限节点一般第一个 xxx 是插件名
权限节点一般第一项是插件名。
## 权限的状态
权限有三种状态
权限有三种状态
| 状态 | 描述 |
| --- | --- |
@ -36,14 +36,14 @@ sidebar_position: 2
|false | 禁止 |
|undefined | 未设置 |
> true 和false好理解那undefined是什么
**true 和 false 好理解,那 undefined 是什么?**
如果这个权限没有被权限组插件设置分两种情况如果在plugin.yml声明可选择是默认有、op有还是全都没有不然就是插件自己判断了
undefined 表示权限未在 LuckPerms 中明确设置。
还是啃上面tpa的栗子`essentials.tpa`是玩家是默认没有的
这通常意味着它的默认值是 false 。
如果你在没有对这个权限进行设置,执行/tpa会被拒绝
在极少数情况下,插件会将未定义的权限默认为 true在这种情况下你需要将其明确设置为 false 。
### op是不是拥有所有权限
### op 是不是拥有所有权限
当然了。。。不过你可以给这名op玩家明确设置某权限是false
当然了,不过你可以给这名 op 玩家明确设置某权限是 false 。

View File

@ -7,17 +7,17 @@ sidebar_position: 1
:::info
`官网` :https://luckperms.net/
`官网` https://luckperms.net/
`SpigotMC` :https://www.spigotmc.org/resources/luckperms.28140/
`SpigotMC` https://www.spigotmc.org/resources/luckperms.28140/
`GitHub` :https://github.com/LuckPerms/LuckPerms
`GitHub` https://github.com/LuckPerms/LuckPerms
`文档(英文)` :https://luckperms.net/wiki/Home
`文档(英文)` https://luckperms.net/wiki/Home
`文档(中文)` :https://snowcutieowo.github.io/LuckPerms/
`文档(中文)` https://snowcutieowo.github.io/LuckPerms/
`插件百科` :https://mineplugin.org/LuckPerms
`插件百科` https://mineplugin.org/LuckPerms
:::
@ -34,6 +34,6 @@ sidebar_position: 1
## 下载
下载jar文件放入plugins文件夹即可
下载 jar 文件放入 plugins 文件夹即可
[点击此处查看教程](https://snowcutieowo.github.io/LuckPerms/#/install-on-a-single-server)
[点击此处查看教程](https://snowcutieowo.github.io/LuckPerms/#/install-on-a-single-server)

View File

@ -5,4 +5,24 @@ sidebar_position: 3
# 权限组
请看:[Luckperms 中文教程](https://izzelaliz.gitbooks.io/luckperms-wiki/content/Usage.html)
与其单独为每个玩家设置权限,我们可以将权限捆绑为一组,然后直接将一大堆权限一起给予玩家。
比如我想让狗蛋拥有 `essentials.fly` 的权限,我可以直接新建一个权限组并添加权限,然后将狗蛋设置到此权限组。
首先让我们创建一个叫做 `NBplus` 的权限组。
运行 `/luckperms creategroup NBplus` 命令,这会创建一个名叫 `NBplus` 的空权限组。
接下来,运行 `/luckperms group NBplus permission set essentials.fly true`,将 fly 的权限添加到权限组里。
然后我们要把狗蛋加到这个权限组,运行 `/luckperms user GouDan parent add NBplus`
成功了,狗蛋现在能上天了!
**默认权限组的权限有好多啊!我懒得重新加权限到新的权限组了,每次有更改还要一起改一大堆!怎么办?**
我们可以用到**继承**。
运行 `/luckperms group NBplus parent add default`,这样就能让 NBplus 权限组继承所有默认权限组中的权限。
更多请查看:[Luckperms 中文教程](https://izzelaliz.gitbooks.io/luckperms-wiki/content/Usage.html)

View File

@ -11,28 +11,30 @@ sidebar_position: 1
**建议阅读**
- [YAML 语法](/docs/sundry/YAML/overview.md) - 了解你书写配置的语法
- [插件特征文件](/docs/process/plugin/plugin-signature-file.md) - 了解插件的一些信息
- [格式化代码](/docs/sundry/format-code.md) - 了解彩色字体,下划线,删除线等
- [MiniMessage](/docs/sundry/MiniMessage.md) - 了解RGB颜色文本悬浮和点击文字执行等
- [YAML 语法](/docs/sundry/YAML/overview.md) - 了解大部分插件配置文件的语法。
- [插件特征文件](/docs/process/plugin/plugin-signature-file.md) - 了解插件的一些信息
- [格式化代码](/docs/sundry/format-code.md) - 了解彩色字体,下划线,删除线等
- [MiniMessage](/docs/sundry/MiniMessage.md) - 了解RGB颜色文本悬浮和点击文字执行等
:::danger
服务器在**开发阶段**可以使用 PlugmanXServerUtils 等插件热重载插件
服务器在**开发阶段**可以使用 PlugmanXServerUtils 等插件热重载插件
过了开发阶段后切记,多数插件自带了重载(如 Placeholder 的重载指令为papi reload
过了开发阶段后切记,多数插件自带了重载 (如 Placeholder 的重载指令为papi reload)。
尽量少使用插件重载插件,因为如果插件本身并不支持热重载,即使热重载了也容易出问题。
尽量少使用热重载插件,因为如果插件本身并不支持热重载,即使热重载了也容易出问题。
请阅读[此文章](https://madelinemiller.dev/blog/problem-with-reload/)来了解为何。
:::
## 如何安装插件?
将插件的 jar 文件放入服务端的 `plugins` 文件夹
将插件的 jar 文件放入服务端的 `plugins` 文件夹
### 笨蛋脚本
下载此[脚本](https://github.com/lilingfengdev/NitWiki-Script/releases/download/windows-latest/auto-install-depend.exe),我们会为你安装常用插件(自动)
下载此[脚本](https://github.com/lilingfengdev/NitWiki-Script/releases/download/windows-latest/auto-install-depend.exe),我们会为你安装常用插件(自动)
<details>
<summary>安装的插件列表</summary>
@ -64,12 +66,12 @@ Via自动安装已经移动到[此处](./other/跨版本/概览.md#笨蛋脚本)
## 检查插件安装
使用 `/plugins`或者`/pl` 列出插件列表
使用 `/plugins`或者`/pl` 列出插件列表
![](_images/概览/插件列表.png)
绿色为已加载(不是代表你日后使用不报错,只是这里加载上了)
绿色为已加载(不是代表你日后使用不报错,只是这里加载上了)
红色为加载失败(服务端检测到了这个插件,但是没加载上,去控制台看看报错)
红色为加载失败(服务端检测到了这个插件,但是没加载上,去控制台看看报错)
如果这里没有你的插件...服务端甚至没识别这是个插件,去看看你的文件有啥问题
如果这里没有你的插件...服务端甚至没识别这是个插件,去看看你的文件有啥问题

View File

@ -5,8 +5,12 @@ sidebar_position: 7
# 部分插件缩写
***如果你不确定或不知道缩写该是什么,请不要随便使用缩写!***
下面列出了常用插件的缩写:
<details>
<summary> 部分插件的缩写,点击查看 </summary>
<summary> 点击查看 </summary>
AP 通常指楠木的 AttributePlus

View File

@ -5,16 +5,20 @@ sidebar_position: 2
# 插件选择
很好,相信你已经在[可能用到的网站](/docs/preparation/websites)看到了很多链接, 面对成千上万的插件我们应该如何进行选择呢?
很好,相信你已经在[可能用到的网站](/docs/preparation/websites)看到了很多链接,面对成千上万的插件我们应该如何进行选择呢?
我们在此以spigot.org为例(假设您已经注册成功) 讲解如何选择插件.
我们在此以spigot.org为例(假设你已经注册成功),讲解如何选择插件。
1. (*可选,推荐*)安装一个spigot专用的[搜索引擎](https://fof1092.de/Plugins/SSE/Redirect/) 作为浏览器插件安装即可. 使用spigot search engine(spigot搜索引擎)后, 你能得到比spigot自带的搜索相关性强得多的搜索结果.
1. (*可选,推荐*)安装一个spigot专用的[搜索引擎](https://fof1092.de/Plugins/SSE/Redirect/)作为浏览器插件安装即可。
2. (*可选*)如果你觉得大量的英语很头大, 请打开你的浏览器自带的翻译器, 如edge/chrome
使用spigot search engine(spigot搜索引擎)后, 你能得到比spigot自带的搜索相关性强得多的搜索结果。
2. (*可选*)如果你觉得大量的英语很头大,请打开你的浏览器自带的翻译器,如 edge/chrome。
![](_images/概览/浏览器翻译.png)
3. 就像逛淘宝一样, 根据你的需求将你认为有用的插件收藏起来. 最好是分门别类放在一起, 我们以随机 TP 插件为例, 我们在此搜索 RTP
4. 就像逛淘宝一样,根据你的需求将你认为有用的插件收藏起来。
最好是分门别类放在一起,我们以随机 TP 插件为例,我们在此搜索 RTP
<details>
<summary>安装搜索引擎后应该长啥样?</summary>
@ -23,35 +27,42 @@ sidebar_position: 2
</details>
4. 查看这些插件的下载次数、最后更新时间、评价分数、插件特性、语言支持、是否开源、是否付费等. 如果符合以下的标准, 可以尝试下载几个并收藏这些插件(建议同类型插件选择大概3-5个最后选一个).
4. 查看这些插件的下载次数、最后更新时间、评价分数、插件特性、语言支持、是否开源、是否付费等。
如果符合以下的标准,可以尝试下载几个并收藏这些插件 (建议同类型插件选择大概 3 ~ 5 个,最后选出一个综合最好的)。
:::info
对于大多数插件, 选择人数较多(同类型插件前50%) 更新维护更频繁, 用户评价多且平均分高, 插件特性满足需要(注意不是越多越好)
对于大多数插件,选择人数较多(同类型插件前50%),更新维护更频繁,用户评价多且平均分高,插件特性满足需要(注意不是越多越好)
支持语言切换甚至直接支持全中文翻译, 开源, 免费的插件对于大多数服主来说是合理的.
支持语言切换甚至直接支持全中文翻译,开源,免费的插件对于大多数服主来说是合理的
:::
5. 将选好的同类型插件安装到服务器测试一下, 是否有bug 是否特性能满足需求.
5. 将选好的同类型插件安装到服务器测试一下,是否有 bug ,是否能满足你的需求。
6. 如果你不嫌麻烦, 可以在 Excel 中分析插件的优劣并打分, 如图比较了当前下载量前5的随机TP插件. 每个服务器可根据自己的需求自行评价, 下图只是一个抛砖引玉的作用, 如果你看重粒子效果/title/音效等依然可以加入到表格中, 然后根据自己的需求选择其中一个即可, ***不要装多个同类型插件如CMI/ESS一起装***
6. 如果你不嫌麻烦,可以在 Excel 中分析插件的优劣并打分下图比较了当前下载量前5的随机TP插件。
每个服务器可根据自己的需求自行评价,下图只是一个抛砖引玉的作用,根据自己的需求选择其中一个即可:
![](_images/概览/同类插件评分选择.png)
***不要装多个同类型插件不要把CMI和EssentialX装在一起也不要一个服务器装 3 ~ 4 个菜单插件!!!***
## 如何下载插件历史版本?
**建议**您用**最新版本**的插件,但如果您因为一些原因必须要用旧版的话...
**建议**你用**最新版本**的插件,但如果你因为一些原因必须要用旧版的话...
<details>
<summary>Bukkit</summary>
![](_images/概览/历史版本-bukkit-1.png)
点击左侧文字可以查看详细内容
点击左侧文字可以查看详细内容
![](_images/概览/历史版本-bukkit-2.png)
这是更新日志
是更新日志
![](_images/概览/历史版本-bukkit-3.png)
@ -67,11 +78,11 @@ sidebar_position: 2
<details>
<summary>GitHub</summary>
在 Releases 中往下翻
在 Releases 中往下翻
![](_images/概览/历史版本-GitHub-1.png)
或者这样子
或者这样子
![](_images/概览/历史版本-GitHub-2.png)
@ -97,46 +108,44 @@ sidebar_position: 2
</details>
<details>
<summary>目录下有文件夹</summary>
<summary>插件文件夹</summary>
插件文件夹中有Languagelanglocale之类的文件夹(或其他东西?)
插件文件夹中有类似 Language、 lang、 locale 之类的文件夹(或其他东西?)
![](_images/概览/查看语言-1.png)
找 zhcnzh-cnzh-CNchinese 等字眼
请寻找 zhcn、 zh-cn、 zh-CN、 chinese 等字眼:
![](_images/概览/查看语言-2.png)
然后一般要去插件配置文件把语言改成这里的文件名(此处为zh_cn)
然后一般要去插件配置文件多数为config.yml) 把语言改成这里的文件名 (此处为zh_cn)
</details>
<details>
<summary>Crowdin</summary>
比如 https://www.spigotmc.org/resources/simpleclans.71242/
可以看到,语言那里给了个网站
比如 https://www.spigotmc.org/resources/simpleclans.71242/,我们可以看到,语言那里给了个[链接](https://crowdin.com/project/simpleclans)
![](_images/概览/查看语言-crowdin.png)
https://crowdin.com/project/simpleclans
看到有 Chinese Simplified chinese zh_cn zh_CN 之类的字眼就行
看到有 Chinese Simplified、 chinese、 zh_cn、 zh_CN 之类的字眼就行。
</details>
<details>
<summary>拆开插件jar文件</summary>
<summary>直接拆开插件 jar 文件</summary>
比如 SkinsRestorer
比如 SkinsRestorer
在插件文件夹找不到语言文件夹
如果我们在插件文件夹找不到语言文件夹,可以直接用解压缩软件打开 jar 包:
![](_images/概览/查看语言-拆开jar.png)
</details>
还有可能写在插件文档里在项目README里在配置文件的注释里
还有可能写在插件文档里在项目README里甚至在配置文件的注释里
[如何把插件语言改成中文?/如何汉化插件?](/docs/process/plugin/config.md#如何汉化插件)
还是找不到? 你可能需要自己翻译了:
[如何把插件语言改成中文?/如何汉化插件?](/docs/process/plugin/config.md#如何汉化插件)

View File

@ -5,115 +5,109 @@ sidebar_position: 6
# plugin.yml
用解压缩软件打开插件的jar文件就可以看到 `plugin.yml`
用解压缩软件打开插件的jar文件就可以看到 `plugin.yml`
![](_images/plugin.yml/拆开jar.png)
用文本编辑器可以打开它
用文本编辑器可以打开它
![](_images/plugin.yml/plugin.yml.png)
其实只有 `name``main` 是必填的,其他可写可不写
其实只有 `name``main` 是必填的,其他可写可不写
比如一个插件有提供命令,但它不在 `plugin.yml` 中写 `commands` 也是很常见的
但是你的插件如果只有这两个……
你在用啥邪门小插件
比如一个插件有提供命令,但它不在 `plugin.yml` 中写 `commands` 也是很常见的。
## 常见的键
:::tip
其实这里面写什么都可以,但多数就那么几样
下面是常见的一些键值
其实这里面写什么都可以,但多数就那么几样...
:::
下面是常见的一些键值:
## `name`
插件的名字,也是会在插件列表(`/pl`)和日志中输出的信息中显示的插件名
插件的名字,也是会在插件列表(`/pl`)和日志中输出的信息中显示的插件名
## `version`
插件版本,显示在 `/version 插件名`
插件版本,显示在 `/version 插件名`
## `main`
插件主类,加载插件时运行的类的名称,类似正常程序中的 main 函数,服主不用管
插件主类,加载插件时运行的类的名称,类似正常程序中的 main 函数,服主不用管
## `description`
简短描述插件的作用,会在 `/pl` 命令中鼠标悬浮在插件名称上时显示
简短描述插件的作用,会在 `/pl` 命令中鼠标悬浮在插件名称上时显示
## `authors`
插件作者,显示在 `/version 插件名`
插件作者,显示在 `/version 插件名`
## `contributors`
贡献者,指非作者但为插件贡献了代码的人
贡献者,指非作者但为插件贡献了代码的人
## `website`
插件相关的网站,显示在 `/version 插件名`
插件相关的网站,显示在 `/version 插件名`
## `api-version`
插件编译时使用的 API 版本,影响着 BukkitAPI 对插件提供的兼容性
插件编译时使用的 API 版本,影响着 BukkitAPI 对插件提供的兼容性
## `load`
这告诉服务器何时加载插件。它可以是 `STARTUP``POSTWORLD` 。如果未指定,将默认为 `POSTWORLD`
这告诉服务器何时加载插件。它可以是 `STARTUP``POSTWORLD` 如果未指定,将默认为 `POSTWORLD`
## `prefix`
在服务器日志中显示的前缀,有别于插件名称
在服务器日志中显示的前缀,有别于插件名称
## `libraries`
插件的依赖库表,不过这并不是前置插件的意思
插件的依赖库表,不过这并不是前置插件的意思,而是插件开发时用到的依赖。
## `permissions`
插件权限相关
插件权限相关
## `default-permission`
默认权限
默认权限
## `commands`
插件提供的命令
插件提供的命令
## Dependencies
https://docs.papermc.io/paper/dev/plugin-yml#dependencies
依赖关系
[依赖关系](https://docs.papermc.io/paper/dev/plugin-yml#dependencies)。
### `depend`
硬依赖,必须安装
硬依赖,必须安装
### `softdepend`
软依赖,即不必须装的依赖
软依赖,即不必须装的依赖
### `loadbefore`
在此列表中的插件加载前加载本插件
在此列表中的插件加载前加载本插件
### `probides`
告诉服务器本插件会提供哪些库或功能
告诉服务器本插件会提供哪些库或功能
## `folia-supported`
当此项为 `true`Folia 端才会尝试加载此插件
当此项为 `true`Folia 端才会尝试加载此插件
如果插件的 `plugin.yml` 里没有此项,你可以试着手动添加
如果插件的 `plugin.yml` 里没有此项,你可以试着手动添加
```
folia-supported: true
@ -121,12 +115,12 @@ folia-supported: true
:::danger
Folia 端对 Bukkit API 的修改是破坏性的,你手动添加而不是插件开发者去兼容,通常加载了也是不可用的
Folia 端对 Bukkit API 的修改是破坏性的,你手动添加而不是插件开发者去兼容,通常加载了也是不可用的
这就是为什么要开启此项 Folia 端才会加载插件
这就是为什么要开启此项 Folia 端才会加载插件
:::
# 参考
- https://docs.papermc.io/paper/dev/plugin-yml
- https://docs.papermc.io/paper/dev/plugin-yml