跳到主要内容

配置文件详解

WebShopX-Payments 拥有两个独立的配置文件：

  1. config.yml：由 Bukkit 插件加载，控制支付通道开关与 API 同步等待超时。
  2. backend/config.json：由内嵌支付后端加载，保存具体的第三方/官方支付接口敏感凭证与代理设置。

1. 插件端 config.yml 详解​

当前版本（已移除游戏内地图二维码功能）config.yml 结构如下：

# ==========================================
# WebShopX-Payments 核心配置文件
# ==========================================

# 支付接口行为控制
payment:
  # 插件等待内嵌后端响应创建支付的最长同步时间（秒）
  api-timeout-seconds: 15
  
  # 各支付通道的游戏内前端开关（控制主商城是否显示这些支付选项）
  enable:
    wechat: true         # 微信支付
    alipay: true         # 支付宝
    paypal: true         # PayPal (国际)
    mercadopago: false   # MercadoPago (拉美)
    stripe: false        # Stripe (信用卡，可选)

2. 后端 backend/config.json 基础架构​

config.json 存放在 plugins/WebShopX-Payments/backend/ 目录下。此处首先介绍全局通用参数与代理结构。

(1) 全局基础参数​

{
  "debug": false,
  "log_level": "INFO",
  "port": 62233,
  "proxy": {
    "enable": false,
    "type": "HTTP",
    "host": "127.0.0.1",
    "port": 7890,
    "username": "",
    "password": ""
  }
}
参数键名类型默认值说明
debugBooleanfalse是否开启调试模式（开启后会输出详细的底层通信日志）。
log_levelString"INFO"控制后端的日志输出级别。可选值包括：INFO, DEBUG, WARN, ERROR 等。
portInteger62233内嵌后端的本地端口。必须和 Bukkit 插件端通信端口保持一致。如果端口冲突请在修改后重启服务端。
proxyObject(见下文)全局代理设置。当服务器难以直连某些海外或外部支付网关时使用。

(2) 通用代理结构 ProxySettings​

在网络连通性受限的服务器环境中，您可以配置代理服务以保证能顺畅连接到境外接口（例如 PayPal 接口或部分被网络限制的通道）。

proxy 对象支持的字段如下：

"proxy": {
  "enable": true,            // 是否启用此代理
  "type": "HTTP",            // 代理类型：支持 "HTTP" 或 "SOCKS"
  "host": "127.0.0.1",       // 代理服务器的 IP 地址或域名
  "port": 7890,              // 代理端口
  "username": "my_user",     // 代理认证用户名（无认证则留空 ""）
  "password": "my_password"  // 代理认证密码（无认证则留空 ""）
}
局部代理覆盖机制

除了上述根节点的全局代理外，在各个具体的支付通道（例如 wechat_native.proxy、paypal.proxy 等）内，也均拥有完全相同的 proxy 对象配置。

  • 如果局部代理未设置，则默认继承根节点的全局代理设置。
  • 如果局部代理显式配置，则会覆盖全局代理，只对当前支付通道生效。