Browse Source

reorganize files

zkitefly-patch-1
Yuhui Huang 3 years ago
parent
commit
bd2a67da63
  1. BIN
      Multiplayer/Help/HMCL联机(.md).zip
  2. 1
      Multiplayer/Help/OWNERS
  3. 1
      Multiplayer/OWNERS
  4. 44
      README.md
  5. BIN
      assets/img/docs/authlib-injector/image.png
  6. 0
      assets/img/docs/auto-installing/mod_install.png
  7. 0
      assets/img/docs/auto-installing/mod_loader.png
  8. 0
      assets/img/docs/multiplayer/help/In-game.png
  9. 0
      assets/img/docs/multiplayer/help/create-room.png
  10. 0
      assets/img/docs/multiplayer/help/img1.png
  11. 0
      assets/img/docs/multiplayer/help/join.png
  12. 0
      assets/img/docs/multiplayer/help/mainpage.png
  13. BIN
      assets/img/docs/serverpack/1-1.png
  14. BIN
      assets/img/docs/serverpack/1-2.png
  15. BIN
      assets/img/docs/serverpack/1-3.png
  16. BIN
      assets/img/docs/serverpack/1-4.png
  17. BIN
      assets/img/docs/serverpack/1-6.png
  18. BIN
      assets/img/docs/serverpack/1.png
  19. 25
      authlib-injector.md
  20. 22
      auto-installing.md
  21. 58
      datapack.md
  22. 1
      mod/OWNERS
  23. 16
      multiplayer-help.md
  24. 12
      multiplayer.md
  25. 49
      serverpack.md

BIN
Multiplayer/Help/HMCL联机(.md).zip

Binary file not shown.

1
Multiplayer/Help/OWNERS

@ -1 +0,0 @@
wifi-left

1
Multiplayer/OWNERS

@ -1 +0,0 @@
wifi-left

44
README.md

@ -12,45 +12,29 @@ Hello Minecraft! Launcher 帮助文档仓库
## 贡献
本仓库组织方式为一篇文章放在一个目录中。如果你要提交 PR,请不要将 md 文件直接放在根目录下。
每篇文章的文件夹结构如下:
每篇文章结构如下:
```
文件夹 <article>
* <article>.md
* img1.png
* img2.png
* ...
* OWNERS
<article>.md
assets
* img
* docs
* <article>
* img1.png
* img2.png
* ...
```
其中,`<article>` 表示你的文章的英文名,请仅使用英文字母、数字、中划线、下划线字符,不要使用空格、中文字符。请确保 md 文件名和文件夹名一致。具体可以参考已有文章目录格式。
其中,`<article>` 表示你的文章的英文名(尖括号表示占位符,请替换为文章名称,不要直接提交 '`<article>`'),请仅使用英文字母、数字、中划线、下划线字符,不要使用空格、中文字符。请确保 md 文件名和文件夹名一致。具体可以参考已有文章目录格式。
每篇文章由 Markdown 编写的 `<article>.md` 文件及附带图片组成。此外你还需要在文章目录中添加 OWNERS 文件,以标记该文章由哪些人编写或编辑过
每篇文章由 Markdown 编写的 `<article>.md` 文件及附带图片组成。文章的图片请放置到 `/assets/img/docs/<article>` 目录中。
### 添加新文章
添加新文章时,请确保你的 PR 仅在根文件夹下创建一个全新的文章目录,并将内容按照上述格式要求存放。你也可以参考已经写好的文章格式。
添加新文章时,请确保将内容按照上述格式要求存放。你也可以参考已经写好的文章格式。
切记不要在一个添加新文章的 PR 里修改其他文章的内容。
### 修改已有文章
修改已有文章时,请确保你的 PR 仅修改一个文章内容,并在该文章的 OWNERS 里署名。
### 文章分类
如果你要提交的文章可以被囊括为一个分类,我们推荐你对文章进行分类。
目录分类的格式为:
```
文件夹 <collection>
* 文件夹 <article1>
* <article1>.md
* OWNERS
* 文件夹 <article2>
* <article2>.md
* OWNERS
* <collection>.md
* OWNERS
```
具体你可以参考 multiplayer 分类。
修改已有文章时,请确保你的 PR 仅修改一个文章内容,并在该文章里署名。

