README.zh.md

BeatTogether-DockerCompose

一个使用docker compose的简易BeatTogether开服指南

欢迎使用讨论版 Discussions

如何开服

0. 确认你在使用Linux并且安装了Docker
1. 克隆或者下载此仓库
2. 按照你的需求修改json设置文件。 文档见下方.
3. 确认你的当前工作目录(current working directory) 和 PWD 都在这个仓库的根目录
4. docker compose up -d
   • 如果你在更新, 先 docker compose down 和 docker compose pull 再 docker compose up -d
5. 将这个服务器添加进BeatTogether mod的设置中。 详见下方

Json 设置文件

• 这里并不包含全部的选项，下方仅包含了和开服相关的最重要的选项
• 你需要去阅读服务器源代码来找到更多的可用选项
• 以下选项的含义介绍基于我对整个项目的理解

主服务器

master.json

{
  "Urls": "http://0.0.0.0:8989",         // 用于主服务器的GameLift服务监听的ip和端口
  "MasterServer": {
    "EndPoint": "0.0.0.0:2328"           // 用于主服务器监听的ip和端口 (将被弃用，仅为向后兼容)
  },
  "Serilog": {
    "File": {
      "FileSizeLimitBytes": "33554432",  // 最大日志文件大小 (这里是32M)
      "RetainedFileCountLimit": 8        // 最大日志文件数量
    }
  }
}

专用服务器

dedicated.json

{
  "Node": {
    "HostName": "192.168.1.250",         // 用于游戏客户端连接的服务器公网地址
    "BasePort": 30000,                   // 每个游戏房间的端口号从这里开始
    "MaximumSlots": 10000                // 最大房间数
  },
  "Serilog": {
    "File": {
      "FileSizeLimitBytes": "33554432",
      "RetainedFileCountLimit": 8
    }
  }
}

状态Api服务器

api.json

{
  "Urls": "http://0.0.0.0:23280",        // 用于api服务器监听的端口和地址  
  "Status": {
    "MinimumAppVersion": "1.28.0",       // 最低支持的游戏版本
    "RequiredMods": [                    // 游戏mod的版本要求，如果安装了
      {
        "id": "MultiplayerCore",
        "version": "1.2.0"
      },
      {
        "id": "BeatTogether",
        "version": "2.0.1"
      },
      {
        "id": "BeatSaberPlus_SongOverlay",
        "version": "4.6.1"
      },
      {
        "id": "EditorEX",
        "version": "1.2.0"
      },
      {
        "id": "LeaderboardCore",
        "version": "1.2.2"
      }
    ]
  },
  "Serilog": {
    "File": {
      "FileSizeLimitBytes": "33554432",
      "RetainedFileCountLimit": 8
    }
  }
}

BeatTogether Mod 设置

BeatSaber/Userdata/中的BeatTogether.json

{
  ...
  "Servers": [
    ...
    {                                                       // 添加这一段
      "ServerName": "Some Server Namer",
      "HostName": "192.168.1.250",                          // 主服务器的地址
      "ApiUrl": "http://192.168.1.250:8989",                // 将地址和端口替换为主服务器GameLift服务的
      "StatusUri": "http://192.168.1.250:23280/status",     // 将地址和端口替换为api服务器的
      "MaxPartySize": 10
    },
    ...
  ]
  ...
}