/// PIMPMYRUST PLUGIN
Custom Rewards
Guide des réglages de Custom Rewards pour cette version. Vérifiez la fiche du plugin avant de l'utiliser sur votre serveur.
Préparer votre fichier
- Vérifiez la version installée
Ce guide décrit Custom Rewards 2.0.4. Le configurateur doit utiliser cette même version.
- Récupérez les réglages
Cliquez sur Importer, puis Depuis mon serveur. Choisissez les fichiers et confirmez leur chargement. Sélectionner un serveur ne remplace pas le document ouvert. Vous pouvez aussi importer des fichiers de cet appareil ou une configuration depuis Mes projets.
- Modifiez et envoyez
Ajustez les réglages, corrigez les erreurs, puis utilisez Envoyer pour transmettre les fichiers au serveur choisi. Un conflit bloque l’envoi jusqu’à votre décision. Vous pouvez toujours exporter seulement les fichiers dont vous avez besoin.
Les envois au serveur disposent de sauvegardes privées. Enregistrer conserve votre travail dans Mes projets ; cette action n’envoie rien au serveur. Un téléchargement permet aussi de reprendre sans connexion.
Réglages de cette version
Général 3
- Version du format de configuration
- Nombre entier · obligatoire
Repère interne du format de configuration. Conservez la valeur fournie pour cette version du plugin.
Chemin JSON
Data Version - Activer
- Activé / désactivé · obligatoire
Activer ce type de récompense. Chaque fichier définit un type indépendant ; ce réglage n’active pas tous les types du serveur.
Chemin JSON
Enabled - Commandes d’ouverture des récompenses
- Liste · obligatoire
Alias chat qui ouvrent ce catalogue, sans / initial. Les joueurs doivent avoir customrewards.<type>.use ; laissez vide si VoteReward ou une autre intégration ouvre déjà ce type. Évitez les alias utilisés par un autre plugin.
Chemin JSON
Commands for show UI
Réglages des récompenses 1
- Récompenses
- Liste d’objets · obligatoire
Récompenses dans l’ordre des paliers du type. Configurez pour chacune son objet ou ses actions, puis les conditions d’accès ; déplacer une entrée change son index de palier.
Chemin JSON
Rewards Settings → Rewards List
Interface 10
- Récompenses par page
- Choix
Nombre de cartes et de paliers affichés par page dans CustomRewards 2.0.4. Augmenter ce nombre réduit la largeur de chaque carte dans la zone existante ; cela ne change pas les points nécessaires à chaque palier.
Chemin JSON
UI Settings → Max Reward By PageValeurs possibles : 3, 5, 8
- Afficher les descriptions
- Activé / désactivé
Afficher sous l’en-tête la description du type de récompense provenant de son fichier de langue. Cela ne crée pas de description individuelle pour chaque gain.
Chemin JSON
UI Settings → Show Description - Taille du texte des descriptions
- Nombre entier
Taille du texte de la description du catalogue et de son titre dans CustomRewards 2.0.4 : cette version utilise ce même réglage pour les deux. Augmenter peut faire déborder les textes longs.
Chemin JSON
UI Settings → Description Font Size - Taille du texte des titres
- Nombre entier
Champ conservé mais non lu par le rendu de CustomRewards 2.0.4. Pour changer la taille du titre du catalogue, utilisez Description Font Size, qui règle aussi la description.
Chemin JSON
UI Settings → Title Font Size - Adresse de l’image de fond
- Texte
Image du cadre de chaque carte de récompense dans CustomRewards 2.0.4, teintée par sa rareté. Utilisez une image directe avec un centre transparent pour laisser voir l’illustration du gain.
Chemin JSON
UI Settings → Background Url - Adresse de l’icône « nouveau »
- Texte
Icône indiquant un gain débloqué, non récupéré et accessible dans CustomRewards 2.0.4. Elle est teintée par sa rareté ; changer l’image ne débloque pas le gain.
Chemin JSON
UI Settings → New Icon Url - Adresse de l’icône de validation
- Texte
Image superposée à une carte déjà récupérée dans CustomRewards 2.0.4. Elle indique l’état enregistré du gain et ne permet pas de le récupérer une seconde fois.
Chemin JSON
UI Settings → Checked Icon Url - Adresse de l’icône de verrouillage
- Texte
Icône montrée dans CustomRewards 2.0.4 lorsque le palier n’est pas débloqué ou qu’une condition d’accès n’est pas satisfaite. Changer l’icône ne modifie pas ces conditions.
Chemin JSON
UI Settings → Lock Icon Url - Adresse de l’icône de page précédente
- Texte
Image du bouton qui revient à la page de récompenses précédente dans CustomRewards 2.0.4. Le plugin décide si la navigation est disponible ; l’image ne change pas le nombre de pages.
Chemin JSON
UI Settings → Prev Icon Url - Adresse de l’icône de page suivante
- Texte
Image du bouton qui passe à la page de récompenses suivante dans CustomRewards 2.0.4. Le plugin décide si la navigation est disponible ; l’image ne change pas le nombre de pages.
Chemin JSON
UI Settings → Next Icon Url
Couleurs de rareté 4
- Commun
- Texte · obligatoire
Teinte du cadre et de l’icône « nouveau » des récompenses Common dans CustomRewards 2.0.4. Elle ne modifie ni leur valeur ni une probabilité de tirage. Couleur Rust RGBA entre 0 et 1 ; la dernière valeur règle l’opacité.
Chemin JSON
UI Settings → Rarity Colors → Common - Rare
- Texte · obligatoire
Teinte du cadre et de l’icône « nouveau » des récompenses Rare dans CustomRewards 2.0.4. Elle ne modifie ni leur valeur ni une probabilité de tirage. Couleur Rust RGBA entre 0 et 1 ; la dernière valeur règle l’opacité.
Chemin JSON
UI Settings → Rarity Colors → Rare - Épique
- Texte · obligatoire
Teinte du cadre et de l’icône « nouveau » des récompenses Epic dans CustomRewards 2.0.4. Elle ne modifie ni leur valeur ni une probabilité de tirage. Couleur Rust RGBA entre 0 et 1 ; la dernière valeur règle l’opacité.
Chemin JSON
UI Settings → Rarity Colors → Epic - Légendaire
- Texte · obligatoire
Teinte du cadre et de l’icône « nouveau » des récompenses Legendary dans CustomRewards 2.0.4. Elle ne modifie ni leur valeur ni une probabilité de tirage. Couleur Rust RGBA entre 0 et 1 ; la dernière valeur règle l’opacité.
Chemin JSON
UI Settings → Rarity Colors → Legendary
Couleurs du thème 8
- Couleur principale
- Texte · obligatoire
Couleur conservée dans le thème mais non utilisée par le rendu de CustomRewards 2.0.4. La modifier ne change pas l’interface de cette version.
Chemin JSON
UI Settings → Theme → Colors → Primary - Couleur secondaire
- Texte · obligatoire
Couleur de la progression remplie et des repères de paliers atteints dans CustomRewards 2.0.4. Elle ne modifie pas les points du joueur. RGBA Rust ; dernière valeur = opacité.
Chemin JSON
UI Settings → Theme → Colors → Secondary - Fond de l’interface
- Texte · obligatoire
Couleur du fond de la fenêtre du catalogue dans CustomRewards 2.0.4. Gardez un contraste lisible avec les cartes et le texte. RGBA Rust ; dernière valeur = opacité.
Chemin JSON
UI Settings → Theme → Colors → Background - Fond des éléments
- Texte · obligatoire
Couleur des panneaux d’en-tête et de description, du fond de progression et de certaines icônes dans CustomRewards 2.0.4. RGBA Rust ; dernière valeur = opacité.
Chemin JSON
UI Settings → Theme → Colors → Surface - Fond des éléments désactivés
- Texte · obligatoire
Teinte utilisée pour les flèches lorsqu’une page précédente ou suivante existe dans le rendu de CustomRewards 2.0.4. Le nom historique ne décide pas si le bouton est utilisable. RGBA Rust ; dernière valeur = opacité.
Chemin JSON
UI Settings → Theme → Colors → SurfaceDisabled - Texte principal
- Texte · obligatoire
Couleur du titre, de la description du catalogue, du X de fermeture et des quantités dans CustomRewards 2.0.4. Vérifiez leur contraste sur les panneaux. RGBA Rust ; dernière valeur = opacité.
Chemin JSON
UI Settings → Theme → Colors → TextPrimary - Texte sur la couleur secondaire
- Texte · obligatoire
Couleur des nombres inscrits sur les repères de paliers dans CustomRewards 2.0.4. Elle ne règle pas le montant d’une récompense. RGBA Rust ; dernière valeur = opacité.
Chemin JSON
UI Settings → Theme → Colors → TextOnSecondary - Couleur d’alerte
- Texte · obligatoire
Couleur du fond du bouton de fermeture dans CustomRewards 2.0.4. Ce réglage ne signale pas une erreur de récompense. RGBA Rust ; dernière valeur = opacité.
Chemin JSON
UI Settings → Theme → Colors → Danger
Instructions du plugin
CustomRewards 2.0.4 — guide
Ce guide concerne la version Codefling 2.0.4. L’édition avec PimpMyCUI concerne la bêta 2.2.0, pas cette version.
Modifier les lots dans le configurateur
L’onglet Récompenses affiche les lots dans un tableau : objet, quantité, palier, rareté, actions et conditions. Recherchez un lot ou cliquez sur son nom pour le modifier. Ajouter un lot ouvre directement ses réglages.
Dans la fenêtre du lot, Contenu regroupe ses gains, Conditions son accès et Visuel sa présentation. Les objets se choisissent avec le catalogue Rust. Les commandes, permissions et groupes restent dans leurs rubriques dédiées. Dupliquer reprend le contenu du lot ; la corbeille demande confirmation. Le tri du tableau ne modifie pas l’ordre des lots dans le fichier.
Installation et fichier exporté
Installez CustomRewards.cs dans le dossier plugins du serveur Oxide ou Carbon. Sauvegardez les fichiers CustomRewards_* avant une mise à jour.
Chaque fichier dans oxide/data/CustomRewards_rewards/ définit un type de récompense. Donnez son nom au type dans le configurateur avant de l’exporter : Starter produit par exemple oxide/data/CustomRewards_rewards/Starter.json. Vérifiez la destination indiquée avant l’export. Ne placez pas ce catalogue dans oxide/config/. Sur Carbon, utilisez le dossier data correspondant.
Le nom sans .json est l’identifiant du type : conservez exactement ce nom dans vos intégrations. Rechargez le plugin après modification. Les exemples restent désactivés jusqu’à votre vérification.
Récompenses et accès
Configurez les commandes d’ouverture sans /, les paramètres visuels et la liste des récompenses. Une récompense peut distribuer un objet, exécuter une commande serveur ou modifier des permissions/groupes. Vérifiez les shortnames, quantités, URLs d’images et conditions d’accès avant d’activer le catalogue. Seul %steamid% est accepté dans les commandes serveur.
Un type activé doit contenir au moins une récompense valide et exécutable. Les conditions et actions contradictoires sont rejetées au chargement. Corrigez l’erreur du journal plutôt que les données des joueurs.
Pour autoriser le groupe par défaut à ouvrir le type Starter, exécutez dans la console serveur :
oxide.grant group default customrewards.starter.useLa permission historique CustomRewards.<Type>.Use reste acceptée. Un administrateur peut ouvrir le catalogue sans ce droit.
Commandes administrateur
customrewards_give <type> <player> <quantity>: ajouter des points.customrewards_wipe_owner <type> <owner>: réinitialiser un propriétaire.customrewards_wipe_all <type>: réinitialiser un type.
Ces commandes exigent CustomRewards.Admin. Les commandes joueur de navigation et de réclamation revérifient les paramètres et conditions côté serveur.
Vérification et récupération
Commencez avec un type désactivé, une petite récompense en bois et une commande d’ouverture unique. Rechargez, corrigez les erreurs, accordez le droit à un groupe de test, puis activez le type. Vérifiez l’ouverture, les pages, le refus sans points, une réclamation et la reconnexion avant d’ajouter des actions privilégiées. CustomRewards ne nécessite pas VoteSystem.
Sauvegardez les données avant une migration ou réinitialisation. Un état invalide n’est pas remplacé silencieusement. Une action externe au résultat incertain nécessite une réconciliation manuelle : ne la relancez pas à l’aveugle. Les actions déjà terminées ne sont pas rejouées.
Intégrations et limites
Le contrat API V2 expose notamment GetRewardTypeStatus_API et TryShowUI_API. Le parent UI est une couche, pas un identifiant d’élément ; Overlay est le choix par défaut. Un parent invalide est rejeté.
La compilation ne prouve pas le rendu en jeu. Livraison, commandes externes, rechargements et comportement Carbon doivent être vérifiés sur votre serveur.
Installer les fichiers
Avec un serveur connecté, cliquez sur Envoyer dans le configurateur. Le résultat indique si les fichiers ont été envoyés et si le plugin a été rechargé. Sans RCON, rechargez le plugin depuis votre panneau serveur après l’envoi.
Sans serveur connecté : Conservez une copie des fichiers actuels. Placez chaque fichier exporté dans le dossier indiqué avant l’export, ou reprenez les chemins du ZIP. Ne placez pas les données ou les traductions dans le dossier config.
Suivez les instructions du plugin ci-dessus pour ses dépendances et son rechargement. L’export ne connecte pas le site à votre serveur.