Skip to content

Add new docs #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jakub Janaszkiewicz (JakuJ) merged 3 commits into from
Jul 9, 2026
Merged

Add new docs #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a10b83
Add new docs
Jul 8, 2026
a2d5d16
Fix CR
Jul 8, 2026
a75baf1
Update Docker docs
JakuJ Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions blog/2026-07-08-sdk-024.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: WukongMP SDK 0.2.4
description: Server passwords, whitelist, admin panel improvements and a new join flow
slug: wukongmp-sdk-024
authors: readym
tags: [wukongmp]
hide_table_of_contents: false
---

This release adds password-protected servers, several whitelist and admin panel improvements, and a redesigned join flow in the Launcher. It also introduces two new fields for the public server list.

To take advantage of the server-side features, update your server binaries to version `0.2.4`. The new join flow and server list fields require the ReadyM Launcher version `0.30.0` or later, so make sure to update your Launcher as well.

The new `0.2.4` server and SDK should be compatible with mods built on the `0.2.3` SDK, but we recommend testing your mods with the new SDK to ensure compatibility.

<!-- truncate -->

## Server passwords

You can now protect your server with a password by setting `Server:Password` in `config.json`. When it is set, players are prompted for the password in the Launcher before they can join. Leaving it empty keeps the server open. The password applies to everyone, including admins and whitelisted players.

See the [installation documentation](/wukong-mp/docs/Server/installation) for details.

## Whitelist and admin panel

A few changes make running a whitelisted server easier:

* When a player who is not on the whitelist tries to join, they are now added to the player list in the [admin panel](/wukong-mp/docs/Server/admin-panel), so you can whitelist them without needing their ID up front.
* Admins are added to the player list when they log into the admin panel.
* Admins now bypass the whitelist, so you are never locked out of your own server.

## Server list

Two new optional fields give your server more identity on the public list:

