Este guia cobre como instalar o framework de modding Oxide/uMod ou Carbon no seu servidor Rust, adicionar plugins da comunidade e gerenciá-los via console. Para configuração geral do servidor e variáveis de inicialização, consulte o Guia de Configuração do Servidor Rust.
Instalando o Oxide/uMod ou Carbon
Oxide (agora mantido como uMod) e Carbon são frameworks de modding para Rust que permitem instalar plugins criados pela comunidade. Esses frameworks adicionam recursos como sistemas de economia, kits personalizados, recompensas por voto, zonas de proteção PvE e muito mais.
Você não precisa fazer upload de nenhum arquivo manualmente. O framework de modding é instalado automaticamente definindo uma única variável de inicialização:
- Pare seu servidor pela aba Console do GPanel.
- Faça login no GPanel e vá para a aba Startup.
- Encontre a variável
FRAMEWORKe defina como:oxide— para Oxide/uMod (o framework mais amplamente utilizado, com a maior biblioteca de plugins)carbon— para o framework Carbon (uma alternativa com seu próprio ecossistema de plugins)vanilla— para rodar sem nenhum framework de modding
- Inicie o servidor. Os arquivos do framework são baixados e aplicados automaticamente. Na primeira inicialização com Oxide, a estrutura de diretórios
oxide/é gerada. - Verifique o log do console por uma linha como
Loaded plugin Oxide.Corepara confirmar que o Oxide está ativo.
FRAMEWORK e inicia o servidor, o framework é baixado e instalado automaticamente. Você não precisa fazer upload de arquivos do Oxide ou Carbon via SFTP.
Instalando Plugins
Plugins são distribuídos como arquivos .cs (código-fonte C#). O Oxide os compila no servidor em tempo de execução — nenhuma pré-compilação é necessária.
- Baixe o arquivo
.csdo plugin em umod.org ou outra fonte confiável. - Faça upload do arquivo
.cspara o diretóriooxide/plugins/no seu servidor usando SFTP ou o gerenciador de arquivos do GPanel. Para ajuda com SFTP, consulte Como Fazer Upload de Arquivos via SFTP. - Se o servidor estiver rodando, o plugin será detectado e compilado automaticamente em poucos segundos. Você verá uma saída no console confirmando que foi carregado, ex.:
Loaded plugin MyPlugin v1.2.3 by Author. - Se o servidor não estiver rodando, o plugin será carregado na próxima inicialização.
Estrutura de Diretórios do 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/. Arquivos colocados em subdiretórios ou com extensões incorretas serão ignorados. Cada plugin deve ter a extensão .cs.
Configurando Plugins
A maioria dos plugins gera um arquivo de configuração JSON em oxide/config/ na primeira vez que são carregados. Para personalizar um plugin:
- Deixe o plugin carregar pelo menos uma vez para que ele gere seu arquivo de configuração padrão.
- Pare seu servidor (ou note que alguns plugins suportam recarga de configuração ao vivo).
- Abra o arquivo de configuração do plugin em
oxide/config/PluginName.jsonusando o gerenciador de arquivos do GPanel ou SFTP. - Edite as configurações e salve o arquivo.
- Recarregue o plugin com
oxide.reload PluginNameou reinicie o servidor.
Gerenciando Plugins via Console
Esses comandos podem ser executados pelo console do GPanel ou via um cliente RCON. Para configuração do RCON, consulte Acesso RCON e Comandos de Admin do Rust.
| Comando | Descrição |
|---|---|
oxide.plugins |
Lista todos os plugins atualmente carregados e suas versões. |
oxide.load PluginName |
Carrega um plugin que está presente em oxide/plugins/ mas ainda não foi carregado. |
oxide.unload PluginName |
Descarrega um plugin sem remover o arquivo. |
oxide.reload PluginName |
Recarrega um plugin após atualizar seu arquivo .cs. Use isso para aplicar atualizações de plugins sem reiniciar o servidor completamente. |
oxide.reload * |
Recarrega todos os plugins carregados de uma vez. |
Atualizando Plugins
Para atualizar um plugin para uma versão mais recente:
- Baixe o arquivo
.csatualizado da página do plugin em umod.org. - Faça upload do novo arquivo para
oxide/plugins/, sobrescrevendo o arquivo existente. - Se o servidor estiver rodando, o Oxide detecta a alteração do arquivo e automaticamente recompila e recarrega o plugin. Alternativamente, execute
oxide.reload PluginName. - Verifique o console para quaisquer erros. Algumas atualizações de plugins podem exigir alterações no arquivo de configuração em
oxide/config/.
Removendo Plugins
Para remover um plugin completamente:
- Execute
oxide.unload PluginNamepara descarregar o plugin enquanto o servidor está rodando. - Delete o arquivo
.csdeoxide/plugins/. - Opcionalmente, delete o arquivo de configuração do plugin de
oxide/config/e os arquivos de dados deoxide/data/se você não precisar mais deles.
Plugins Populares
| Plugin | Categoria | Descrição |
|---|---|---|
| Kits | Gameplay | Permite que jogadores resgatem kits de itens pré-configurados. Útil para kits iniciais ou recompensas VIP. |
| Economics | Economia | Adiciona um sistema de moeda no servidor. Usado como dependência por muitos plugins de loja e recompensa. |
| ServerRewards | Economia | Sistema de recompensas baseado em pontos, frequentemente combinado com Economics para uma loja dentro do jogo. |
| VoteDay | Utilidade | Permite que jogadores votem para pular para o dia. Reduz reclamações sobre noites longas. |
| Clans | Social | Adiciona um sistema de clãs/equipes com tags de clã e acesso compartilhado a tool cupboards. |
| TruePVE | PvE | Previne dano jogador contra jogador. Essencial para configurações de servidor PvE. |
| Teleportation | Utilidade | Adiciona comandos de teletransporte entre jogadores e para casa com cooldowns configuráveis. |
| DiscordCore / DiscordMessages | Integração | Envia eventos do servidor (conexões, chat, mortes) para um canal de webhook do Discord. |
Solução de Problemas com Plugins
Se seus plugins não estão carregando, verifique o seguinte:
- Confirme que o Oxide está instalado e ativo. Na aba Startup do GPanel, a variável
FRAMEWORKdeve estar definida comooxide. O log do console deve mostrarLoaded plugin Oxide.Coredurante a inicialização. - Os arquivos de plugin devem ser colocados diretamente em
oxide/plugins/com a extensão exata.cs. Arquivos em subdiretórios ou com extensões erradas são ignorados. - Verifique o console e
oxide/logs/para erros de compilação. Um plugin com erro de sintaxe falhará ao carregar e a mensagem de erro descreverá o problema. - Alguns plugins têm dependências de outros plugins (ex.: muitos plugins de loja requerem Economics). Instale todas as dependências necessárias primeiro.
Para outros problemas comuns do servidor, consulte Solução de Problemas do Servidor Rust.
Precisa de Ajuda?
Se você encontrar um problema não coberto neste guia, nossa equipe de suporte está disponível para ajudar. Envie um ticket de suporte e inclua o ID do seu servidor, uma descrição do problema e qualquer saída relevante do console.