本指南介绍如何在您的 Rust 服务器上安装 Oxide/uMod 或 Carbon 模组框架、添加社区插件以及通过控制台管理插件。有关常规服务器配置和启动变量,请参阅 Rust 服务器配置指南。
安装 Oxide/uMod 或 Carbon
Oxide(现由 uMod 维护)和 Carbon 是 Rust 的模组框架,允许您安装社区构建的插件。这些框架可以添加经济系统、自定义套件、投票奖励、PvE 保护区域等众多功能。
您无需手动上传任何文件。模组框架通过设置单个启动变量即可自动安装:
- 从 GPanel 控制台选项卡停止您的服务器。
- 登录 GPanel 并进入启动选项卡。
- 找到
FRAMEWORK变量并设置为:oxide— 使用 Oxide/uMod(使用最广泛的框架,拥有最大的插件库)carbon— 使用 Carbon 框架(一个替代方案,拥有自己的插件生态系统)vanilla— 不使用任何模组框架运行
- 启动服务器。框架文件将自动下载并应用。首次使用 Oxide 启动时,将生成
oxide/目录结构。 - 检查控制台日志中是否有类似
Loaded plugin Oxide.Core的信息,以确认 Oxide 已激活。
无需手动下载。当您设置
FRAMEWORK 变量并启动服务器时,框架将自动下载并安装。您无需通过 SFTP 上传 Oxide 或 Carbon 文件。
安装插件
插件以 .cs(C# 源代码)文件形式分发。Oxide 在服务器运行时自动编译它们 — 无需预编译。
- 从 umod.org 或其他可信来源下载插件
.cs文件。 - 使用 SFTP 或 GPanel 文件管理器将
.cs文件上传到服务器上的oxide/plugins/目录。有关 SFTP 的帮助,请参阅如何通过 SFTP 上传文件。 - 如果服务器正在运行,插件将在几秒内被自动检测并编译。您将在控制台中看到确认加载的输出,例如
Loaded plugin MyPlugin v1.2.3 by Author。 - 如果服务器未运行,插件将在下次启动时加载。
Oxide 目录结构
oxide/
plugins/
MyPlugin.cs <- place plugin files here
AnotherPlugin.cs
config/ <- auto-generated plugin config files
data/ <- plugin data files
logs/ <- plugin log files
插件文件必须直接放在
oxide/plugins/ 中。放在子目录中或扩展名不正确的文件将被忽略。每个插件必须具有 .cs 扩展名。
配置插件
大多数插件在首次加载时会在 oxide/config/ 中生成一个 JSON 配置文件。要自定义插件:
- 让插件至少加载一次,以生成默认配置文件。
- 停止服务器(或注意某些插件支持实时配置重新加载)。
- 使用 GPanel 文件管理器或 SFTP 打开
oxide/config/PluginName.json中的插件配置文件。 - 编辑设置并保存文件。
- 使用
oxide.reload PluginName重新加载插件或重启服务器。
通过控制台管理插件
以下命令可以从 GPanel 控制台或通过 RCON 客户端运行。有关 RCON 设置,请参阅 Rust RCON 访问和管理员命令。
| 命令 | 描述 |
|---|---|
oxide.plugins |
列出所有当前已加载的插件及其版本。 |
oxide.load PluginName |
加载位于 oxide/plugins/ 中但尚未加载的插件。 |
oxide.unload PluginName |
卸载插件但不删除文件。 |
oxide.reload PluginName |
更新 .cs 文件后重新加载插件。使用此命令可以在不完全重启服务器的情况下应用插件更新。 |
oxide.reload * |
一次性重新加载所有已加载的插件。 |
更新插件
要将插件更新到新版本:
- 从 umod.org 上的插件页面下载更新后的
.cs文件。 - 将新文件上传到
oxide/plugins/,覆盖现有文件。 - 如果服务器正在运行,Oxide 会检测到文件变更并自动重新编译和重新加载插件。也可以运行
oxide.reload PluginName。 - 检查控制台是否有错误。某些插件更新可能需要更改
oxide/config/中的配置文件。
删除插件
要完全删除插件:
- 在服务器运行时运行
oxide.unload PluginName以卸载插件。 - 从
oxide/plugins/中删除.cs文件。 - 如果不再需要,可以选择删除
oxide/config/中的插件配置文件和oxide/data/中的数据文件。
热门插件
| 插件 | 类别 | 描述 |
|---|---|---|
| Kits | 游戏玩法 | 允许玩家领取预配置的物品套件。适用于新手套件或 VIP 奖励。 |
| Economics | 经济 | 添加服务器货币系统。被许多商店和奖励插件用作依赖项。 |
| ServerRewards | 经济 | 基于积分的奖励系统,通常与 Economics 结合使用以创建游戏内商店。 |
| VoteDay | 实用工具 | 允许玩家投票跳过到白天。减少对漫长夜晚的抱怨。 |
| Clans | 社交 | 添加部落/团队系统,包括部落标签和工具柜共享访问权限。 |
| TruePVE | PvE | 阻止玩家之间的伤害。PvE 服务器配置的必备插件。 |
| Teleportation | 实用工具 | 添加玩家间传送和家园传送命令,带有可配置的冷却时间。 |
| DiscordCore / DiscordMessages | 集成 | 将服务器事件(连接、聊天、死亡)发送到 Discord webhook 频道。 |
仅从可信来源安装插件。uMod 插件的官方来源是 umod.org。来自未知来源的插件可能包含恶意代码,可能危及您的服务器安全。安装前请务必查看插件权限并阅读社区评论。
插件问题故障排除
如果您的插件未加载,请检查以下内容:
- 确认 Oxide 已安装并激活。在 GPanel 的启动选项卡中,
FRAMEWORK变量必须设置为oxide。控制台日志在启动期间应显示Loaded plugin Oxide.Core。 - 插件文件必须直接放在
oxide/plugins/中,并具有准确的.cs扩展名。子目录中的文件或扩展名错误的文件将被忽略。 - 检查控制台和
oxide/logs/中的编译错误。有语法错误的插件将无法加载,错误消息会描述具体问题。 - 某些插件依赖于其他插件(例如,许多商店插件需要 Economics)。请先安装所有必需的依赖项。
有关其他常见服务器问题,请参阅 Rust 服务器故障排除。
需要帮助?
如果您遇到本指南未涵盖的问题,我们的支持团队随时为您提供帮助。提交支持工单,并附上您的服务器 ID、问题描述以及相关的控制台输出。