BIN
assets/img/docs/authlib-injector/image.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB

0
mod/mod_install.png → assets/img/docs/auto-installing/mod_install.png

Before

Width:  |  Height:  |  Size: 271 KiB

After

Width:  |  Height:  |  Size: 271 KiB

0
mod/mod_loader.png → assets/img/docs/auto-installing/mod_loader.png

Before

Width:  |  Height:  |  Size: 734 KiB

After

Width:  |  Height:  |  Size: 734 KiB

0
Multiplayer/Help/In-game.png → assets/img/docs/multiplayer/help/In-game.png

Before

Width:  |  Height:  |  Size: 145 KiB

After

Width:  |  Height:  |  Size: 145 KiB

0
Multiplayer/Help/create-room.png → assets/img/docs/multiplayer/help/create-room.png

Before

Width:  |  Height:  |  Size: 289 KiB

After

Width:  |  Height:  |  Size: 289 KiB

0
Multiplayer/Help/img1.png → assets/img/docs/multiplayer/help/img1.png

Before

Width:  |  Height:  |  Size: 182 KiB

After

Width:  |  Height:  |  Size: 182 KiB

0
Multiplayer/Help/join.png → assets/img/docs/multiplayer/help/join.png

Before

Width:  |  Height:  |  Size: 299 KiB

After

Width:  |  Height:  |  Size: 299 KiB

0
Multiplayer/Help/mainpage.png → assets/img/docs/multiplayer/help/mainpage.png

Before

Width:  |  Height:  |  Size: 410 KiB

After

Width:  |  Height:  |  Size: 410 KiB

BIN
assets/img/docs/serverpack/1-1.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB

BIN
assets/img/docs/serverpack/1-2.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

BIN
assets/img/docs/serverpack/1-3.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

BIN
assets/img/docs/serverpack/1-4.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

BIN
assets/img/docs/serverpack/1-6.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

BIN
assets/img/docs/serverpack/1.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 221 KiB

25
authlib-injector.md

@ -0,0 +1,25 @@
---
title: "Authlib-Injector 服务器设置指南"
permalink: /help/launcher/authlib-injector.html
date: 2021-08-22 23:18:02 +0800
categories: HMCL
toc: true
---
> 本文由 huanghongxun 编写。
## 背景
使用 authlib-injector 认证的服主可以通过本教程提供的方法使 HMCL 默认在打开时弹窗要求创建对应认证服务器的账户。
## 方法
在 HMCL 启动器同级目录下创建 `authlib-injectors.json` 文件,此时文件夹目录结构如下图所示:
![](/assets/img/docs/authlib-injector/image.png)
(注意,请确保打包后的整合包不包含 `hmcl.json` 文件,否则无法生效) `authlib-injectors.json` 文件的示例如下
```
{
"urls": [
"https://example.yggdrasil.yushi.moe/"
]
}
```

22
mod/mod.md → auto-installing.md

@ -1,10 +1,18 @@
# MOD
---
title: "自动安装与模组下载简介"
permalink: /help/launcher/auto-installing.html
date: 2021-10-09 23:18:02 +0800
categories: HMCL
toc: true
---
> 本文由 asdqp233 编写。
## 安装Mod加载器
当你在安装新的游戏客户端时候,会看到其中有forge,liteloader,fabric这3个mod加载器可供选择。
![mod_loader](C:\Users\Administrator\Desktop\mod_loader.png)
![mod_loader](/assets/img/docs/auto-installing/mod_loader.png)
当你使用1.14及以上的游戏版本时,推荐使用fabric,1.14以下的版本推荐使用forge。liteloader只适用1.12及以前的版本(目前已停更)。
@ -22,7 +30,7 @@ HMCL内置了Curseforge源和 Modrinth源的搜索和下载功能,目前已支
**注意:请区分*Forge Mod* 和*Fabric Mod*,大部分mod在文件名中会注明,请不要选择错误,否则mod无法被正确加载。**
![mod_install](C:\Users\Administrator\Desktop\mod_install.png)
![mod_install](/assets/img/docs/auto-installing/mod_install.png)
### Fabric Mod
@ -40,10 +48,10 @@ HMCL内置了Curseforge源和 Modrinth源的搜索和下载功能,目前已支
造成游戏报错的原因有很多,比如mod之间不兼容,fabric api的版本过高,缺少前置mod等等。
Ⅰ.新版本的HMCL拥有错误分析功能,可以根据HMCL的提示来排查原因。
1. 新版本的HMCL拥有错误分析功能,可以根据HMCL的提示来排查原因。
Ⅱ.也可以使用二分法来解决——每次加入/删除一半的mod,挨个排除,直到找到导致游戏报错的mod为止。
2. 也可以使用二分法来解决——每次加入/删除一半的mod,挨个排除,直到找到导致游戏报错的mod为止。
Ⅲ.如果你的能力很优秀,也可以直接查看游戏日志来找出问题的原因。
3. 如果你的能力很优秀,也可以直接查看游戏日志来找出问题的原因。
Ⅳ.如果无法理解日志内容,那么请将/.minecraft/crash-reports和/.minecraft/log文件夹打包发给其他人寻求帮助。
4. 如果无法理解日志内容,那么请将/.minecraft/crash-reports和/.minecraft/log文件夹打包发给其他人寻求帮助。

