Skip to content

Commit

Permalink
some update
Browse files Browse the repository at this point in the history
  • Loading branch information
6get-xiaofan committed Nov 2, 2024
1 parent 60749b4 commit e7bd29a
Show file tree
Hide file tree
Showing 7 changed files with 122 additions and 24 deletions.
8 changes: 1 addition & 7 deletions docs/contribution/code-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,4 @@

McHMR 项目在开发时区分了控制器层等各层之间的目录,包括模块层、业务层等,应该再开发新的业务代码时将代码分包归类到相应的目录中。



## 命名规范

### Java 相关

还没更新完哦~

49 changes: 40 additions & 9 deletions docs/guide/manual-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,65 @@

手动部署之前,你需要在你的主机上安装[快速上手](./start.md)中提到的环境:

我们非常建议 使用 Docker 部署方案(暂未上线),或者使用宝塔面板进行手动部署,如果你是 Windows Server 系统,我们推荐使用小皮面板进行手动部署(但我们不推荐使用 Windows Server)。
我们非常建议 使用 Docker 部署方案(暂未上线)。

或者你可以简化部署操作:

- Linux:推荐使用宝塔面板进行手动部署。
- Windows Server:推荐使用小皮面板进行手动部署。

## Windows Server

### 前端部署

1. 将【前端】目录内的文件的移入 Nginx 的 html 目录;
2. 在 Nginx 的 conf 目录中找到 nginx.conf 文件,配置伪静态:
2. 在 Nginx 的 conf 目录中找到 nginx.conf 文件,配置伪静态,打开配置文件后,你可能会看到以下内容

```nginx
location / {
try_files $uri $uri/ /index.html;
server {
listen 80;
listen [::]:80;
server_name _;
root /var/www/html/xxx;
include /etc/nginx/default.d/*.conf;
location / { # [!code focus]
try_files $uri $uri/ /index.html; # [!code focus]
} # [!code focus]
}
```
在 `location / {}` 块中配置 `try_files $uri $uri/ /index.html;` 如果没有 `location / {}` 块,请参照上方自行添加。
3. 修改根目录下的 `webConfig.js` 中的 `webApiBaseUrl` 的值为你后端的值,通常情况下为你的公网IP和后端端口,可以使用域名。
注意:请使用公网 IP + 端口。为防止因未进行备案导致的拦截,尽量不要使用域名;阿里云、腾讯云等服务商的服务器可能会对网站服务拦截,请尽量避免使用大厂的服务器。
```js
window.webConfig = {
/* URL 末尾不要加 '/' 否则无法正常访问 */
"webApiBaseUrl": "http://127.0.0.1:8080",
}
```
3. 修改根目录下的 webConfig.js 中的 webApiBaseUrl 的值为你后端的值,通常情况下为你的公网IP和后端端口,可以使用域名
4. 启动 Nginx,正常访问版本管理端。
---
访问地址:
内网:http://127.0.0.1:port 其中 port 为你在 Nginx 配置的端口。
外网:http://IP:port 其中 IP 为你的公网IP,port 为你在 Nginx 配置的端口。
```txt
内网:http://127.0.0.1:{port}
外网:http://{IP}:{port} 或 http://{域名}:{port}
如果绑定了域名,可以直接访问域名。
port:在 Nginx 配置的端口
IP: 你的公网 IP
域名:如果有可使用
```

初始账号:admin 初始密码:admin123
初始账号和密码:admin / admin123

### 后端部署

Expand Down
18 changes: 14 additions & 4 deletions docs/usage/game-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,20 @@
很高兴见到你!但很抱歉,这个页面还在施工中,如果没有找到你感兴趣的信息,你可以先在侧边栏的导航中寻找你感兴趣的内容来开始阅读,或者到 QQ 群或者频道中寻求帮助。
:::

# 生成更新器/启动器配置 API
# 游戏管理

在搭建完毕后,首次登录版本管理端将进入主页,你在主页可以看到生成更新器/启动器配置 API 的按钮,这里生成的就是更新器/启动器需要填写的 API,你只需要点击生成后,复制此处的 API,填写到对应的更新器/启动器上
游戏管理是版本管理端主要的功能之一,为服主提供了一个文件管理器,服主将游戏文件添加到这个文件管理器后,每次创建版本都会以这个文件管理器中的文件作为新版本的基本文件

完成此操作后,你的更新器/启动器就拥有了连接版本管理端的能力,来实现游戏客户端的更新。
## 上传游戏文件

更详细的说明。你可以参考客户端配置。
请使用版本管理端自带的上传文件功能,将 .minecraft 目录下的所有文件打包 zip 格式后,上传到游戏管理当中,需注意:请全选 .minecraft 目录中的文件后再压缩,不要直接选中 .minecraft 目录压缩。

上传完成后,可以使用游戏管理自带的文件解压缩功能,鼠标移动到上传好的压缩包,然后点击右侧的黄色解压按钮,等待解压缩完成。

## 游戏文件改动

