12 |
13 | Generate and copy this API key, it will have the same rights as your current account.
14 |
15 | 
16 |
17 | ## Example Usages
18 |
19 | Suppose you are an admin, and you want to use the API to `get a list of daemons`. You need to use any programming language or HTTP tool to send the following request:
20 |
21 | ```bash
22 | GET http://example.com/api/service/remote_services_system?apikey=
16 |
21 |
39 |
40 |
41 | ```
42 |
43 | ## JavaScript Sandbox Mechanism
44 |
45 | To prevent multiple cards from interfering with each other loaded on the same page, MCSManager has created a simple JavaScript sandbox mechanism. Its working principle is to proxy the window object. Any changes you make to the window object will not affect others.
46 |
47 | ### HTML Card 1
48 |
49 | ```js
50 | window.$onMounted = function () {
51 | window.name = "foo"; // Define a global variable
52 | };
53 | ```
54 |
55 | ### HTML Card 2
56 |
57 | ```js
58 | window.$onMounted = function () {
59 | setTimeout(() => {
60 | console.log(window.name); // undefined
61 | }, 10000);
62 | };
63 | ```
64 |
65 | ## CSS Style Pollution
66 |
67 | MCSManager does not isolate CSS styles. It's up to you or other developers to constrain CSS styles. Any definition you make to CSS will affect the entire MCSManager webpage.
68 |
69 | ## Card API
70 |
71 | We provide you with several APIs for use in your script.
72 |
73 | ```js
74 | window.$onMounted = function () {
75 | // Card mount complete event.
76 | };
77 | window.$onUnmounted = function () {
78 | // Card unmount complete event.
79 | };
80 |
81 | // Real window object, i.e., the window object of the MCSManager web frontend.
82 | window.$realWindow;
83 |
84 | // Axios library for sending requests.
85 | // Reference: https://axios-http.com/docs/example
86 | window.$axios;
87 |
88 | // Current MCSManager interface theme, light or dark (light/dark).
89 | window.$theme;
90 | ```
91 |
--------------------------------------------------------------------------------
/docker-install.md:
--------------------------------------------------------------------------------
1 | # Installing MCSManager Panel Using Docker
2 |
3 | :::tip
4 | Installing the panel via Docker requires some complex configurations. Make sure you have the necessary knowledge for this. Otherwise, it is recommended to use the one-click installation script.
5 | :::
6 |
7 | ## Install Docker
8 |
9 | ```bash
10 | curl -fsSL https://get.docker.com -o get-docker.sh
11 | sudo sh get-docker.sh
12 | ```
13 |
14 | ## Install MCSManager
15 |
16 | In the following commands, replace all `Hello World
17 | 18 | 19 | 20 |
14 |
15 | 生成并复制此 API 密钥，它将具有与您当前帐户相同的权限。
16 |
17 | 
18 |
19 | ## 示例用法
20 |
21 | 假设您是一名管理员，并且希望使用 API 来“获取远程节点列表”。您需要使用任何编程语言或 HTTP 工具来发送以下请求：
22 |
23 | ```bash
24 | GET http://demo.com/api/service/remote_services_system?apikey=<你的 Api Key>
25 | Content-Type: application/json; charset=utf-8
26 | X-Requested-With: XMLHttpRequest
27 |
28 | 注意：URL后面一定要加入 apikey 参数，否则权限不足
29 | ```
30 |
31 | :::warning
32 | 如果没有另行指定，**这些 HTTP 请求头是必需的**。
33 |
34 | - X-Requested-With: XMLHttpRequest
35 | - Content-Type: application/json; charset=utf-8
36 |
37 | :::
38 |
39 | 您将获得所有节点的所有数据：
40 |
41 | ```json
42 | {
43 | // 状态参数
44 | // 200：正常，返回相应内容
45 | // 400：请求参数不正确
46 | // 403：权限不足
47 | // 500：程序错误
48 | "status": 200,
49 | // 响应节点列表
50 | "data": [
51 | {
52 | "version": "3.9.0",
53 | "process": {
54 | "cpu": 5625000 //CPU 使用
55 | "memory": 132437320, // 内存使用
56 | "cwd": "D:\\Workspace\\MCSM\\MCSManager-Daemon" //守护进程 目录
57 | },
58 | "instance": {
59 | "running": 1, // 运行的实例
60 | "total": 6 // 总共实例
61 | },
62 | "system": {
63 | "type": "Windows_NT", //系统类型
64 | "hostname": "MyComputer", //系统名称
65 | "platform": "win32", //系统平台
66 | "release": "11.0.22000", //版本
67 | "uptime": 410445, //在线时长
68 | "cwd": "D:\\Workspace\\MCSM\\MCSManager-Daemon", //守护进程 目录
69 | "loadavg": [0, 0, 0], //负载
70 | "freemem": 5700775936, //剩余内存
71 | "cpuUsage": 0.0490009222256379, //CPU使用
72 | "memUsage": 0.6651475749266619, //内存使用
73 | "totalmem": 17024741376, //总内存
74 | "processCpu": 0,
75 | "processMem": 0
76 | }
77 | }
78 | ],
79 | // 请求完成处理的时间可用于测量延迟。
80 | "time": 1643879914006
81 | }
82 | ```
83 |
--------------------------------------------------------------------------------
/zh_cn/apis/html_card.md:
--------------------------------------------------------------------------------
1 | # 制作卡片小组件
2 |
3 | :::tip
4 | 此功能需要一些 JavaScript 开发知识。
5 |
6 | **不建议使用其他人的脚本，因为这可能会导致您的面板受到损害**
7 | :::
8 |
9 | 在 MCSManager web 界面中启用设计模式后，添加新卡片时有一个选项“扩展页面卡片”。此卡片允许您上传自己的 “HTML” 文件，该文件直接在前端 web 环境中运行。这与“嵌入式 Web 卡片”有根本不同，因为您可以访问大多数前端 HTML 节点并操作 MCSManager 提供的 API 。
10 |
11 | ```html
12 |
13 |
14 |
15 |
16 |
21 |
39 |
40 |
41 | ```
42 |
43 | ## JavaScript 沙盒机制
44 |
45 | 为了防止加载在同一页面上的多张卡片相互干扰， MCSManager 创建了一个简单的 JavaScript 沙盒机制。其工作原理是代理窗口对象。对窗口对象所做的任何更改都不会影响其他对象。
46 |
47 | ### HTML 卡片实例 1
48 |
49 | ```js
50 | window.$onMounted = function () {
51 | window.name = "foo"; // 定义一个全局变量
52 | };
53 | ```
54 |
55 | ### HTML 卡片实例 2
56 |
57 | ```js
58 | window.$onMounted = function () {
59 | setTimeout(() => {
60 | console.log(window.name); // 输出 undefined，因为卡片1的js脚本不会污染到其他任何卡片
61 | }, 10000);
62 | };
63 | ```
64 |
65 | ## CSS 样式污染
66 |
67 | MCSManager 不隔离 CSS 样式。约束 CSS 样式取决于您或其他开发人员。您对 CSS 所做的任何定义都会影响整个 MCSManager 网页。
68 |
69 | ## Card API
70 |
71 | 我们为您的脚本提供了几个 API。
72 |
73 | ```js
74 | window.$onMounted = function () {
75 | // 卡片挂载完成事件。
76 | };
77 | window.$onUnmounted = function () {
78 | // 卡片卸载完成事件。
79 | };
80 |
81 | // 真实窗口对象，即 MCSManager web 前端的窗口对象。
82 | window.$realWindow;
83 |
84 | // Axios 库用于发送请求。
85 | //参考：https://axios-http.com/docs/example
86 | window.$axios;
87 |
88 | //当前 MCSManager 界面主题，亮或暗（亮/暗）。
89 | window.$theme;
90 | ```
91 |
--------------------------------------------------------------------------------
/zh_cn/docker-install.md:
--------------------------------------------------------------------------------
1 | # 使用 Docker 安装面板
2 |
3 | :::tip
4 | 使用 Docker 镜像安装面板需要额外进行一些复杂的配置，请确保您已掌握这些知识，否则请使用一键安装脚本来安装面板，
5 | :::
6 |
7 | ## 安装 Docker
8 |
9 | ```bash
10 | export DOWNLOAD_URL=https://mirrors.ustc.edu.cn/docker-ce # 国内需要执行这步
11 | curl -fsSL https://get.docker.com -o get-docker.sh
12 | sudo sh get-docker.sh
13 | ```
14 |
15 | ## 安装 MCSManager
16 |
17 | 下列命令中，所有的 `Hello World
17 | 18 | 19 | 20 |20 | 21 | ## 使用面板部署 22 | 23 | 点击顶部 `应用实例` 按钮，选择 `Minecraft Java 版游戏服务器` ，选择需要部署的 `节点`，选择 `上传单个服务端软件` ，上传你下载的 `jar` 格式文件。 24 | 25 | 在实例 `启动命令` 处填写： 26 | 27 | ```bash 28 | java -Dfile.encoding=UTF-8 -jar "刚刚下载的jar文件名，例如：paper-1.19.4-516.jar" 29 | ``` 30 | 31 | :::tip 32 | 启动命令还有更多有趣的玩法，后续你可以自己探索。 33 | ::: 34 | 35 |
36 | 37 | ## 启动服务器 38 | 39 | 在创建完毕后对页面进入 `实例控制台` 或点击顶部的 `应用实例`，再点击应用实例进入并启动它。 40 | 41 | 最后，你的服务器应该会正常运行。 42 | 43 |
44 | 45 | ## 同意 EULA 协议 46 | 47 | 第一次启动很有可能会启动失败，会有类似于 `EULA` 等字样的错误，这个是你需要更改一个 `txt` 文件来代表你同意最终用户协议。 48 | 49 | 点击功能组的 `服务端配置文件` 选项，将 `eula.txt` 的选项从 `否` 改为 `是`，保存文件 50 | -------------------------------------------------------------------------------- /zh_cn/setup_package.md: -------------------------------------------------------------------------------- 1 | # 一键搭建 Minecraft Java 版服务器 2 | 3 | ## 安装 Java 环境 4 | 5 | 在开始运行 Java 服务端之前 Java 运行库是必不可少的，以下是一些 `Minecraft` 不同版本所需的对应的 Java 版本运行库列表： 6 | 7 | | 需要的 Java 版本 | Minecraft 游戏版本 | 8 | | ---------------- | :---------------------------------------------------------: | 9 | | Java8 | 1.7.x，1.8.x，1.9.x，1.10.x，1.12.x，1.13.x，1.15.x，1.16.x | 10 | | Java16&Java17 | 1.17.x | 11 | | Java17 | 1.18.x | 12 | | Java17 及更高 | 1.18.x&1.19.x&1.20.x | 13 | 14 | :::tip 15 | 如果你使用 17 更高版本，请不要使用 Java 20 版本，可能存在兼容性问题。 16 | 17 | 你始终应该查看自己的插件支持哪些 Java 版本再做出抉择，如果插件没有声明，请询问插件开发者，以免引起不必要的麻烦。 18 | ::: 19 | 20 | ### Windows 版下载 21 | 22 | - [(Oracle) Java JDK 8](https://repo.huaweicloud.com/java/jdk/8u202-b08/jdk-8u202-windows-x64.exe) 23 | - [(Azul) Java JDK 11](https://cdn.azul.com/zulu/bin/zulu11.62.17-ca-jdk11.0.18-win_x64.msi) 24 | - [(Oracle) Java JDK 17](https://download.oracle.com/java/17/latest/jdk-17_windows-x64_bin.exe) 25 | 26 | > Java16 以及更高版本仅可以在 64 位系统上运行。 27 | 28 | ## 使用预制包一键开服 29 | 30 | :::tip 31 | 请确保你已成功安装 Java 版本，使用 java -version 命令可以确认是否安装成功。 32 | ::: 33 | 34 | - 点击顶部菜单栏的 `应用实例` 并新建一个应用实例。 35 | - 选择 Minecraft Java 版游戏服务器。 36 | - 选择需部署的节点，选择 Minecraft 快速部署。 37 | - 选择一个你需要的整合包，点击安装，输入实例名称。 38 | - 等待安装完毕后进入实例控制台。 39 | - 点击右上操作键开启服务器。 40 | 41 | 随后，启动 Minecraft 服务器，如果看见如下信息代表启动成功： 42 | 43 |  44 | -------------------------------------------------------------------------------- /zh_cn/setup_steam.md: -------------------------------------------------------------------------------- 1 | # 搭建 Steam 游戏服务器 2 | 3 | :::tip 4 | 如果你是 Linux 服务器，我们推荐你使用 Docker 镜像来部署你的 Steam 游戏服务器，请参考「使用 Docker 镜像部署」章节。 5 | ::: 6 | 7 | ## 下载 Steam 服务器程序 8 | 9 | 无论你是想架设 `Palworld`，`CSGO2`，`ARK` 还是其他 Steam 游戏，官方提供的 `SteamCMD` 命令行工具都可以帮助你快速建立 Steam 游戏服务器，MCSManager 面板也依赖它来运行 Steam 游戏服务器。 10 | 11 | - [下载 Windows 版 SteamCMD](https://developer.valvesoftware.com/wiki/SteamCMD#Windows) 12 | 13 | - [下载 Linux 版 SteamCMD](https://developer.valvesoftware.com/wiki/SteamCMD#Linux) 14 | 15 | ## 新建实例 16 | 17 | - 前往 `应用实例` 功能新增一个实例。 18 | - 选择新增类型为 Steam 游戏服务器。 19 | - 选择 `无需额外文件`。 20 | - 启动命令请根据 Steam 游戏的官方文档来配置。 21 | - 创建成功 22 | 23 | ## 获取部署命令 24 | 25 | 每一款 Steam 游戏都有一个 `APP ID`，你需要获取到这个 ID，并且编写如下命令： 26 | 27 | ```bash 28 | "