58
datapack.md

@ -0,0 +1,58 @@
---
title: "数据包制作指南"
permalink: /help/launcher/datapack.html
date: 2021-08-22 23:18:02 +0800
categories: HMCL
toc: true
---
> 本文由 huanghongxun 编写。
本指南只介绍如何制作一个 HMCL 可导入的数据包压缩包。
## 建议
始终建议你使用多数据包格式制作数据包压缩包,因为 HMCL 会删除重名的数据包,因此可以借此完成更新功能,只要直接导入新的多数据包格式的压缩包就可以完成更新你制作的数据包。
## 多数据包
如果你的数据包被分离成多个部分供玩家选择是否启用,或者需要自带资源包,那么你需要制作多数据包格式的压缩包。
多数据包文件(只能是一个 `.zip` 文件)格式例子如下:
```
crafting++.zip
\
* datapacks
|\
| * block_sky_domain (一个合法的数据包)
| * crafting_machine
| * craftingpp
| * tradepp
| * utilitypp
|
* resources.zip (如果你的数据包需要附带材质)
\
* assets
\
* ...
```
其中,`datapacks` 下的文件格式和 `.minecraft/saves/New World/datapacks` 的一样,因此可直接手动打包你本地的 `datapacks` 文件夹,
就可以直接导入 HMCL 了。如果还需要资源文件,请在压缩包内附带上。
此外,`resources.zip` 文件的格式和 `.minecraft/saves/New World/resources.zip` 的格式一样,
导入数据包时,启动器将会合并世界附带的默认资源包和你的数据包附带的资源包,如果有重复的文件,旧的文件将被覆盖。
如果你的服务器使用了包含资源包的数据包,那么请在服务器上完成这个操作,接着玩家下载服务器资源包即可。
## 单数据包
如果你的数据包不需要资源文件,那么你直接打包 `datapacks/<你的数据包名称>` 文件夹,即可直接导入 HMCL。
单数据包文件(只能是一个 `.zip` 文件)格式例子如下:
```
RealisticGlassPane.zip
\
* pack.mcmeta
* data
\
* 一些文件
```
HMCL 将会将你打包好的数据包压缩包直接复制到 datapacks 文件夹,不会解压(因为原版游戏支持读取压缩包)。

1
mod/OWNERS

@ -1 +0,0 @@
asdqp233

16
Multiplayer/Help/multiplayer-help.md → multiplayer-help.md

