diff --git a/blog/2026-07-08-sdk-024.md b/blog/2026-07-08-sdk-024.md new file mode 100644 index 0000000..2c817bd --- /dev/null +++ b/blog/2026-07-08-sdk-024.md @@ -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. + + + +## 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 300 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. diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 9a4d5de..cb3c7dd 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -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', @@ -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', diff --git a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-04-10-sdk-010.md b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-04-10-sdk-010.md index 309c4e6..98955e8 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-04-10-sdk-010.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-04-10-sdk-010.md @@ -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] diff --git a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-04-27-sdk-020.md b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-04-27-sdk-020.md index 5b6d081..7b759e4 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-04-27-sdk-020.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-04-27-sdk-020.md @@ -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] diff --git a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-06-sdk-021.md b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-06-sdk-021.md index 7e7a2ea..1b33aba 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-06-sdk-021.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-06-sdk-021.md @@ -1,6 +1,6 @@ --- title: WukongMP SDK 0.2.1 -description: Public alpha & bug fixes +description: 公开抢先体验与错误修复 slug: wukongmp-sdk-021 authors: readym tags: [wukongmp] diff --git a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-07-open-source-mods.md b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-07-open-source-mods.md index fd55d14..f7d3d5e 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-07-open-source-mods.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-07-open-source-mods.md @@ -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] diff --git a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-14-sdk-022.md b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-14-sdk-022.md index ac40143..61b9e31 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-14-sdk-022.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-05-14-sdk-022.md @@ -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] diff --git a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-06-23-sdk-023.md b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-06-23-sdk-023.md index cf02f4a..ae0db27 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-06-23-sdk-023.md +++ b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-06-23-sdk-023.md @@ -1,6 +1,6 @@ --- title: WukongMP SDK 0.2.3 -description: Public server list +description: 公开服务器列表 slug: wukongmp-sdk-023 authors: readym tags: [wukongmp] diff --git a/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-07-08-sdk-024.md b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-07-08-sdk-024.md new file mode 100644 index 0000000..6983902 --- /dev/null +++ b/i18n/zh-Hans/docusaurus-plugin-content-blog/2026-07-08-sdk-024.md @@ -0,0 +1,48 @@ +--- +title: WukongMP SDK 0.2.4 +description: 服务器密码、白名单和管理面板改进，以及全新的加入流程 +slug: wukongmp-sdk-024 +authors: readym +tags: [wukongmp] +hide_table_of_contents: false +--- + +本版本新增了带有密码保护的服务器、若干白名单和管理面板改进，以及 Launcher 中重新设计的加入流程。此外，它还为公共服务器列表引入了两个新字段。 + +要充分利用服务器端功能，请将服务器二进制更新到版本 `0.2.4`。新的加入流程和服务器列表字段需要 ReadyM Launcher 版本 `0.30.0` +或更高版本，请也更新您的 Launcher。 + +新的 `0.2.4` 服务器和 SDK 应该与使用 `0.2.3` SDK 构建的模组兼容，但我们建议在新 SDK 上测试你的模组，以确保兼容性。 + + + +## 服务器密码 + +现在可以通过在 `config.json` 中设置 `Server:Password` 来为您的服务器设置密码。当设置后，玩家在 Launcher +中被提示输入密码，才可加入。将其留空可保持服务器开启。该密码对所有人都适用，包括管理员和白名单玩家。 + +请参阅 [安装文档](/wukong-mp/docs/Server/installation) 以获取详细信息。 + +## 白名单与管理面板 + +一些改动使运行白名单服务器更为简单： + +* 当尝试加入的玩家不在白名单上时，他们现在会被添加到 [管理面板](/wukong-mp/docs/Server/admin-panel) + 的玩家列表中，因此您无需事先获取其ID即可将其加入白名单。 +* 管理员在登录管理面板时会被添加到玩家列表中。 +* 管理员现在绕过白名单，因此您永远不会被自己的服务器锁定。 + +## 服务器列表 + +两个新可选字段使您的服务器在公共列表上拥有更强的身份标识： + +* `ServerList:Description`: 简短描述（最多300个字符），在 Launcher 的服务器卡片上显示。 +* `ServerList:Country`: 一个 [ISO 3166-1 + alpha-2](https://zh.wikipedia.org/wiki/ISO_3166-1%E4%BA%8C%E4%BD%8D%E5%AD%97%E6%AF%8D%E4%BB%A3%E7%A0%81) 国家代码（例如 + `PL`），用于在卡片上显示旗帜。 + +请参阅 [服务器列表文档](/wukong-mp/docs/Server/server-list) 以获取完整的配置参考。 + +## Launcher + +Launcher `0.30.0` 发布了一个用于加入服务器的新模态框。它处理密码输入，显示服务器的描述和国家信息，并改进直接连接流程。 diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json b/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json index 485d19d..59fbb4a 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json @@ -1,6 +1,6 @@ { "version.label": { - "message": "0.2.3", + "message": "0.2.4", "description": "The label for version current" }, "sidebar.wukongMpDocsSidebar.category.APIs": { diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/Server/installation.mdx b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/Server/installation.mdx index 6091d3b..4f12f7b 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/Server/installation.mdx +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/Server/installation.mdx @@ -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) | ### 安装 @@ -70,9 +70,17 @@ server/ 您可以通过编辑 `config.json` 文件来调整服务器设置。在以下表格中，使用 `:` 记法来表示嵌套设置。 -| 设置 | 类型 | 目的 | -| ------------- | --- | ------------ | -| `Server:Port` | 数字 | 服务器监听传入连接的端口 | +| 设置 | 类型 | 目的 | +| ------------- | ------ | --------------------------------------------- | +| `Server:Port` | 数字 | 服务器监听传入连接的端口 | +| `Server:Password` | string | 可选。设置后，玩家在加入时必须在启动器中输入此密码。留空或省略以表示开放服务器。 | +| `Telemetry:OptOut` | 布尔值 | 设置为 `true` 即可选择不向 ReadyM 发送匿名遥测。默认值为 `false`。 | + +:::note + +`服务器:密码` 对包括管理员和白名单用户在内的每位玩家都需要通过密码进行验证。受密码保护的服务器在公开服务器列表中显示为带锁的图标。 + +::: ### 首次启动 @@ -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 ``` 运行： + + + ```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: @@ -124,8 +145,12 @@ services: - ./data:/app/data - ./mods:/app/mods - ./saves:/app/saves + - ./config.json:/app/config.json ``` + + + :::important 镜像 **不带模组**。在启动容器之前，将 `WukongMp.Sdk` diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/Server/server-list.mdx b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/Server/server-list.mdx index eeeeed9..8f66531 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/Server/server-list.mdx +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/Server/server-list.mdx @@ -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 | 可选。在启动器服务器卡片上显示的简短描述。最多 300 个字符。 | +| `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 + +这些限制在您的服务器向公共列表上报时强制执行。如果某个值无效（例如描述超过 300 个字符或国家/地区代码格式错误），服务器将不会被列出。 + +::: 在选择名称和游戏模式标签时请保持尊重，因为它们将对启动器中的所有玩家可见。违反 [ReadyM 服务条款](https://portal.ready.mp/en/terms) 可能导致您的服务器从公开列表中移除，或您的账户被封禁。 @@ -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 } } ``` diff --git a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/quick-start.mdx b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/quick-start.mdx index 4ca69ae..5d54ad4 100644 --- a/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/quick-start.mdx +++ b/i18n/zh-Hans/docusaurus-plugin-content-docs/current/docs/quick-start.mdx @@ -14,19 +14,19 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; [⬇ 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) [⬇ 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) ```shell -docker pull ghcr.io/readycodeio/wukongmp-server:0.2.3 +docker pull ghcr.io/readycodeio/wukongmp-server:0.2.4 ``` @@ -51,11 +51,23 @@ docker pull ghcr.io/readycodeio/wukongmp-server:0.2.3 -:::重要 提示：镜像不附带 **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 + +镜像 **不带模组**。在启动容器之前，请下载二进制程序包并将 `WukongMp.Sdk` 以及你选择的游戏模式模组（`WukongMp.PvP` 或 +`WukongMp.Coop`）复制到本地 `./mods/` 文件夹中。 + +::: + @@ -86,8 +98,9 @@ docker run \ -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： @@ -95,7 +108,7 @@ docker run \ ```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: @@ -105,6 +118,7 @@ services: - ./data:/app/data - ./mods:/app/mods - ./saves:/app/saves + - ./config.json:/app/config.json ``` diff --git a/versioned_docs/version-0.1.0/docs/Development/custom-rpc.md b/versioned_docs/version-0.1.0/docs/Development/custom-rpc.md index 3a99baf..c9d0c08 100644 --- a/versioned_docs/version-0.1.0/docs/Development/custom-rpc.md +++ b/versioned_docs/version-0.1.0/docs/Development/custom-rpc.md @@ -4,7 +4,7 @@ sidebar_position: 5 # Custom RPC -One of the core WukongMP SDK functionalities is the support for arbitrary Remote Procedure Call (RPC) functions. These can have arbitrary payloads and support a number of [Relay Modes](../../api-reference/ReadyM.Api.Multiplayer.Protocol.Enums/ReadyM.Api.Multiplayer.Protocol.Enums.RelayMode.md). +One of the core WukongMP SDK functionalities is the support for arbitrary Remote Procedure Call (RPC) functions. These can have arbitrary payloads and support a number of [Relay Modes](../../api-reference/ReadyM.Api.Multiplayer.Protocol.Enums/ReadyM.Api.Multiplayer.Protocol.Enums.RelayMode). RPC handlers allow you to define your own events that are sent to other players connected to the same server. @@ -22,7 +22,7 @@ public partial class MyRpc(IRpcClient client, IRelaySerializer serializer) : Rpc :::important For any of the RPC handlers to be registered, the class **must** be added to the DI container in your mod's `Initialize` method. -Consult the documentation for [ModBase](../../api-reference/WukongMp.Sdk/WukongMp.Sdk.ModBase.md). +Consult the documentation for [ModBase](../../api-reference/WukongMp.Sdk/WukongMp.Sdk.ModBase). ::: diff --git a/wukong-mp/api-reference/WukongMp.Sdk/WukongMp.Sdk.ModBase.md b/wukong-mp/api-reference/WukongMp.Sdk/WukongMp.Sdk.ModBase.md index b5a57e0..4603d8f 100644 --- a/wukong-mp/api-reference/WukongMp.Sdk/WukongMp.Sdk.ModBase.md +++ b/wukong-mp/api-reference/WukongMp.Sdk/WukongMp.Sdk.ModBase.md @@ -13,7 +13,7 @@ public abstract class ModBase : ICSharpModExV2, ICSharpModEx, ICSharpMod #### Inheritance [object](https://learn.microsoft.com/dotnet/api/system.object) ← -[ModBase](../WukongMp.Sdk/WukongMp.Sdk.ModBase.md) +[ModBase](../WukongMp.Sdk/WukongMp.Sdk.ModBase) #### Implements diff --git a/wukong-mp/docs/Development/custom-rpc.md b/wukong-mp/docs/Development/custom-rpc.md index 1f018d7..519676f 100644 --- a/wukong-mp/docs/Development/custom-rpc.md +++ b/wukong-mp/docs/Development/custom-rpc.md @@ -4,7 +4,7 @@ sidebar_position: 5 # Custom RPC -One of the core WukongMP SDK functionalities is the support for arbitrary Remote Procedure Call (RPC) functions. These can have arbitrary payloads and support a number of [Relay Modes](../../api-reference/ReadyM.Api.Multiplayer.Protocol.Enums/ReadyM.Api.Multiplayer.Protocol.Enums.RelayMode.md). +One of the core WukongMP SDK functionalities is the support for arbitrary Remote Procedure Call (RPC) functions. These can have arbitrary payloads and support a number of [Relay Modes](../../api-reference/ReadyM.Api.Multiplayer.Protocol.Enums/ReadyM.Api.Multiplayer.Protocol.Enums.RelayMode). RPC handlers allow you to define your own events that are sent to other players connected to the same server. @@ -22,7 +22,7 @@ public partial class MyRpc(IRpcClient client, IRelaySerializer serializer) : Rpc :::important For any of the RPC handlers to be registered, the class **must** be added to the DI container in your mod's `Initialize` method. -Consult the documentation for [ModBase](../../api-reference/WukongMp.Sdk/WukongMp.Sdk.ModBase.md). +Consult the documentation for [ModBase](../../api-reference/WukongMp.Sdk/WukongMp.Sdk.ModBase). ::: diff --git a/wukong-mp/docs/Server/installation.mdx b/wukong-mp/docs/Server/installation.mdx index 4aa0c73..50553f5 100644 --- a/wukong-mp/docs/Server/installation.mdx +++ b/wukong-mp/docs/Server/installation.mdx @@ -19,8 +19,8 @@ The WukongMP server is currently distributed in the following formats: | Platform | Architecture | Download | | --- | --- | --- | -| Linux | x64 | [Download for Linux](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-linux64-0.2.3.zip) | -| Windows | x64 | [Download for Windows](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-win64-0.2.3.zip) | +| Linux | x64 | [Download for Linux](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-linux64-0.2.4.zip) | +| Windows | x64 | [Download for Windows](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-win64-0.2.4.zip) | ### Installation @@ -73,6 +73,14 @@ You can adjust server settings by editing the `config.json` file. In the followi | Setting | Type | Purpose | | --- | --- | --- | | `Server:Port` | number | The port on which the server listens for incoming connections | +| `Server:Password` | string | Optional. When set, players must enter this password in the Launcher to join. Leave empty or omit for an open server. | +| `Telemetry:OptOut` | boolean | Set to `true` to opt out of sending anonymous telemetry to ReadyM. Defaults to `false`. | + +:::note + +`Server:Password` gates every player, including admins and whitelisted users. Password-protected servers are shown with a lock on the public server list. + +::: ### First launch @@ -95,27 +103,40 @@ A Linux-based x64 Docker image is also available for those who prefer containeri Pull the image from the registry: ```shell -docker pull ghcr.io/readycodeio/wukongmp-server:0.2.3 +docker pull ghcr.io/readycodeio/wukongmp-server:0.2.4 +``` + +Copy the config file from the image: + +```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 ``` Run: + + + ```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 ``` -Or with 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: @@ -125,8 +146,12 @@ services: - ./data:/app/data - ./mods:/app/mods - ./saves:/app/saves + - ./config.json:/app/config.json ``` + + + :::important The image ships **without mods**. Copy `WukongMp.Sdk` and the mode you want (`WukongMp.PvP`, `WukongMp.Coop`) from the binary ZIP into your `mods/` volume before starting the container. diff --git a/wukong-mp/docs/Server/server-list.mdx b/wukong-mp/docs/Server/server-list.mdx index 0e71f03..9fb423a 100644 --- a/wukong-mp/docs/Server/server-list.mdx +++ b/wukong-mp/docs/Server/server-list.mdx @@ -17,13 +17,21 @@ Any changes made to `config.json` require a **server restart** to take effect. | Setting | Type | Description | | --- | --- | --- | | `Enabled` | boolean | Whether to list the server publicly. | -| `Name` | string | Display name visible in the Launcher. | -| `Gamemode` | string | Game mode tag, shown next to the name. | -| `MaxPlayers` | integer | Maximum number of players. **Must be 1 or greater** (enforced when players connect). | -| `PublicHost` | string | Publicly routable IP address or hostname. See [Host Validation](#host-validation-rules). | +| `Name` | string | Display name visible in the Launcher. Maximum 50 characters. | +| `Gamemode` | string | Game mode tag, shown next to the name. Maximum 15 characters. | +| `Description` | string | Optional. Short description shown on the server's card in the Launcher. Maximum 300 characters. | +| `Country` | string | Optional. Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (e.g. `PL`, `US`, `DE`), used to show a flag on the server's card. | +| `MaxPlayers` | integer | Maximum number of players. Must be between **1 and 64** (enforced when players connect). | +| `PublicHost` | string | Publicly routable IP address or hostname (maximum 253 characters). See [Host Validation](#host-validation-rules). | | `PublicPort` | integer | The advertised port for players to connect to via the public IP. | | `LicenseKey` | string | License key used to obtain verification. See [Verified status](#verified-status). | +:::note + +These limits are enforced when your server reports to the public list. If a value is invalid (for example a description over 300 characters or a malformed country code), the server is not listed. + +::: + Be respectful when choosing a name and gamemode tag, as they will be visible to all players in the Launcher. Violations of the [ReadyM Terms of Service](https://portal.ready.mp/en/terms) may result in your server being removed from the public list or your account being banned. ### Minimal Configuration Example @@ -35,14 +43,15 @@ Be respectful when choosing a name and gamemode tag, as they will be visible to "Enabled": true, "Name": "Bob's arena", "Gamemode": "PvP", + "Description": "Weekly PvP tournaments, all welcome", + "Country": "US", "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 } } ``` diff --git a/wukong-mp/docs/quick-start.mdx b/wukong-mp/docs/quick-start.mdx index fda0563..67369e5 100644 --- a/wukong-mp/docs/quick-start.mdx +++ b/wukong-mp/docs/quick-start.mdx @@ -14,18 +14,18 @@ Get a WukongMP server running in under 5 minutes. -[⬇ Download for Windows (x64, v0.2.3)](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-win64-0.2.3.zip) +[⬇ Download for Windows (x64, v0.2.4)](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-win64-0.2.4.zip) -[⬇ Download for Linux (x64, v0.2.3)](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-linux64-0.2.3.zip) +[⬇ Download for Linux (x64, v0.2.4)](https://readymstorage.blob.core.windows.net/wukong-server-releases/wukong-server-linux64-0.2.4.zip) ```shell -docker pull ghcr.io/readycodeio/wukongmp-server:0.2.3 +docker pull ghcr.io/readycodeio/wukongmp-server:0.2.4 ``` @@ -50,11 +50,21 @@ To change the port (default: `9050`), open `config.json` and edit `Server:Port`. +Copy the config file from the image: + +```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 +``` + +Port configuration is handled by remapping the container ports — see step 3. + :::important + The image ships **without mods**. Before starting the container, download the binary package and copy `WukongMp.Sdk` and your chosen game mode mod (`WukongMp.PvP` or `WukongMp.Coop`) into your local `./mods/` folder. -::: -Port configuration is handled by remapping the container ports — see step 3. +::: @@ -86,8 +96,9 @@ docker run \ -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 ``` Or with Docker Compose: @@ -95,7 +106,7 @@ Or with 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: @@ -105,6 +116,7 @@ services: - ./data:/app/data - ./mods:/app/mods - ./saves:/app/saves + - ./config.json:/app/config.json ```