请使用版本管理端自带的文件操作功能,例如:删除、移动、批量删除、批量移动等功能,对文件进行更改操作。

## 其他

游戏管理类似于一个文件管理器,涵盖了文件管理器的大部分操作,服主可以自行体验相关功能。
12 changes: 11 additions & 1 deletion docs/usage/home.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
::: warning 🚧 施工中
很高兴见到你!但很抱歉,这个页面还在施工中,如果没有找到你感兴趣的信息,你可以先在侧边栏的导航中寻找你感兴趣的内容来开始阅读,或者到 QQ 群或者频道中寻求帮助。
:::
:::

# 主页

主页暂未完善,开发者正在开发相关统计功能,等功能完善后,可在文档中查阅相关介绍。

## 客户端绑定 API 生成

主页展示了客户端绑定 API 生成的文本框、生成和复制按钮。点击生成按钮,会生成客户端绑定 API,将这个生成的 API 拷贝到客户端的 McHMR 配置窗口中,点击确认按钮,即可完成客户端与版本管理端的连接。

该步骤只需要配置一次,完成此操作,客户端就实现了与版本管理端的绑定,当版本管理端发布新版本时,客户端就具备游戏客户端的更新功能。
17 changes: 16 additions & 1 deletion docs/usage/launcher-manager.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
::: warning 🚧 施工中
很高兴见到你!但很抱歉,这个页面还在施工中,如果没有找到你感兴趣的信息,你可以先在侧边栏的导航中寻找你感兴趣的内容来开始阅读,或者到 QQ 群或者频道中寻求帮助。
:::
:::

# 启动器管理

这里设置一些启动器相关的功能。

## 启动器背景图

服主可以在这里动态调整客户端的背景图显示,启用背景图不配置就会使用默认的背景图。不启用则会不进行背景图展示。

## 更新模式

目前 McHMR 拥有两种更新方式,一种为更新包模式,一种为多文件模式。

- 更新包模式:会将玩家需要更新的文件打包成压缩包,让客户端下载,缺点是速度较慢。如果服务器的 IO 性能较好,可以使用此模式,此模式最为稳定。
- 多文件模式:会将玩家需要更新的文件直接交给客户端逐一下载,优点是下载速度快,更新快。如果服务器的带宽较高,可以使用此模式,该模式为最新功能,较不稳定。
16 changes: 15 additions & 1 deletion docs/usage/server-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,18 @@

# 服务器管理

在部署好项目之后,接下来可以配置服务器信息了,在版本管理端中的服务器管理中,可以设置服务器名称和配置白名单列表。
在服务器管理中,服主可以设置服务器相关的功能或者参数。

## 服务器名称

服务器名称设置后,当取消了更新器的背景图功能,就会在更新器左上角直接展示服务器的名称。

## 服务器 IP

该项为目前预留的功能入口,后续会根据此 IP,实现相关功能,敬请期待。

## 白名单

其中配置的是不进行更新操作的文件或者目录,一行一条,以游戏管理中的根目录作为开始,组合后填到此处。玩家的存档目录、光影包和资源包等目录,应该被排除。版本管理端自带了一些白名单,请根据需求删除或者更改。

如果使用 HMCL、PCL 等启动器,开启了版本隔离功能,就需要进入到相应版本的目录中设置白名单路径。
26 changes: 25 additions & 1 deletion docs/usage/version-manager.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
::: warning 🚧 施工中
很高兴见到你!但很抱歉,这个页面还在施工中,如果没有找到你感兴趣的信息,你可以先在侧边栏的导航中寻找你感兴趣的内容来开始阅读,或者到 QQ 群或者频道中寻求帮助。
:::
:::

# 版本管理

版本管理页面主要用于发布游戏的新版本,也是玩家更新依据,只有在版本管理页面发布了新版本,玩家才可以正常用客户端更新最新发布的版本。

## 创建版本

在进行创建创建新版本的操作之前,必须要完成新版本的改动,这个改动取决于新版本的变化。

例如:服主要给玩家的客户端更新几个 Mod,首先应该在游戏管理中,对应的 mods 目录上传 Mod,然后再来版本管理中创建新版本。

服主应该知道,任何客户端的改动都应该创建版本,包括:添加 Mod,删除文件等。

### 填写规则

点击创建版本按钮后,会提示输入版本号和版本描述。

版本号应该符合规范,禁止输入中英文等的版本号,版本号应该是从小到大进行设置,由于内部实现,请使用三位的版本号,例如:1.0.0,1.0.2 等。同时新版本的版本号应该大于之前的旧版本。

版本描述信息应该填写此次版本更新带来了什么变化,版本号和版本描述会在玩家更新的时候展示给玩家,让玩家看到,版本描述中可以换行写。

### 生成差异文件

确认创建新版本会弹出生成差异文件的进度条,该过程会比较慢,速度取决于游戏的大小,生成完成之后,玩家就可以正常更新。

0 comments on commit e7bd29a

Please sign in to comment.