diff --git a/docs/zh/FAQ/Defender-exclusions.md b/docs/zh/FAQ/Defender-exclusions.md new file mode 100644 index 000000000..b1979c8ab --- /dev/null +++ b/docs/zh/FAQ/Defender-exclusions.md @@ -0,0 +1,52 @@ +# 如何在Windows Defender防火墙和防病毒软件中创建白名单？ + +!!! info + +``` +在修改防火墙之前，请确保将windows网络设置中的网络设置为专用（假设您在私有网络中）。 + +!！! 免责声明：" + +**防火墙/防御器关闭具有风险**。 + +通过创建排除条款，您了解允许在PC上运行程序并向公众开放家庭网络端口的风险，从而使BeamMP对可能发生在您或您的家庭中的任何和所有损害负责的权利无效。 + +我们对任何外部链接服务或网站上的任何内容不承担任何责任。 +``` + +## 为 BeamMP-Launcher 添加 Windows Defender 防火墙例外规则 + +1. 打开带有高级设置的`Windows Defender防火墙。` +2. 在窗口中，单击`入站`以打开入站规则选项卡。 +3. 点击 `新建规则` 在右上方创建一个新的规则。 +4. 选择`程序`以创建特定于程序的规则。 +5. 请输入 `BeamMP-Launcher.exe` 的完整限定路径。
默认路径为 `%appdata%\BeamMP-Launcher\BeamMP-Launcher.exe`（请勿包含引号）。 +6. 确保允许连接 +7. 给排除项起一个名字(例如：“BeamMP-Launcher”)并保存它。 +8. 重启电脑 + +## 1.1 为 BeamMP-Launcher 添加 Windows Defender 防火墙例外规则 + +1. 打开 `Windows Defender高级防火墙设置`. +2. 在窗口中，点击 `入站` 以打开入站规则选项卡。 +3. 在右上角点击 `新建规则` 以创建一条新的规则。 +4. 选择 `端口` 以创建针对特定程序的规则。 +5. 输入与 ServerConfig.toml 中配置的相同的端口号。 +6. 请输入 `BeamMP-Server.exe` 的完整限定路径。
该文件位于你下载后自行放置的位置。 +7. 确保允许连接 +8. 为该排除规则命名（例如 “BeamMP-Server”），然后保存规则。 +9. 重启电脑 + +## 2. BeamMP-Launcher 与 BeamMP-Server 的 Windows Defender 病毒防护排除设置 + +1. 打开 `Windows 安全中心` 应用. +2. 单击第一个项目`病毒和威胁防护`。 +3. 单击“病毒和威胁防护设置”下方的`管理设置`。 +4. 向下滚动以导航到`排除项`选项卡。 +5. 在那里，单击“添加排除项”并选择`进程`。 +6. 在字段中输入 `BeamMP-Launcher.exe` 或 `BeamMP-Server.exe`，然后保存。 +7. 重启电脑。 + +## 还有问题吗？ + +在[论坛](https://forum.beammp.com)或我们的[Discord服务器](https://discord.gg/beammp) `#support`频道中打开一个频道。 diff --git a/docs/zh/beamng/dev/modding/lua-mods.md b/docs/zh/beamng/dev/modding/lua-mods.md new file mode 100644 index 000000000..6fd097f89 --- /dev/null +++ b/docs/zh/beamng/dev/modding/lua-mods.md @@ -0,0 +1,3 @@ +# lua-mods.md + +此页面需要创建。 diff --git a/docs/zh/community/rules.md b/docs/zh/community/rules.md new file mode 100644 index 000000000..b3da68142 --- /dev/null +++ b/docs/zh/community/rules.md @@ -0,0 +1,53 @@ +--- +hide: + - 导航 +--- + +# BeamMP 社区规则 + +！！！BeamMP员工不受这些规则的严格约束，可以自行决定操作。除这些规则外，Discord的[社区指南](https://discord.com/guidelines/)和[服务条款](https://discord.com/terms/)也适用并强制执行。 + +## BeamMP通用规则（适用于Discord、论坛和游戏内） + +1. 禁止歧视（如性别歧视、种族主义等）：material-information-outline:{title=“这包括直接或有意使用种族/性侮辱或其他词汇来针对个人或群体。”} +2. 禁止欺凌或骚扰：material-information-outline:{title=“这包括使用不必要的行为、未经请求的DM或使用信息、图像或口头交流针对个人。”} +3. 无NSFW、冒犯性或恶意内容：material-information-outline:{title=“这包括包含恶意链接、裸露、色情、过度亵渎或其他冒犯性、恶意和/或不适合在公共场所出现的内容。”} +4. 禁止发送垃圾邮件文本/语音渠道或帖子：material-information-outline:{title=“这包括生成多个帖子或线程，发送相同或类似的消息，滥用语音通信渠道或其他行为，包括加入/离开垃圾邮件。”} +5. 请说英语：material-information-outline:{title=“在可能的情况下，BeamMP内部的所有通信都应使用英语，除非另有指定的特定区域。”} +6. 禁止不适当的个人资料：material-information-outline:{title=“这包括个人资料名称，照片，bios或其他不符合BeamMP/BeamNG/Discord规则和ToS的用户控制内容。”} +7. material-information-outline:{title=“禁止发布个人信息（” doxing "）（包括但不限于真实姓名、地址、电子邮件、密码、银行账户和信用卡信息等）。} +8. material-information-outline:{title=“这包括讨论BeamMP/BeamNG或整个游戏之外的过去或当前世界事件。有一些地方可以对这些话题进行有效的讨论，但BeamMP不是其中之一。”} +9. 非BeamMP/BeamNG内容：material-information-outline:{title="这包括非BeamMP社区、社交媒体渠道或其他外部链接。这适用于在BeamMP社区内发帖，以及以个人广告为目的主动向用户发送DM。”} +10. 禁止冒充工作人员：material-information-outline:{title="这包括声称自己是BeamMP的工作人员，或声称拥有与工作人员相关的能力。这也包括模仿工作人员。”} +11. 禁止利用：material-information-outline:{title=“这包括利用任何漏洞或疏忽来谋取个人利益或对他人的体验产生负面影响。”} +12. 禁止分享 Authkey，禁止用小号刷免费密钥数量，违者永久封禁。 +13. 遵循所有给定的TOS:material-information-outline:{title=“这很重要，因为使用我们的Discord服务器也必须遵循诸如Discord年龄限制（13+）之类的限制。”} +14. 尊重每个人：material-information-outline:{title=“有些话不该说出口，你需要尊重你周围的每个人，并相应地行动。”} +15. 关注类别或频道的主题。：material-information-outline:{title="这应该不说出来，但要保持你的内容在你发布的区域的主题上。例如，支持应该帮助人们或在寻求支持时使用。”} +16. 不要使用过多的大写锁定或表情符号：material-information-outline:{title=“用户应该避免使用过多的大写符号或表情符号/表情符号，以免混淆手头的重点。”} +17. 在支持区域发布之前，请检查[BeamMP FAQ](../../support/player-faq.md) & [BeamMP社区FAQ](https://forum.beammp.com/c/faq/35)。 + +## Discord 规则 + +1. 以上规则适用于这里：material-information-outline:{title=“本文档中提到的所有规则适用于语音聊天。”} +2. 遵循Discord的使用条款和指南：material-information-outline:{title=“遵循Discord在其使用条款和指南中列出的所有规则”} +3. 禁止NSFW音频/流：material-information-outline:{title=“玩家不应该流任何违反BeamMP规则和Discord TOS的内容。”} +4. 上述规则包括赌博服务/网站。 +5. material-information-outline:{title=“禁止过度使用响板、大声播放音乐或使用其他音频通道故意煽动或针对他人。”} +6. 禁止加入/离开滥用：material-information-outline:{title=“大多数用户可能启用声音效果，不要快速加入和离开语音聊天。”} +7. 不要纠缠他人（`@'ing`）：material-information-outline:{title=“这包括在被忽视或拒绝后反复要求他人回应。”} +8. 将bot命令保存在特定于命令的通道中。 +9. 禁止角色扮演：material-information-outline:{title=“这是为了防止由于缺少上下文或防止用户规避某些规则而引起的问题。”} +10. 请勿要求用户通过私信（DM）向你寻求帮助。所有与支持相关的话题均应在 BeamMP Discord 服务器的指定支持频道中进行讨论。 +11. 严禁发送任何可疑的、潜在恶意或具有破坏性的文件及附件（包括但不限于可疑扩展名）。 +12. 不要教/发链接教别人怎么盗版、破解软件、骇入账号、破解付费mod。 +13. 不要发布非BeamNG /BeamMP内容。只允许在专用的[媒体通道](https://discord.com/channels/601558901657305098/705427325646274680)中发送您自己通道的媒体。 +14. 听从工作人员的指示。如果你认为某位员工滥用职权，直接通知他们的领导或项目管理人员。 + +## 如何对您被实施的封禁进行申诉： + +### 封禁上诉可在封禁上诉- BeamMP提交。 + +所有禁令申诉都经过彻底调查，涉及至少两(2)名与本案无关的工作人员/审核小组成员。发出申诉的工作人员将被允许发表评论，但不会以其他方式参与申诉决定。这些上诉结果是最终的。BeamMP保留根据BeamMP社区规则（如上所述）、[Discord ToS](https://discord.com/terms)和其他因素允许或不允许成员的权利。 + +!！! 如果对您采取行动，您将被禁止创建新的Discord或BeamMP帐户来规避禁令。 diff --git a/docs/zh/game/getting-started.md b/docs/zh/game/getting-started.md index 113cc5759..618086ac2 100644 --- a/docs/zh/game/getting-started.md +++ b/docs/zh/game/getting-started.md @@ -1,39 +1,147 @@ # 入门 ---- - -## **开始之前** +## **1. 兼容性** -BeamMP仅与Steam正版的游戏版本兼容。不支持”盗版“版本。 +BeamMP与Windows和Linux完全兼容，与MacOS的兼容性正在研究中。然而，Linux和MacOS都是次要平台，这意味着bug在所难免。 ---- +!!!警告 -## **安装** +``` +BeamMP将无法与盗版或过时版本的BeamNG.drive一起工作。 +BeamMP支持团队不提供盗版/过期副本问题的支持。 +``` -BeamMP目前仅与Windows系统原生兼容。 +## **2. 安装** -### **Windows安装** +### **2a. Windows 安装** 1. 访问[beammp.com](https://beammp.com/)并点击“Download Client”按钮。 2. 解压`BeamMP_Installer.zip`。 3. 运行`BeamMP_Installer.exe`并按照说明进行操作。 4. BeamMP启动器图标应将出现在您的桌​​面上。如果没有，只需在Windows搜索栏中搜索“BeamMP”即可。 5. 启动器运行后，您应该会看到一个终端窗口，随即 BeamNG.drive将自动运行。**请勿**关闭终端窗口。 -6. BeamNG启动后，在主菜单中点击`联机模式`即可开始多人游戏。 -7. 系统将提示您登录或以访客身份游玩（并非所有服务器都允许访客）。您可以在我们的[论坛](https://forum.beammp.com)上创建一个帐户，然后使用相同的凭据登录BeamMP。 -8. 选择您感兴趣的任何服务器，然后点击`连接` 。尽情享受吧！ +6. BeamNG启动后，在主菜单中点击`Repository`按钮，确保`multiplayerbeammp`是**唯一启用**的mod。 +7. 返回主菜单，点击“More..”和“多人模式”按钮开始多人模式。 +8. 系统将提示您登录或以访客身份游玩（并非所有服务器都允许访客）。您可以在我们的[论坛](https://forum.beammp.com)上创建一个帐户，然后使用相同的凭据登录BeamMP。 +9. 选择您感兴趣的任何服务器，然后点击`连接` 。尽情享受吧！ + +!!!注意 + +``` +当你加载到一个有多个车辆的地图时，它可能需要比预期更长的时间才能加入。 +``` + +### **2b. Linux 安装** + +目前您需要自己编译Launcher。为了做到这一点，您需要对如何编译应用程序有一个基本的了解。 + +确保你已经安装了基本的开发工具，通常可以在包中找到，例如： + +- Debian/Ubuntu: `sudo apt install build-essential` +- Fedora: `sudo dnf install cmake gcc gcc-c++ make perl perl-IPC-Cmd perl-FindBin perl-File-Compare perl-File-Copy kernel-headers kernel-devel` +- Arch: `sudo pacman -S base-devel` +- openSUSE: `zypper in -t pattern devel-basis` +- SteamOS (Arch): `sudo pacman -S base-devel linux-api-headers glibc libconfig` (You also need to do `sudo steamos-readonly disable` but make sure to enable it again after installing the packages) + +克隆 `vcpkg` 仓库，执行引导脚本并加入系统路径 + +1. + +```bash +git clone https://github.com/microsoft/vcpkg.git +``` + +1. + +```bash +./vcpkg/bootstrap-vcpkg.sh +``` + +1. + +```bash +export VCPKG_ROOT="$(pwd)/vcpkg" +export PATH=$VCPKG_ROOT:$PATH +``` + +使用`git`将BeamMP-Launcher仓库克隆至本地，操作示例如下：`git clone https://github.com/BeamMP/BeamMP-Launcher.git`。[查看GitHub仓库克隆操作完整指南](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) + +检出[最新发布版本](https://github.com/BeamMP/BeamMP-Launcher/releases/latest)所使用的标签。例如，若最新版本使用`v2.6.4`，则执行`git checkout v2.6.4` + +如果你使用了我们提供的示例克隆命令，你可以使用以下命令进入项目的根目录：
`cd BeamMP-Launcher` + +在项目的根目录中， + +1. + +```cmake +cmake . -B bin -DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-linux +``` + +1. + +```cmake +cmake --build bin --parallel +``` + +!!!注意 "" + +``` +如果在编译时内存耗尽，可以提交——parallel指令，由于只在一个CPU线程上编译，它将使用更少的RAM。 +``` + +!!!注意 "" + +``` +通过不指定‘ -DCMAKE_BUILD_TYPE=Release ’，您正在编译一个调试版本，该版本的文件大小较大，但不包含launcher-can-only-connect-to- server-once错误 +``` + +!!!注意 "Fedora 用户" 如果 vcpkg 在编译 OpenSSL 时因内核头文件（kernel headers）错误而失败，请确保已安装所有依赖项: `bash sudo dnf install kernel-headers kernel-devel gcc gcc-c++ make perl ` 然后清理 vcpkg 缓存：`bash rm -rf $VCPKG_ROOT/buildtrees/openssl `最后重新运行 cmake 配置命令。 + +将已编译完成的应用程序从`/bin`移出，放到它自己的文件夹中，然后从该文件夹运行它： + +```bash +mkdir -p ~/beammp-launcher +cp bin/BeamMP-Launcher ~/beammp-launcher/ +cd ~/beammp-launcher +./BeamMP-Launcher +``` + +原生的 Linux 版 BeamMP 启动器将会启动，并使用原生的 Linux 版 BeamNG.drive。 + +### **2c. 在Proton兼容层上游玩BeamNG.drive** + +若您需要在Proton环境运行BeamNG.drive时同步使用原生Linux版BeamMP启动器，可通过以下方案实现： + +使用`--no-launch`参数运行BeamMP-Launcher（此参数将阻止启动器唤起原生Linux版BeamNG.drive）。更多启动器参数详解请参阅[开发环境配置指南](../guides/beammp-dev/beammp-dev.md) + +将Proton-BeamNG.drive的用户文件夹路径指向Linux-BeamNG.drive的位置（因原生Linux版BeamMP-Launcher当前仅支持向Linux-BeamNG.drive用户文件夹写入数据） + +例如，您可以通过创建符号链接实现该配置 + +- 记录Linux-BeamNG.drive用户文件夹路径（通常位于`~/.local/share/BeamNG.drive`），并将其重命名为类似`BeamNG.drive_old`的名称 +- 记录Proton-BeamNG.drive用户文件夹路径（通常位于`~/.local/share/Steam/steamapps/compatdata/284160/pfx/drive_c/users/steamuser/AppData/Local/BeamNG.drive`） +- 建立双端用户文件夹的符号链接桥接 `ln -s ~/.local/share/Steam/steamapps/compatdata/284160/pfx/drive_c/users/steamuser/AppData/Local/BeamNG.drive ~/.local/share` + +当用户文件夹间符号链接就绪且启动器完成编译后，可通过调整Steam启动参数实现：既让Steam通过Proton运行游戏，又能自动触发启动器执行。请前往Steam库中该游戏的属性设置界面，替换原版游戏启动参数为下方配置模板： + +- `~/BeamMP/BeamMP-Launcher --no-launch & %command% ; killall BeamMP-Launcher` -注意：*当您加载到已有多辆载具的地图时，加入可能需要比预期更长的时间。* +请注意：此配置默认假设您已将编译完成的启动器二进制文件存放于`/home/user/BeamMP/`。请根据实际二进制文件存放路径调整配置，且每次启动器版本更新时需切换至官方Git仓库对应分支重新执行编译流程。 -### **Linux安装** +!!! 提示 "安装表情符号字体实现文本内嵌表情" -请参考[英语文档](https://docs.beammp.com/game/getting-started/#2b-linux-installation) +``` +若需在服务器列表（作为服务器自定义名称组成部分）或游戏内聊天中显示表情符号，您需部署包含表情符号的字形库。例如，可通过安装Windows Segoe UI 表情符号字体的 Linux 移植版实现。 +``` --- -## **已知问题** +## **3. 已知的问题** -- 如果您未看到”联机模式“按钮。确保BeamMP模组已在“模组管理器”中激活，然后尝试按下CTRL+L。 -- 另外，请确保BeamMP是“模组管理器”中**唯一**激活的模组，否则可能会导致问题。 +- 当前原生Linux版BeamMP启动器存在单会话限制：成功连接服务器并断开后需重启启动器。可通过热重载方案实现不关闭游戏进程的快速重启 +- 若未显示多人游戏按钮，请确认以下操作：
检查BeamMP模组是否已安装并在模组管理器中启用
尝试执行热重载快捷键 Ctrl + L +- 任何类型的vpn都可能导致连接问题。 +- 如果启动器报告任何错误，请阅读[FAQ](https://forum.beammp.com/c/faq/35)。 -如果您需要更多安装帮助，欢迎您在我们的[论坛](https://forum.beammp.com)上发帖或在我们的[Discord服务器](https://discord.gg/beammp)上提问（仅英文）。 +如果启动器报告任何错误，请阅读[FAQ](https://forum.beammp.com)。 diff --git a/docs/zh/guides/mod-creation/server/getting-started.md b/docs/zh/guides/mod-creation/server/getting-started.md new file mode 100644 index 000000000..29a296098 --- /dev/null +++ b/docs/zh/guides/mod-creation/server/getting-started.md @@ -0,0 +1,101 @@ +# 创建多人模式 + +## 文件夹结构和基础文件 + +基本的文件夹和文件结构应该是这样的： + +``` +Resources/ +├─ Client/ +│ └─ examplePlugin.zip/ +│ ├─ scripts/ +│ │ └─ modScript.lua +│ └─ lua/ +│ └─ ge/ +│ └─ extensions/ +│ └─ examplePlugin.lua +└─ Server/ + └─ examplePlugin/ + ├─ examplePlugin.lua + └─ further_lua/ + └─ further.lua +``` + +服务器端lua是最基本的，如果您想添加自定义事件，您还至少需要一个客户端lua以及一个modscript.lua + +Server目录需创建多个子文件夹存放各服务端模组。推荐只在根目录保留一个主Lua文件，新增的Lua文件可归类到对应子目录。实际使用中不必严格遵循此规范，若同一层级存在多个Lua文件时，服务器会按文件名称的字母表顺序自动加载。 + +Client目录专门存放将发送给客户端的ZIP格式模组包，当客户端接收后会自动以模组形式加载。该目录若存在其他类型文件会导致服务器启动时报错（但不会阻断服务运行），不过这些无关文件仅会被服务端忽略。核心配置脚本modScript.lua由BeamNG游戏引擎解析，用于指引游戏加载指定插件模块。 + +!!!范例 "" [Download the examplePlugin.zip](../../../../assets/content/ResourcesForExamplePlugin.zip) + +## 服务器端 lua + +更多完整示例可参考examplePlugin模块的实现，现提供一个基础调试示例，实例的功能是显示玩家身份标识 + +```lua +function onInit() --runs when plugin is loaded + + MP.RegisterEvent("onPlayerAuth", "onPlayerAuth") --Provided by BeamMP + + print("examplePlugin loaded") +end + +--A player has authenticated and is requesting to join +--The player's name (string), forum role (string), guest account (bool), identifiers (table -> ip, beammp) +function onPlayerAuth(player_name, role, isGuest, identifiers) + local ip = identifiers.ip + local beammp = identifiers.beammp or "N/A" + print("onPlayerAuth: player_name: " .. player_name .. " | role: " .. role .. " | isGuest: " .. tostring(isGuest) .. " | identifiers: ip: " .. ip .. " - beammp: " .. beammp) +end +``` + +`onPlayerAuth`会在玩家尝试加入时触发，详细信息请参考脚本文档中的[onPlayerAuth条目](../../../scripting/server/latest-server-reference/#onplayerauth) + +以下是使用onPlayerAuth的另一个示例，该示例将通过向客户端返回信息来禁止游客加入服务器，返回的信息会直接显示给玩家： + +```lua +function onPlayerAuth(playerName, playerRole, isGuest, identifiers) + if isGuest then + return "No guests allowed, please use a BeamMP account" + end +end +``` + +关于BeamMP服务端函数的详细信息请查阅[最新版服务端技术文档](../../../scripting/server/latest-server-reference.md) + +## 客户端 lua + +该实现主要遵循[BeamNG扩展模块](https://documentation.beamng.com/modding/programming/extensions/)的技术规范。 + +```lua +local M = {} + +if extensions.isExtensionLoaded("examplePlugin") then + log("E", "examplePlugin", "examplePlugin loaded on client side") + return +end + +return M +``` + +终端输出提示：examplePlugin已完成加载。 + +建议查阅[BeamNG调试输出官方文档](https://documentation.beamng.com/modding/programming/debugging/#a-add-a-log)获取详细说明 + +## modScript.lua + +通常只包含两行 + +```lua +load('examplePlugin') +setExtensionUnloadMode('examplePlugin', 'manual') +``` + +如果你想在日志中看到你的modScript被BeamNG处理，你可以添加一个日志打印 + +```lua +load('examplePlugin') +setExtensionUnloadMode('examplePlugin', 'manual') +log('I', 'modScript', "examplePlugin loaded") +``` diff --git a/docs/zh/server/port-forwarding.md b/docs/zh/server/port-forwarding.md new file mode 100644 index 000000000..a0d275006 --- /dev/null +++ b/docs/zh/server/port-forwarding.md @@ -0,0 +1,220 @@ +# 端口转发 + +!!! 风险 ":material-scale-balance: 免责声明：" + +``` +“端口转发存在风险”。 + +通过端口转发，你理解将家庭网络端口向公众开放的风险，因此无权追究 BeamMP 对你或你家庭可能发生的 任何 损害负责。 + +我们对任何外部链接服务或网站上的内容不承担任何责任。 + +如果你不理解本指南，请考虑使用我们的合作伙伴提供的服务。 +``` + +!!! 警告 + +``` +请确保你的路由器不是仅支持 4G/5G 的设备。如果是混合设备，请在本指南第 3 节中选择有线连接的适配器！ +``` + +## 怎么设置端口转发 + +创建端口转发规则涉及一些详细的网络术语。在操作过程中，请准备记录一些笔记。 + +本指南共有 4 个主要步骤。 + +## 快速指南（更详细的指南见下文） + +
+
+ +
+ +## 详细指南 + +### 1. 分配静态 IP 地址 + +### 方法 1：通过 DHCP 保留设置静态 IP 地址 + +在本地网络中设置静态 IP 地址的另一种方法是使用路由器的 DHCP 保留功能。并非所有路由器都具备此功能，因此这可能不适用于你。请使用你的路由器型号在网上搜索使用手册。 + +如果你已经完成此操作，请直接跳到 [第 2 步](port-forwarding.md#2-log-in-to-your-router)。 + +### 方法 2：在 Windows 中分配静态 IP 地址 + +#### 1.1. 查找您当前的IP地址、网关和DNS服务器： + +在设置静态IP地址之前，我们需要先了解您当前的网络设置。您可能需要记下这些信息，因此请提前打开记事本窗口备用。这一步我们将使用命令提示符进行操作。 + +打开命令提示符。主要有以下三种方式： + +- 按下Windows键，然后输入“cmd”，当看到“命令提示符”高亮显示时按Enter键。 + +
![](../../assets/content/win11-open-cmd.png)
+ +一旦您进入了命令提示符，运行以下命令： + +``` +ipconfig /all +``` + +你会看到大量数据。如果你有虚拟或多个网络适配器，那么你会看到更多数据。如果安装了 Hyper-V 或 Docker，通常会出现许多虚拟适配器。 + +
![](../../assets/content/win11-command-prompt-ipconfig-highlighted.png)
+ +建议使用有线网络连接来运行此服务器，但无线连接也可正常工作。您需要在此列表中寻找具有活跃互联网连接的适配器。滚动列表并找到已分配默认网关的适配器，许多虚拟适配器通常没有默认网关。 + +以下是本地IPv4地址示例，至少有一个适配器应具备这些地址。您需要记下适配器的信息。 + +- 192.168.x.x +- 10.x.x.x. +- 172.16.x.x - 172.31.x.x + +子网掩码（常见取值为255.255.255.0）
默认路由地址（典型配置为192.168.0.1或192.168.1.1） + +!!! info "请注意" BeamMP 目前不支持使用 IPv6 协议托管服务器。 + +#### 1.2. 修改适配器设置 + +现在我们需要更改网络适配器的设置，以便您的计算机能够维持当前分配的IP配置。访问网络设置的最快捷途径是： + +- 单击Windows键 +- 输入“网络连接”，直到您看到“查看网络连接”。 +- 按下回车键 + +
![](../../assets/content/win11-start-menu-view-network-connections.png)
+ +你会看到电脑上的网络连接列表。如果你安装了 Hyper-V 或 Docker，可能会有很多适配器。请寻找任何不命名为 "Hyper-V" 的适配器。 + +
![](../../assets/content/win11-network-connections.png)
+ +右键点击您的适配器并选择属性。如果`互联网协议版本4`未被勾选，则表明此适配器选择有误，请更换其他适配器。 + +
![](../../assets/content/win11-ethernet-properties-highlighted.png)
+ +双击`互联网协议版本4`。将`自动获取IP地址`更改为`使用以下IP地址`。 + +使用命令提示符（ipconfig /all）中的信息填写IP地址、子网掩码、默认网关和首选DNS服务器。 + +或者，您也可以不使用当前DNS服务器，而选择CloudFlare或Google提供的DNS服务器： + +- CloudFlare DNS: 1.1.1.1, 1.0.0.1 +- Google DNS: 8.8.8.8, 8.8.4.4 + +
![](../../assets/content/win11-network-settings-static-ip.png)
+ +点击确定，然后再次点击确定，您的适配器现在已从DHCP更改为静态IP配置。请上网浏览以确认是否仍然保持互联网连接。如果无法连接，请将设置改回自动获取IP地址，并尝试下一种方法。 + +### 2. 登录您的路由器 + +既然您的设备已设置静态IP地址，现在可以开始为BeamMP配置端口转发。 + +首先，我们需要登录到您的路由器。之前您记录下来的设置中包括默认网关，该地址即为您路由器的IP地址。 + +大多数路由器通过本地网页界面进行管理。要访问路由器的管理菜单和设置： + +- 打开一个浏览器，Firefox, Chrome 或 Edge应该都可以正常工作 +- 在地址栏中，输入您的默认网关IP地址，例如 192.168.0.1 或 192.168.1.1，然后按回车键。 + +现在您应该能看到路由器的登录界面。并非所有路由器都需要登录，但大多数都需要。您需要知道路由器的用户名和密码。如果是首次登录，用户名和密码很可能仍为出厂默认值，或者在某些情况下会印在路由器的贴纸标签上。 + +以下是部分最常见的出厂默认用户名与密码列表： + +用户名 | 密码 +--- | --- +admin | admin +admin | password +{blank} | admin +{blank} | password + +尝试使用admin、password等不同组合，或直接留空输入框。*若提示留空，请尝试不填写任何内容。* + +### 3. 创建转发规则 + +#### 3.1. 查找端口转发设置的地方 + +在路由器网页界面中找到端口转发设置区域。请通过点击页面顶部或左侧的选项卡或链接来浏览路由器菜单。大多数路由器会将端口转发功能列在"网络"、"高级"或"局域网"等分类下。留意查找以下关键词来定位该功能： + +- 端口转发 +- 转发 +- 端口范围转发 +- 虚拟服务器 +- 应用程序 & 游戏 +- 高级配置/设置 +- NAT + +#### 3.2. 填写详细信息 + +找到路由器的端口转发设置后，即可开始输入必要信息。路由器会提供输入区域用于填写需要转发的端口号以及对应的目标IP地址。若路由器同时显示内部端口和外部端口选项，请确保填写相同的端口号以保持一致。 + +BeamMP 需要同时开放 UDP 和 TCP 协议的 30814 端口（除非您已在 [ServerConfig.toml](create-a-server.md#4-configuration) 配置文件中修改过此端口）。 + +!!! info "注意"
虽然默认端口为 **30814**，您也可以选择1024至65535之间的其他端口号（若使用非默认端口需自行记录）。需要同时转发 **TCP** 和 **UDP** 协议。
建议保持使用默认端口，因此端口被本机其他服务占用的可能性极低。若需在同一台机器上部署多个服务器，则每个服务器需使用不同端口（例如：服务器1使用30814，服务器2使用30815）。 + +在某些路由器中，您可能需要创建两条规则（一条用于UDP，另一条用于TCP），而有些路由器则更便捷，允许您通过单条规则同时设置两种协议！ + +绝大多数路由器都设有“保存”按钮，而部分机型在更改生效前还需重启或复位系统。 + +### 4. 测试一下！ + +连接测试可通过以下几种不同方式进行。 + +我们推荐的方式是使用我们的工具 **CheckBeamMP**，因为它能够检测BeamMP特有的问题和协议。 + +
+ +
+ +
+ +
+ +可通过获取您的公网IPv4地址来实现，该方法同样有几种不同的操作方式。主要方法是访问名为 [whatsmyip.org](https://whatsmyip.org/) 的网站，这是一个能直接显示您公网IP地址的简易网站。您需要找到格式为 xxx.xxx.xxx.xxx 的IP地址。 + +访问以下链接，并将“IP”替换为您的实际IPv4地址，“Port”替换为您的服务器端口。请确保不留空格。https://check.beammp.com/api/v2/beammp/ip/port + +!!! 成功 "status: ok" + +``` +若获得上述输出结果，即可加入您的服务器！ 有两种连接方式：既可通过在端口转发工具中配置的详细信息直接连接，也可在服务器设置为"公开"状态下通过服务器列表加入。 由于您采用的是本地托管服务器，若服务器与游戏运行在同一台电脑上，请使用 127.0.0.1（本地主机）；若服务器运行在局域网内的其他机器上，则使用该服务器的局域网IPv4地址。 +``` + +!!! 失败 "status: error" + +``` + + +如果连接完全失败，您的ISP可能正在使用CGNAT（运营商级网络地址转换）。有关更多详细信息，请查看[如何检查CGNAT？](../FAQ/How-to-check-for-CGNAT.md)，或者在我们的[Discord服务器](https://discord.gg/beammp)的`#support`频道中提交服务器支持工单，我们的工作人员会处理您的工单！如果您只看到TCP工作而UDP失败，请再次检查防火墙和端口转发规则。 +``` diff --git a/docs/zh/server/server-maintenance.md b/docs/zh/server/server-maintenance.md new file mode 100644 index 000000000..1fdedc622 --- /dev/null +++ b/docs/zh/server/server-maintenance.md @@ -0,0 +1,245 @@ +# 服务器维护 + +有关如何配置和维护 BeamMP 服务器的指南、提示和技巧。 + +## 怎么安装 + +有关安装说明，请查看 [服务器安装](create-a-server.md). + +## ServerConfig文件 + +服务器配置，即一个名为`ServerConfig.toml`的文件, 使用了 [TOML 格式](https://toml.io/en/). + +*注意*：*旧的*服务器配置文件名为`Server.cfg`，但该文件已不再使用，若其仍存在服务器将发出警告。另请注意，两种配置格式**不**相互兼容。 + +该配置文件默认包含一个名为`[General]`的节，该节包含以下值： + +Key | 值类型 | 描述 +--- | --- | --- +Port | 1024-65535 | 服务器可访问的网络端口。（必须是唯一的，且不能被同一主机上的其他服务占用） +AuthKey | 认证密钥格式为`xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`，其中所有x代表字母数字字符（数字和字母）。 | 用于通过后端识别公共集合服务器。 +AllowGuests | true/false | 决定游客是否可以加入服务器。 +LogChat | true/false | 当启用（设置为“true”）时，聊天消息会被记录在 server.log 文件中。 +Debug | true /false | 当启用（true）时，将在日志中显示更多消息并提供更多信息。如果遇到问题，请启用此选项。启用此选项将显著增加日志文件的大小。 +Private | true/false | 当启用（true）时，您的服务器将不会显示在服务器列表中。任何拥有正确IP地址和端口的人仍然可以连接。 +InformationPacket | true/false | 当启用（true）时，服务器将允许未经身份验证的客户端直接通过服务器获取与服务器列表中相同的信息。 +Name | Any "text" | 在服务器列表中显示为您的服务器名称/标题。您可以使用特殊字符来为其添加颜色和样式。 +Tags | 请参见下方允许的标签列表。 | 标签用于搜索 e.g. Police, Racing etc... +MaxCars | 数字永远 ≥ 1 | 每位玩家的最大车辆数量。玩家尝试生成的额外车辆将被立即删除。 +MaxPlayers | 数字永远 ≥ 1 | 每个服务器的最大玩家数量。这不影响车辆数量。 +Map | 需要一个有效的地图位置，例如`/levels/gridmap_v2/info.json` | 你的服务器将要托管的地图。必须默认安装（下方可找到列表）或作为服务器模组安装。 +Description | 永远只能填写 "文本" | 在服务器列表中显示为服务器的描述（如果服务器是公开的）。你可以使用特殊字符来格式化这个描述，包括颜色和样式。 +ResourceFolder | 有效的文件夹位置，例如 "D:\Server\BeamMP\Resources" | 便于将服务器和资源文件夹分开存储。 +ImScaredOfUpdates | true/false | 这设置服务器在新版本发布时是否自动更新。 +UpdateReminderTime | 任何带有s、min、h、d后缀的数字（例如30s）。 | 设置在终端中打印的更新提醒消息的间隔。 + +其他部分可以并且应该由服务器插件使用（Lua API 即将推出），例如：`[MyMod]`。 + +AuthKey **必须**由你自己来设置。
默认情况下它是空的，需要填入你之前安装步骤中获得的 AuthKey。
请勿将此密钥分享给任何人，在截图时要完全模糊处理此密钥。 + +### 所有原版地图名称 + +以下是所有原版地图： + +- /levels/gridmap_v2/info.json +- /levels/johnson_valley/info.json +- /levels/automation_test_track/info.json +- /levels/east_coast_usa/info.json +- /levels/hirochi_raceway/info.json +- /levels/italy/info.json +- /levels/jungle_rock_island/info.json +- /levels/industrial/info.json +- /levels/small_island/info.json +- /levels/smallgrid/info.json +- /levels/utah/info.json +- /levels/west_coast_usa/info.json +- /levels/driver_training/info.json +- /levels/derby/info.json + +### 自定义你的服务器名称外观 + +在服务器列表中，在你的文本前使用这些特殊符号，即可为该文本应用对应效果： + +值 | 描述 +:-: | --- +`^r` | 重设 +`^p` | 换行（仅描述） +`^n` | 下划线 +`^l` | 加粗 +`^m` | 删除线 +`^o` | 斜体字 +`^0` | 黑色 +`^1` | 蓝色 +`^2` | 绿色 +`^3` | 亮蓝色 +`^4` | 红色 +`^5` | 粉色 +`^6` | 橙色 +`^7` | 灰色 +`^8` | 深灰色 +`^9` | 亮紫色 +`^a` | 亮绿色 +`^b` | 亮蓝色 +`^c` | 深橙色 +`^d` | 亮粉色 +`^e` | 黄色 +`^f` | 白色 + +### 自定义您的服务器标签 + +标签可用于让人们搜索特定类型的服务器。
你的 serverConfig.toml 将会自动生成带有 freeroam 标签的配置：
`Tags = "Freeroam"` + +你可以添加多个标签，用逗号分隔
`Tags = "Events,Offroad,lang:english"`，
标签不区分大小写。 + +你可以从以下列表中选择： + +- 年龄/内容： + + - `Mature/18+` + +- 游戏玩法类型: + + - `Freeroam` + - `Roleplay` + - `Economy` + - `Traffic` + +- 比赛类型: + + - `Racing` + - `Racing:NASCAR` + - `Racing:Track` + - `Racing:Drag` + - `Racing:Rally` + - `Touge` + +- 越野活动与挑战： + + - `Offroad` + - `Crawling` + - `Dakar` + - `Challenge` + +- 破坏事件： + + - `Derby` + - `Arena` + +- 天气与时间状况： + + - `Snow/Ice` + - `Rain` + - `Night` + - `Weather` + +- 游戏模式： + + - `Gamemode` + - `Gamemode:Racing` + - `Gamemode:Rally` + - `Gamemode:Drag` + - `Gamemode:Derby` + - `Gamemode:Infection` + - `Gamemode:Cops-Robbers` + - `Gamemode:Delivery` + - `Gamemode:Sumo` + +- 社区与活动： + + - `Scenarios` + - `Events` + - `Leaderboard` + +- 模组： + + - `Modded` + - `Mod:BeamPaint` + - `Mod:BeamJoy` + - `Mod:CEI` + +- 语言： + + - `Lang:English` + - `Lang:Russian` + - `Lang:French` + - `Lang:Spanish` + - `Lang:Portuguese` + - `Lang:German` + - `Lang:Polish` + - `Lang:Arabic` + +- 其他： + + - `Vanilla` + - `Moderated` + +如果某个标签不在此列表中，你可以提交请求要求添加 [在这里](https://forum.beammp.com/t/introducing-server-tags/1320081) + +## Server.log 文件 + +此文件将在服务器运行时生成。它是你在运行服务器时控制台中看到的日志的镜像。
每次需要向我们的支持人员寻求帮助时，都应附上此文件，而且它永远不会显示你的 AuthKey，因此通常无需修改即可直接发送。 + +格式如下（$ 前缀表示“变量”，详见下方说明）： + +``` +[$DATE $TIME] $CONTEXT [$LOG_LEVEL] $MESSAGE +``` + +地点： + +- `$DATE` 是消息的日期，例如 21/07/2021 +- `$TIME` 是消息的时间，例如 11:05:23 +- `$CONTEXT`（仅在调试模式下可见，主要与开发者相关）是消息的上下文，可能为以下之一： + - `(Player ID) “Player Name”`，其中玩家的ID对管理非常有用 + - 翻译 一个简短的名称，例如 “HeartbeatThread” +- `$LOG_LEVEL` 是消息重要性级别之一： + - `DEBUG`：仅在调试模式下可见，通常信息量很大，仅对开发者重要 + - `INFO`：一般信息 + - `LUA`：来自 Lua 插件的消息 + - `WARN`：描述了通常不应该发生的事情。 + - `ERROR`：发生了非常严重的问题，或者出现了完全意料之外的情况 + - `FATAL`：发生了导致服务器关闭的事件 +- `$MESSAGE` 消息本身，通常是你需要注意并理解的内容。
在某些情况下它可能显得比较隐晦，但一般规则是：只要服务器表面上没有任何明显问题，也没有出现 ERROR，那就一切正常。 + +## 更新服务器 + +### 为什么要更新服务器 + +每次发布新更新时，建议你更新服务器。通常这包括错误修复、稳定性提升和安全性改进，同时还会引入新的通用功能等。 + +要接收更新发布时的新闻，你可以：
关注 Discord 服务器的“update”频道
在论坛上留意相关信息
查看或询问 [GitHub releases 页面](https://github.com/BeamMP/BeamMP-Server/releases) + +### 怎么更新服务器 + +#### 如果你正在使用 BeamMP 合作的托管服务提供商 + +如果你正在使用 BeamMP 合作的托管服务提供商，下面的说明很可能不适用。
我们建议你等待托管服务提供商提供更多详细信息，或者直接联系他们寻求帮助。 + +#### 管理自己的服务器 + +服务器通过将旧的可执行文件替换为新的来更新。
如果你不确定如何操作，下面提供了 Windows 和 Linux 的分步说明。 + +如果你是从源代码构建的，只需重新构建即可。
在重新构建之前，请确保运行以下命令：
`git submodule update --init --recursive` + +#### 在Windows中 + +1. 确保你已安装 [Visual C++ Redistributables](https://aka.ms/vs/17/release/vc_redist.x64.exe)，以便运行服务器。 +2. 前往 [BeamMP.com](https://beammp.com/) 并点击“Download Server”按钮。 +3. 下载完成后，你应该会看到一个名为 `BeamMP-Server.exe` 的文件。我们将这个文件称为“新可执行文件”。 +4. 前往你的当前 `BeamMP-Server.exe` 可执行文件所在的文件夹（通常也是 `ServerConfig.toml` 所在的同一文件夹）。我们将这个文件称为“旧可执行文件”。 +5. 将旧的可执行文件替换为新的可执行文件（例如，通过复制或移动新可执行文件到该文件夹中）。 + +#### 在Linux中 + +1. 前往 [BeamMP.com](https://beammp.com/) 并点击“Download Server”按钮，你将被重定向到服务器的 GitHub Releases 页面。 +2. 下载适用于你发行版的正确版本。为方便起见，从现在起我们将它称为 `BeamMP-Server-xxx`，其中 `xxx` 表示你所使用发行版的对应版本。 +3. 下载完成后，你应该会看到一个名为 `BeamMP-Server-xxx` 的文件（具体名称取决于你下载的版本）。
我们将这个文件称为“新可执行文件”。 +4. 前往你的当前 `BeamMP-Server-xxx` 可执行文件所在的文件夹（通常也是 `ServerConfig.toml` 所在的同一文件夹）。
我们将这个文件称为“旧可执行文件”。 +5. 将旧的可执行文件替换为新的可执行文件（例如，通过复制或移动新可执行文件到该文件夹中）。 +6. 在你刚刚替换可执行文件的那个文件夹中打开终端，然后运行以下命令：
`sudo chmod +x BeamMP-Server-xxx`
这将确保服务器可以被运行。 + +### 自动更新 + +服务器（目前）不支持自动更新或更新通知。 + +不过，你可以通过向 GitHub API 查询最新 release 来检查服务器版本与标签的对比。
你可以通过 GET 请求从以下地址获取：
`https://api.github.com/repos/BeamMP/BeamMP-Server/git/refs/tags`