Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {AiAccess, DocHero, FeatureCards, ProjectPanel} from '@site/src/component
title="WebShopX"
description="面向 Paper、Purpur、Spigot 与 Folia 服务端的 Web 商城系统,包含官方商城、玩家市场、钱包、订单与发货、充值和管理后台。"
links={[
{label: 'GitHub ↗', to: 'https://github.com/Cc-Cece/WebShopX'},
{label: 'GitHub ↗', to: 'https://github.com/Prism-Committee/WebShopX-Issues'},
{label: 'Modrinth ↗', to: 'https://modrinth.com/plugin/webshopx'},
{label: 'MineBBS ↗', to: 'https://www.minebbs.com/resources/x-folia-webshopx.15688/'},
]}>
Expand Down Expand Up @@ -63,3 +63,7 @@ import {AiAccess, DocHero, FeatureCards, ProjectPanel} from '@site/src/component
failedLabel="复制失败"
prompt="请读取 https://docs.akihito.dpdns.org/llms.txt 获取本站中文文档索引,并按需读取其中链接的 Markdown 内容。回答时请以这些文档为主要依据,注明相关页面 URL;若文档没有提供答案,请明确说明,不要猜测。"
/>

:::info[问题反馈]
WebShopX 目前不是开源软件。GitHub 仓库用于 Issue 与构建发布,插件请从 [Modrinth](https://modrinth.com/plugin/webshopx) 下载。问题和文档反馈请提交到 [Prism-Committee/WebShopX-Issues](https://github.com/Prism-Committee/WebShopX-Issues)。
:::
28 changes: 24 additions & 4 deletions docs/webshopx/admin/install-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import {DocHero, FeatureCards} from '@site/src/components/DocVisuals';

## 1. 环境要求

当前稳定版为 **v3.2.2**。请选择与 Minecraft 版本和服务端类型匹配的构建。

| Minecraft 运行时 | Java | Folia 构建 |
| --- | ---: | --- |
| `1.18.2+` | 17 | 不提供 |
Expand All @@ -29,17 +31,29 @@ import {DocHero, FeatureCards} from '@site/src/components/DocVisuals';
| `26.2+` | 25 | 提供 |

- 推荐 Paper / Purpur;Spigot 也受支持;
- Folia 必须使用对应 Folia 构建;
- Folia 必须使用对应 Folia 构建,不要混用 Paper 构建;
- 默认数据库为 SQLite;
- 生产或高并发场景推荐 MySQL / MariaDB;
- Vault、WebShopX-Payments 与 YuPay 都是可选软依赖。

## 2. 获取插件

请选择与你的 Minecraft 版本和服务端类型匹配的 JAR:
下载渠道:

- [Modrinth](https://modrinth.com/plugin/webshopx)
- [MineBBS](https://www.minebbs.com/resources/webshopx-minecraft.15688/updates)
- [GitHub Releases](https://github.com/Prism-Committee/WebShopX-Issues/releases/latest)
- [MineBBS](https://www.minebbs.com/resources/x-folia-webshopx.15688/)

每个版本提供多种构建变体:

| 变体 | 说明 |
| --- | --- |
| `full` | 包含 Windows 和 Linux 依赖,体积较大 |
| `slim` | 不含依赖,服务器启动时自动下载,需要能联网 |
| `full-win` | 仅含 Windows 依赖 |
| `full-linux` | 仅含 Linux 依赖 |

Paper / Purpur / Spigot 使用对应的 Paper 构建;Folia 必须使用 Folia 构建。按自己的 Minecraft 版本区间选择 JAR,不要只看文件名里的 `3.2.2`。

## 3. 最快部署:SQLite + internal

Expand Down Expand Up @@ -83,6 +97,8 @@ database:

## 5. 选择部署模式

产品说明里的 Embedded 对应配置值 `internal`(`webshop.server-mode`)。YAML 里请写 `internal` / `external` / `relay`,不要改成 `embedded`。

<Tabs groupId="webshopx-deployment-mode">
<TabItem value="internal" label="internal" default>

Expand Down Expand Up @@ -115,6 +131,10 @@ webshop:
</TabItem>
<TabItem value="relay" label="relay">

:::caution[仍在测试]
Relay 功能已实现,但仍在进一步测试中。使用前请阅读 [Relay 公网访问](./relay-access.md),或加入 QQ 群 / Discord 获取帮助。
:::

Relay 模式下,Minecraft 服务器不需要直接向公网开放 Web 端口。插件主动连接 WebShopX Relay,由 Relay 为对应项目提供公网商城入口。

当前官方服务面板:**[打开 WebShopX Relay 服务面板](https://47.122.127.164/)**。
Expand Down Expand Up @@ -174,4 +194,4 @@ v3 中应从 WebShopX 站点登录后进入管理后台。`/admin.html` 仅用
{icon: '⌨️', title: '命令与权限体系', description: '查询安装后可用命令和管理员权限。', to: './commands-permissions'},
{icon: '⬆️', title: 'v2 → v3 迁移', description: '旧版本升级时确认迁移步骤和兼容边界。', to: './v2-to-v3-migration'},
{icon: '🛠️', title: '运维排障', description: '上线后遇到运行问题时继续排查。', to: './faq'},
]} />
]} />
4 changes: 2 additions & 2 deletions docs/webshopx/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import {DocHero, FeatureCards} from '@site/src/components/DocVisuals';
## 当前文档基线

:::info
本文档以 WebShopX v3 开发线为主要基线。不同发行版本可能存在功能、字段或界面差异;涉及部署、配置和 API 时,请确认实际安装的 WebShopX 版本。
本文档以 WebShopX v3 为主要基线,当前稳定版为 **v3.2.2**(2026-08)。不同发行版本可能存在功能、字段或界面差异;涉及部署、配置和 API 时,请确认实际安装的 WebShopX 版本。
:::

## WebShopX 与 WebShopX-Payments
Expand All @@ -43,4 +43,4 @@ WebShopX 核心负责商城、资产、订单和业务状态。WebShopX-Payments

- 只使用游戏内经济或不需要在线支付:不必安装 WebShopX-Payments;
- 需要充值渠道:阅读 [WebShopX-Payments 文档](../webshopx-payments/overview);
- 开发自己的支付 Provider:阅读 [Payment Provider API](./webshopx-payment-api)。
- 开发自己的支付 Provider:阅读 [Payment Provider API](./webshopx-payment-api)。
4 changes: 2 additions & 2 deletions i18n/en/docusaurus-plugin-content-docs/current/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {AiAccess, DocHero, FeatureCards, ProjectPanel} from '@site/src/component
title="WebShopX"
description="A web shop system for Paper, Purpur, Spigot, and Folia servers, including the official shop, player market, wallets, orders and delivery, recharge, and administration."
links={[
{label: 'GitHub source ↗', to: 'https://github.com/Cc-Cece/WebShopX'},
{label: 'GitHub ↗', to: 'https://github.com/Prism-Committee/WebShopX-Issues'},
{label: 'Modrinth ↗', to: 'https://modrinth.com/plugin/webshopx'},
{label: 'MineBBS ↗', to: 'https://www.minebbs.com/resources/x-folia-webshopx.15688/'},
]}>
Expand Down Expand Up @@ -65,5 +65,5 @@ import {AiAccess, DocHero, FeatureCards, ProjectPanel} from '@site/src/component
/>

:::info[Feedback and issues]
Report WebShopX or documentation issues at [Prism-Committee/WebShopX-Issues](https://github.com/Prism-Committee/WebShopX-Issues).
WebShopX is not open source. The GitHub repository is for issues and builds; download the plugin from [Modrinth](https://modrinth.com/plugin/webshopx). Report WebShopX or documentation issues at [Prism-Committee/WebShopX-Issues](https://github.com/Prism-Committee/WebShopX-Issues).
:::
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,35 @@ import {DocHero, FeatureCards} from '@site/src/components/DocVisuals';

## Requirements

Choose a WebShopX build that matches both your Minecraft runtime and Java version:
Current stable release is **v3.2.2**. Choose a build that matches both Minecraft version and server type.

- Minecraft `1.18.2+`: Java `17`
- Minecraft `1.20.6+` (default line): Java `21`
- Minecraft `26.1+ / 26.2+`: Java `25`
| Minecraft runtime | Java | Folia build |
| --- | ---: | --- |
| `1.18.2+` | 17 | Not available |
| `1.20.6+` | 21 | Available |
| `26.1+` | 25 | Available |
| `26.2+` | 25 | Available |

SQLite is the default database for quick single-server setup. MySQL or MariaDB is recommended for production or multi-server deployments. Vault is optional for `GAME_COIN` integration.
Paper / Purpur are recommended; Spigot is also supported. Folia servers must use the Folia JAR. SQLite is the default for a first single-server setup; MySQL or MariaDB is recommended for production or multi-server deployments. Vault is optional for `GAME_COIN` integration.

## Get the plugin

Download channels:

- [Modrinth](https://modrinth.com/plugin/webshopx)
- [GitHub Releases](https://github.com/Prism-Committee/WebShopX-Issues/releases/latest)
- [MineBBS](https://www.minebbs.com/resources/x-folia-webshopx.15688/)

Each release ships several JAR variants:

| Variant | What it includes |
| --- | --- |
| `full` | Windows and Linux native dependencies (largest) |
| `slim` | No bundled dependencies; downloads them on first start (needs network) |
| `full-win` | Windows dependencies only |
| `full-linux` | Linux dependencies only |

Use a Paper build for Paper / Purpur / Spigot. Folia servers must use a Folia build. Pick the jar for your Minecraft version range, not only the `3.2.2` version string.

## First Startup

Expand All @@ -52,6 +74,8 @@ Replace or disable the default administrator immediately after initialization.

## Deployment Modes

Product copy uses **Embedded** for config `webshop.server-mode: internal`. Keep `internal`, `external`, and `relay` in YAML.

<Tabs groupId="webshopx-deployment-mode">
<TabItem value="internal" label="internal" default>

Expand All @@ -65,6 +89,10 @@ WebShopX serves the API while static files are hosted by Nginx/CDN or another we
</TabItem>
<TabItem value="relay" label="relay">

:::caution[Still in testing]
Relay is implemented but still undergoing further testing. Read [Relay Public Access](./relay-access) first, or ask in the QQ group / Discord.
:::

WebShopX connects outbound to WebShopX Relay, so the Minecraft host does not need to expose the web port directly.

Current official service panel: **[Open the WebShopX Relay service panel](https://47.122.127.164/)**.
Expand Down Expand Up @@ -123,4 +151,4 @@ Do not use SQLite with `master` or `node` cluster roles.
{icon: '⌨️', title: 'Commands and Permissions', description: 'Look up commands and administrator permissions.', to: './commands-permissions'},
{icon: '⬆️', title: 'v2 to v3 Migration', description: 'Review upgrade steps and compatibility boundaries.', to: './v2-to-v3-migration'},
{icon: '🛠️', title: 'Troubleshooting', description: 'Continue here for post-deployment operational issues.', to: './faq'},
]} />
]} />
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The visible navigation intentionally does not mirror the repository's `player/`,
## Documentation baseline

:::info
These docs primarily track the WebShopX v3 development line. Confirm the exact version installed on your server before relying on configuration or API details.
These docs primarily track WebShopX v3. The current stable release is **v3.2.2** (2026-08). Confirm the exact version installed on your server before relying on configuration or API details.
:::

## WebShopX and WebShopX-Payments
Expand All @@ -62,4 +62,4 @@ WebShopX owns the shop, assets, orders, and business state. WebShopX-Payments is
1. Code and configuration shipped with the WebShopX version you actually run.
2. Reference documentation.
3. Guides / Administration / Development task documentation.
4. README files, old screenshots, or third-party tutorials.
4. README files, old screenshots, or third-party tutorials.