Ce guide explique comment installer le framework de modding Oxide/uMod ou Carbon sur votre serveur Rust, ajouter des plugins communautaires et les gérer via la console. Pour la configuration générale du serveur et les variables de démarrage, consultez le Guide de configuration du serveur Rust.
Installation de Oxide/uMod ou Carbon
Oxide (maintenant maintenu sous le nom uMod) et Carbon sont des frameworks de modding pour Rust qui vous permettent d'installer des plugins créés par la communauté. Ces frameworks ajoutent des fonctionnalités telles que des systèmes économiques, des kits personnalisés, des récompenses de vote, des zones de protection PvE, et bien plus encore.
Vous n'avez pas besoin de téléverser de fichiers manuellement. Le framework de modding est installé automatiquement en définissant une seule variable de démarrage :
- Arrêtez votre serveur depuis l'onglet Console de GPanel.
- Connectez-vous à GPanel et allez dans l'onglet Startup.
- Trouvez la variable
FRAMEWORKet réglez-la sur :oxide— pour Oxide/uMod (le framework le plus utilisé, avec la plus grande bibliothèque de plugins)carbon— pour le framework Carbon (une alternative avec son propre écosystème de plugins)vanilla— pour fonctionner sans framework de modding
- Démarrez le serveur. Les fichiers du framework sont téléchargés et appliqués automatiquement. Au premier démarrage avec Oxide, la structure de répertoires
oxide/est générée. - Vérifiez dans le journal de la console qu'une ligne telle que
Loaded plugin Oxide.Coreapparaît pour confirmer qu'Oxide est actif.
FRAMEWORK et démarrez le serveur, le framework est téléchargé et installé automatiquement. Vous n'avez pas besoin de téléverser les fichiers Oxide ou Carbon via SFTP.
Installation de plugins
Les plugins sont distribués sous forme de fichiers .cs (code source C#). Oxide les compile sur le serveur au moment de l'exécution — aucune pré-compilation n'est nécessaire.
- Téléchargez le fichier
.csdu plugin depuis umod.org ou une autre source de confiance. - Téléversez le fichier
.csdans le répertoireoxide/plugins/de votre serveur en utilisant SFTP ou le gestionnaire de fichiers GPanel. Pour de l'aide avec SFTP, consultez Comment transférer des fichiers via SFTP. - Si le serveur est en cours d'exécution, le plugin sera détecté et compilé automatiquement en quelques secondes. Vous verrez une sortie dans la console confirmant son chargement, par ex.
Loaded plugin MyPlugin v1.2.3 by Author. - Si le serveur n'est pas en cours d'exécution, le plugin sera chargé au prochain démarrage.
Structure des répertoires 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/. Les fichiers placés dans des sous-répertoires ou avec des extensions incorrectes seront ignorés. Chaque plugin doit avoir l'extension .cs.
Configuration des plugins
La plupart des plugins génèrent un fichier de configuration JSON dans oxide/config/ lors de leur premier chargement. Pour personnaliser un plugin :
- Laissez le plugin se charger au moins une fois pour qu'il génère son fichier de configuration par défaut.
- Arrêtez votre serveur (ou notez que certains plugins supportent le rechargement de configuration à chaud).
- Ouvrez le fichier de configuration du plugin dans
oxide/config/PluginName.jsonen utilisant le gestionnaire de fichiers GPanel ou SFTP. - Modifiez les paramètres et enregistrez le fichier.
- Rechargez le plugin avec
oxide.reload PluginNameou redémarrez le serveur.
Gestion des plugins via la console
Ces commandes peuvent être exécutées depuis la console GPanel ou via un client RCON. Pour la configuration RCON, consultez Accès RCON et commandes d'administration Rust.
| Commande | Description |
|---|---|
oxide.plugins |
Lister tous les plugins actuellement chargés et leurs versions. |
oxide.load PluginName |
Charger un plugin présent dans oxide/plugins/ mais pas encore chargé. |
oxide.unload PluginName |
Décharger un plugin sans supprimer le fichier. |
oxide.reload PluginName |
Recharger un plugin après avoir mis à jour son fichier .cs. Utilisez ceci pour appliquer les mises à jour de plugins sans redémarrage complet du serveur. |
oxide.reload * |
Recharger tous les plugins chargés en une fois. |
Mise à jour des plugins
Pour mettre à jour un plugin vers une version plus récente :
- Téléchargez le fichier
.csmis à jour depuis la page du plugin sur umod.org. - Téléversez le nouveau fichier dans
oxide/plugins/, en écrasant le fichier existant. - Si le serveur est en cours d'exécution, Oxide détecte le changement de fichier et recompile et recharge automatiquement le plugin. Vous pouvez aussi exécuter
oxide.reload PluginName. - Vérifiez la console pour d'éventuelles erreurs. Certaines mises à jour de plugins peuvent nécessiter des modifications du fichier de configuration dans
oxide/config/.
Suppression de plugins
Pour supprimer complètement un plugin :
- Exécutez
oxide.unload PluginNamepour décharger le plugin pendant que le serveur est en cours d'exécution. - Supprimez le fichier
.csdeoxide/plugins/. - Supprimez éventuellement le fichier de configuration du plugin dans
oxide/config/et les fichiers de données dansoxide/data/si vous n'en avez plus besoin.
Plugins populaires
| Plugin | Catégorie | Description |
|---|---|---|
| Kits | Gameplay | Permet aux joueurs d'obtenir des kits d'objets préconfigurés. Utile pour les kits de démarrage ou les récompenses VIP. |
| Economics | Économie | Ajoute un système de monnaie au serveur. Utilisé comme dépendance par de nombreux plugins de boutique et de récompenses. |
| ServerRewards | Économie | Système de récompenses basé sur des points, souvent combiné avec Economics pour une boutique en jeu. |
| VoteDay | Utilitaire | Permet aux joueurs de voter pour passer au jour. Réduit les plaintes concernant les longues nuits. |
| Clans | Social | Ajoute un système de clans/équipes avec des tags de clan et un accès partagé aux armoires à outils. |
| TruePVE | PvE | Empêche les dégâts joueur contre joueur. Essentiel pour les configurations de serveur PvE. |
| Teleportation | Utilitaire | Ajoute des commandes de téléportation joueur-à-joueur et de retour au domicile avec des temps de recharge configurables. |
| DiscordCore / DiscordMessages | Intégration | Envoie les événements du serveur (connexions, chat, morts) vers un canal webhook Discord. |
Résolution des problèmes de plugins
Si vos plugins ne se chargent pas, vérifiez les points suivants :
- Confirmez qu'Oxide est installé et actif. Dans l'onglet Startup de GPanel, la variable
FRAMEWORKdoit être réglée suroxide. Le journal de la console devrait afficherLoaded plugin Oxide.Coreau démarrage. - Les fichiers de plugins doivent être placés directement dans
oxide/plugins/avec l'extension exacte.cs. Les fichiers dans des sous-répertoires ou avec des extensions incorrectes sont ignorés. - Vérifiez la console et
oxide/logs/pour les erreurs de compilation. Un plugin avec une erreur de syntaxe ne se chargera pas et le message d'erreur décrira le problème. - Certains plugins ont des dépendances sur d'autres plugins (par ex. de nombreux plugins de boutique nécessitent Economics). Installez d'abord toutes les dépendances requises.
Pour d'autres problèmes courants de serveur, consultez Résolution des problèmes du serveur Rust.
Besoin d'aide ?
Si vous rencontrez un problème non couvert dans ce guide, notre équipe de support est disponible pour vous aider. Soumettez un ticket de support en incluant l'ID de votre serveur, une description du problème et toute sortie console pertinente.