@ -1,4 +1,12 @@
# HMCL 联机教程 v1.0
---
title: "多人联机教程"
permalink: /help/launcher/multiplayer/help.html
date: 2021-10-09 23:18:02 +0800
categories: HMCL
toc: true
---
> 本文由 wifi-left 编写。
## 注意
@ -16,7 +24,7 @@ HMCL 联机模块使用了第三方软件 [Cato](https://noin.cn/71.html),所
左键此处,您将会打开联机页面。
![多人联机界面](F:\Website-Wiki\pages\HMCL\img1.png)
![多人联机界面](/assets/img/docs/multiplayer/help/img1.png)
@ -66,13 +74,13 @@ HMCL 此时不会关闭界面。
设置好所有内容后,点击确认按钮后,将会出现对局域网开放成功的信息。(如下图红色边框内的信息)
![游戏地图创建局域网成功画面](F:\Website-Wiki\pages\HMCL\In-game.png)
![游戏地图创建局域网成功画面](/assets/img/docs/multiplayer/help/In-game.png)
此时,请回到 HMCL 多人联机界面。点击 `创建房间` ,您将看到您的局域网游戏已经被正确识别。
单击确认按钮,即可创建房间。
![create-room](create-room.png)
![create-room](/assets/img/docs/multiplayer/help/create-room.png)
创建完毕后,点击 `复制邀请码` ,将邀请码复制到您的粘贴板内。

12
Multiplayer/multiplayer.md → multiplayer.md

@ -1,4 +1,12 @@
# HMCL 联机帮助
---
title: "多人联机帮助"
permalink: /help/launcher/multiplayer/
date: 2021-10-09 23:18:02 +0800
categories: HMCL
toc: true
---
> 本文由 wifi-left 编写。
## 注意
@ -12,5 +20,5 @@ HMCL 联机模块使用了第三方软件 [Cato](https://noin.cn/71.html),所
## 索引
[HMCL 联机教程](./Help/Multi_Help.md)
[HMCL 联机教程](help.html)

49
serverpack.md

@ -0,0 +1,49 @@
---
title: "服务端自动更新整合包制作教程"
permalink: /help/launcher/serverpack.html
date: 2021-08-22 23:18:02 +0800
categories: HMCL
toc: true
---
> 本文由 huanghongxun 编写。
HMCL 允许服务器管理员借助服务端自动更新整合包来实现自动分发整合包更新,这将大大方便有需要频繁更新游戏客户端 Mod、配置等信息的服务器管理员。
HMCL 需要服务器管理员额外提供一个 HTTP 服务器(只需要能提供静态文件服务,比如 Apache 和 Nginx 皆可)来提供检查整合包更新并允许 HMCL 下载更新文件。
## 第一步:导出整合包
在 HMCL 中右键做好的客户端版本,选择导出整合包:
![](/assets/img/docs/serverpack/1.png)
选择导出为服务器自动更新整合包:
![](/assets/img/docs/serverpack/1-1.png)
填写整合包信息,整合包下载链接前缀如何填写请看下文,你也可以先填别的(必须是个链接,比如 http://www.baidu.com),该项在整合包导出后可以修改
![](/assets/img/docs/serverpack/1-2.png)
选择需要包含在整合包内的文件后将产生整合包压缩文件
## 第二步:导入整合包
接着创建一个全新的空文件夹,将启动器复制进去
![](/assets/img/docs/serverpack/1-3.png)
运行启动器,并导入刚才导出的整合包,导入完成后,这个文件夹(这里叫“新整合包”)可以打包发给玩家。
## 第三步,部署整合包更新服务器
你可以借助 Apache、Nginx 等支持静态文件的 HTTP 服务器软件提供文件。首先,决定好整合包下载链接前缀,比如我希望 HMCL 从远程服务器的 http://www.site.com/modpack 目录下存放整合包的更新信息,则在之前导出整合包的整合包下载前缀中填写 http://www.site.com/modpack。
![](/assets/img/docs/serverpack/1-4.png)
上图为导出的服务器自动更新整合包压缩文件的内容,你需要将这个整合包解压到 http://www.site.com/modpack 下。也就是说,从 http://www.site.com/modpack/server-manifest.json 这个链接下载下来的文件必须和上图中整合包压缩文件中的 server-manifest.json 文件一致,并且,http://www.site.com/modpack/overrides 是一个文件夹,里面存放了整合包文件,比如:
![](/assets/img/docs/serverpack/1-6.png)
整合包压缩文件 test.zip/overrides/mods/Advancement_Book-1.12-1.0.3.jar 文件必须可以从 http://www.site.com/modpack/overrides/mods/Advancement_Book-1.12-1.0.3.jar 该目录下载下来,且文件内容一致。那么至此更新服务器就部署完成了。
## 第四步,更新整合包
如果你需要更新整合包,那么将新的整合包经过第一步导出新的整合包压缩文件,并解压到类似 http://www.site.com/modpack 文件夹下即可完成新整合包的部署。
Loading…
Cancel
Save