* `ServerList:Description`: a short description (up to 100 characters) shown on the server's card in the Launcher.
* `ServerList:Country`: an [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (for example `PL`), used to show a flag on the card.

See the [server list documentation](/wukong-mp/docs/Server/server-list) for the full configuration reference.

## Launcher

Launcher `0.30.0` ships a new modal for joining servers. It handles password entry, shows the server's description and country, and improves the direct connect flow.
4 changes: 2 additions & 2 deletions docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ const config: Config = {
lastVersion: 'current',
versions: {
current: {
label: '0.2.3'
label: '0.2.4'
},
'0.1.0': {
label: '0.1.0',
Expand Down Expand Up @@ -140,7 +140,7 @@ const config: Config = {
{
type: 'docsVersionDropdown',
versions: {
'current': { label: '0.2.3' },
'current': { label: '0.2.4' },
'0.1.0': { label: '0.1.0' },
},
position: 'right',
Expand Down
2 changes: 1 addition & 1 deletion i18n/zh-Hans/docusaurus-plugin-content-blog/2026-04-10-sdk-010.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: WukongMP SDK 0.1.0
description: Initial stable release of the WukongMP SDK.
description: WukongMP SDK 的首个抢先体验版本。
slug: wukongmp-sdk-010
authors: readym
tags: [wukongmp]
Expand Down
2 changes: 1 addition & 1 deletion i18n/zh-Hans/docusaurus-plugin-content-blog/2026-04-27-sdk-020.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: WukongMP SDK 0.2.0
description: PvP mode updates and foundations for server-side mod support
description: PvP 模式更新以及服务器端模组支持的基础
slug: wukongmp-sdk-020
authors: readym
tags: [wukongmp, adminPanel]
Expand Down
2 changes: 1 addition & 1 deletion i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-06-sdk-021.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: WukongMP SDK 0.2.1
description: Public alpha & bug fixes
description: 公开抢先体验与错误修复
slug: wukongmp-sdk-021
authors: readym
tags: [wukongmp]
Expand Down
2 changes: 1 addition & 1 deletion i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-07-open-source-mods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: WukongMP mods are now open source
description: WukongMP mods are now open source and available on GitHub.
description: WukongMP 模组现已开源，可在 GitHub 上获取。
slug: wukongmp-mods-open-source
authors: readym
tags: [wukongmp]
Expand Down
2 changes: 1 addition & 1 deletion i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-14-sdk-022.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: WukongMP SDK 0.2.2
description: Mod caching and .pak file support
description: 模组缓存与 .pak 文件支持
slug: wukongmp-sdk-022
authors: readym
tags: [wukongmp]
Expand Down
2 changes: 1 addition & 1 deletion i18n/zh-Hans/docusaurus-plugin-content-blog/2026-06-23-sdk-023.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: WukongMP SDK 0.2.3
description: Public server list
description: 公开服务器列表
slug: wukongmp-sdk-023
authors: readym
tags: [wukongmp]
Expand Down
43 changes: 43 additions & 0 deletions i18n/zh-Hans/docusaurus-plugin-content-blog/2026-07-08-sdk-024.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: WukongMP SDK 0.2.4
description: 服务器密码、白名单和管理面板改进，以及全新的加入流程
slug: wukongmp-sdk-024
authors: readym
tags: [wukongmp]
hide_table_of_contents: false
---

本次发布新增了密码保护的服务器、多项白名单与管理面板改进，以及启动器中重新设计的加入流程。同时为公共服务器列表引入了两个新字段。

要使用服务器端的功能，请将服务器二进制文件更新至版本 `0.2.4`。新的加入流程和服务器列表字段需要 ReadyM 启动器版本 `0.30.0` 或更高版本，因此也请更新您的启动器。

新的 `0.2.4` 服务器和 SDK 应该与使用 `0.2.3` SDK 构建的模组兼容，但我们建议在新 SDK 上测试你的模组，以确保兼容性。

<!-- truncate -->

## 服务器密码

现在您可以通过在 `config.json` 中设置 `Server:Password` 来为服务器设置密码。设置后，玩家需要在启动器中输入密码才能加入。留空则服务器保持开放。该密码对所有人生效，包括管理员和白名单玩家。

详情请参阅 [安装文档](/wukong-mp/docs/Server/installation)。

## 白名单与管理面板

以下改动让管理启用了白名单的服务器更加轻松：

* 当不在白名单上的玩家尝试加入时，现在会被添加到 [管理面板](/wukong-mp/docs/Server/admin-panel) 的玩家列表中，因此您无需事先获取其 ID 即可将其加入白名单。
* 管理员登录管理面板时会被添加到玩家列表中。
* 管理员现在可以绕过白名单，因此您永远不会被自己的服务器拒之门外。

## 服务器列表

两个新的可选字段可以让您的服务器在公共列表中更具辨识度：

* `ServerList:Description`：显示在启动器服务器卡片上的简短描述（最多 100 个字符）。
* `ServerList:Country`：[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) 国家/地区代码（例如 `PL`），用于在卡片上显示国旗。

完整的配置参考请参阅 [服务器列表文档](/wukong-mp/docs/Server/server-list)。

## 启动器

启动器 `0.30.0` 带来了全新的加入服务器弹窗。它支持密码输入，显示服务器的描述和国家/地区，并改进了直连流程。
2 changes: 1 addition & 1 deletion i18n/zh-Hans/docusaurus-plugin-content-docs/current.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"version.label": {
"message": "0.2.3",
"message": "0.2.4",
"description": "The label for version current"
},
"sidebar.wukongMpDocsSidebar.category.APIs": {
Expand Down
37 changes: 31 additions & 6 deletions i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/Server/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ WukongMP 服务器当前以以下格式分发：

| 平台 | 架构 | 下载 |
| ------- | --- | --------------------------------------------------------------------------------------------------------------- |
| Linux | x64 | [Linux 版下载](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-linux64-0.2.3.zip) |
| Windows | x64 | [Windows 版下载](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-win64-0.2.3.zip) |
| Linux | x64 | [Linux 版下载](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-linux64-0.2.4.zip) |
| Windows | x64 | [Windows 版下载](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-win64-0.2.4.zip) |

### 安装

Expand Down Expand Up @@ -73,6 +73,14 @@ server/
| 设置 | 类型 | 目的 |
| ------------- | --- | ------------ |
| `Server:Port` | 数字 | 服务器监听传入连接的端口 |
| `Server:Password` | string | 可选。设置后，玩家必须在启动器中输入此密码才能加入。留空或省略则为开放服务器。 |
| `Telemetry:OptOut` | 布尔值 | 设置为 `true` 可退出向 ReadyM 发送匿名遥测数据。默认为 `false`。 |

:::note

`Server:Password` 会限制所有玩家，包括管理员和白名单用户。设置了密码的服务器会在公共服务器列表中显示一个锁图标。

:::

### 首次启动

Expand All @@ -94,27 +102,40 @@ server/
从注册表拉取镜像：

```shell
docker pull ghcr.io/readycodeio/wukongmp-server:0.2.3
docker pull ghcr.io/readycodeio/wukongmp-server:0.2.4
```

从镜像中复制配置文件:

```shell
docker create --name wukongmp-tmp ghcr.io/readycodeio/wukongmp-server:0.2.4
docker cp wukongmp-tmp:/app/config.json ./config.json
docker rm wukongmp-tmp
```

运行：

<Tabs>
<TabItem value="docker" label="Docker">

```shell
docker run \
-p 9050:9050/udp -p 9050:9050/tcp \
-v ./data:/app/data \
-v ./mods:/app/mods \
-v ./saves:/app/saves \
-v ./config.json:/app/config.json \
--name wukongmp-server \
ghcr.io/readycodeio/wukongmp-server:0.2.3
ghcr.io/readycodeio/wukongmp-server:0.2.4
```

或者使用 Docker Compose：
</TabItem>
<TabItem value="compose" label="Docker Compose">

```yaml title="docker-compose.yml"
services:
server:
image: ghcr.io/readycodeio/wukongmp-server:0.2.3
image: ghcr.io/readycodeio/wukongmp-server:0.2.4
container_name: wukongmp-server
restart: unless-stopped
ports:
Expand All @@ -124,8 +145,12 @@ services:
- ./data:/app/data
- ./mods:/app/mods
- ./saves:/app/saves
- ./config.json:/app/config.json
```

</TabItem>
</Tabs>

:::important

镜像 **不带模组**。在启动容器之前，将 `WukongMp.Sdk`
Expand Down
25 changes: 17 additions & 8 deletions i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/Server/server-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,20 @@ sidebar_position: 5
| 设置 | 类型 | 描述 |
| ------------ | ------ | --------------------------------------------------------------- |
| `Enabled` | 布尔值 | 是否公开列出服务器。 |
| `name` | string | 在启动器中可见的显示名称。 |
| `Gamemode` | string | 游戏模式标签，显示在名称旁边。 |
| `MaxPlayers` | 整数 | 最大可容纳的玩家数量。**必须为1或以上**（在玩家连接时强制执行）。 |
| `公开主机名` | string | 公开可路由的 IP 地址或主机名。请参阅 [主机验证规则](#主机验证规则)。 |
| `公开端口` | 整数 | 玩家通过公共 IP 连接到服务器所使用的对外端口。 |
| `许可密钥` | string | 用于获取验证的许可密钥。请参阅 [已验证状态](#已验证状态)。 |
| `Name` | string | 在启动器中可见的显示名称。最多 50 个字符。 |
| `Gamemode` | string | 游戏模式标签，显示在名称旁边。最多 15 个字符。 |
| `Description` | string | 可选。在启动器服务器卡片上显示的简短描述。最多 100 个字符。 |
| `Country` | string | 可选。两位字母 [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) 国家/地区代码（例如 `PL`、`US`、`DE`），用于在服务器卡片上显示国旗。 |
| `MaxPlayers` | 整数 | 最大可容纳的玩家数量。必须介于 **1 到 64** 之间（在玩家连接时强制执行）。 |
| `PublicHost` | string | 公开可路由的 IP 地址或主机名（最多 253 个字符）。请参阅 [主机验证规则](#主机验证规则)。 |
| `PublicPort` | 整数 | 玩家通过公共 IP 连接到服务器所使用的对外端口。 |
| `LicenseKey` | string | 用于获取验证的许可密钥。请参阅 [已验证状态](#已验证状态)。 |

:::note

这些限制在您的服务器向公共列表上报时强制执行。如果某个值无效（例如描述超过 100 个字符或国家/地区代码格式错误），服务器将不会被列出。

:::

在选择名称和游戏模式标签时请保持尊重，因为它们将对启动器中的所有玩家可见。违反 [ReadyM 服务条款](https://portal.ready.mp/en/terms) 可能导致您的服务器从公开列表中移除，或您的账户被封禁。

Expand All @@ -35,14 +43,15 @@ sidebar_position: 5
"Enabled": true,
"Name": "Bob's arena",
"Gamemode": "PvP",
"Description": "Weekly PvP tournaments, all welcome",
"Country": "CN",
"MaxPlayers": 32,
"PublicHost": "203.0.113.1",
"PublicPort": 9050,
"LicenseKey": ""
},
//highlight-end
"Server": { "Port": 9050 },
"Web": { "Sso": { "Authority": "https://api.ready.mp" } }
"Server": { "Port": 9050 }
}
```

Expand Down
39 changes: 32 additions & 7 deletions i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
<TabItem value="windows" label="Windows">

[⬇ Windows
版下载（x64，v0.2.3）](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-win64-0.2.3.zip)
版下载（x64，v0.2.4）](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-win64-0.2.4.zip)

</TabItem>
<TabItem value="linux" label="Linux">

[⬇ Linux
版下载（x64，v0.2.3）](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-linux64-0.2.3.zip)
版下载（x64，v0.2.4）](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-linux64-0.2.4.zip)

</TabItem>
<TabItem value="docker" label="Docker">

```shell
docker pull ghcr.io/readycodeio/wukongmp-server:0.2.3
docker pull ghcr.io/readycodeio/wukongmp-server:0.2.4
```

</TabItem>
Expand All @@ -51,11 +51,24 @@ docker pull ghcr.io/readycodeio/wukongmp-server:0.2.3
</TabItem>
<TabItem value="docker" label="Docker">

:::重要 提示：镜像不附带 **without mods**。在启动容器之前，请下载二进制包并将 `WukongMp.Sdk`
与你选择的游戏模式模组（`WukongMp.PvP` 或 `WukongMp.Coop`）复制到你本地的 `./mods/` 文件夹。:::
从镜像中复制配置文件:

```shell
docker create --name wukongmp-tmp ghcr.io/readycodeio/wukongmp-server:0.2.4
docker cp wukongmp-tmp:/app/config.json ./config.json
docker rm wukongmp-tmp
```

端口配置通过重新映射容器端口来处理 — 请参见第3步。

:::important

镜像不附带 **without mods**。在启动容器之前，请下载二进制包并将 `WukongMp.Sdk`
与你选择的游戏模式模组（`WukongMp.PvP` 或 `WukongMp.Coop`）复制到你本地的 `./mods/` 文件夹。

:::


</TabItem>
</Tabs>

Expand All @@ -80,22 +93,33 @@ chmod +x server && ./server
</TabItem>
<TabItem value="docker" label="Docker">

从镜像中复制配置文件:

```shell
docker create --name wukongmp-tmp ghcr.io/readycodeio/wukongmp-server:0.2.4
docker cp wukongmp-tmp:/app/config.json ./config.json
docker rm wukongmp-tmp
```

运行：

```shell
docker run \
-p 9050:9050/udp -p 9050:9050/tcp \
-v ./data:/app/data \
-v ./mods:/app/mods \
-v ./saves:/app/saves \
-v ./config.json:/app/config.json \
--name wukongmp-server \
ghcr.io/readycodeio/wukongmp-server:0.2.3
ghcr.io/readycodeio/wukongmp-server:0.2.4
```

或者使用 Docker Compose：

```yaml title="docker-compose.yml"
services:
server:
image: ghcr.io/readycodeio/wukongmp-server:0.2.3
image: ghcr.io/readycodeio/wukongmp-server:0.2.4
container_name: wukongmp-server
restart: unless-stopped
ports:
Expand All @@ -105,6 +129,7 @@ services:
- ./data:/app/data
- ./mods:/app/mods
- ./saves:/app/saves
- ./config.json:/app/config.json
```

</TabItem>
Expand Down
Loading
Loading