/// 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.
- Importez votre configuration
Ouvrez le configurateur et importez le JSON actuel. Pour une nouvelle installation, vous pouvez partir de l’exemple proposé.
- Modifiez et téléchargez
Ajustez les réglages, corrigez les erreurs signalées et téléchargez le JSON. Gardez une copie de votre ancien fichier avant de le remplacer.
Votre configuration n’est pas sauvegardée sur le site. Conservez le fichier exporté ; il permet aussi de reprendre plus tard.
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
Commandes chat sans le caractère / initial.
Chemin JSON
Commands for show UI
Réglages des récompenses 1
- Liste des 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 récompenses montrées sur une page. Adaptez-le au nombre de cartes du template pour éviter des emplacements incohérents.
Chemin JSON
UI Settings → Max Reward By PageValeurs possibles : 3, 5, 8
- Afficher les descriptions
- Activé / désactivé
Afficher les descriptions des récompenses dans l’interface, si le template prévoit une zone de description.
Chemin JSON
UI Settings → Show Description - Taille du texte des descriptions
- Nombre entier
Taille du texte descriptif dans l’interface historique. Une grande taille peut faire déborder les descriptions longues.
Chemin JSON
UI Settings → Description Font Size - Taille du texte des titres
- Nombre entier
Taille des titres dans l’interface historique. Vérifiez les noms longs après modification.
Chemin JSON
UI Settings → Title Font Size - Adresse de l’image de fond
- Texte
Adresse directe de l’image à afficher, et non de sa page web. Utilisez une image accessible aux joueurs ; préférez HTTPS.
Chemin JSON
UI Settings → Background Url - Adresse de l’icône « nouveau »
- Texte
Adresse directe de l’image à afficher, et non de sa page web. Utilisez une image accessible aux joueurs ; préférez HTTPS.
Chemin JSON
UI Settings → New Icon Url - Adresse de l’icône de validation
- Texte
Adresse directe de l’image à afficher, et non de sa page web. Utilisez une image accessible aux joueurs ; préférez HTTPS.
Chemin JSON
UI Settings → Checked Icon Url - Adresse de l’icône de verrouillage
- Texte
Adresse directe de l’image à afficher, et non de sa page web. Utilisez une image accessible aux joueurs ; préférez HTTPS.
Chemin JSON
UI Settings → Lock Icon Url - Adresse de l’icône de page précédente
- Texte
Adresse directe de l’image à afficher, et non de sa page web. Utilisez une image accessible aux joueurs ; préférez HTTPS.
Chemin JSON
UI Settings → Prev Icon Url - Adresse de l’icône de page suivante
- Texte
Adresse directe de l’image à afficher, et non de sa page web. Utilisez une image accessible aux joueurs ; préférez HTTPS.
Chemin JSON
UI Settings → Next Icon Url
Couleurs de rareté 4
- Commun
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Rarity Colors → Common - Rare
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Rarity Colors → Rare - Épique
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Rarity Colors → Epic - Légendaire
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Rarity Colors → Legendary
Couleurs du thème 8
- Couleur principale
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Theme → Colors → Primary - Couleur secondaire
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Theme → Colors → Secondary - Fond de l’interface
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Theme → Colors → Background - Fond des éléments
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Theme → Colors → Surface - Fond des éléments désactivés
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Theme → Colors → SurfaceDisabled - Texte principal
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Theme → Colors → TextPrimary - Texte sur la couleur secondaire
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
Chemin JSON
UI Settings → Theme → Colors → TextOnSecondary - Couleur d’alerte
- Texte · obligatoire
Couleur Rust : rouge, vert, bleu et opacité, entre 0 et 1, séparés par des espaces. Exemple : 1 0.5 0 1 = orange opaque ; une opacité de 0 rend l’élément invisible.
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.
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. L’éditeur web exporte un seul type à la fois. Renommez reward-type.json, par exemple en Starter.json, puis installez-le dans oxide/data/CustomRewards_rewards/Starter.json. 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 le fichier
Après avoir conservé une copie de l’ancien fichier, placez le JSON exporté à cet emplacement sur votre serveur :
oxide/data/CustomRewards_rewards/reward-type.jsonSuivez les instructions du plugin ci-dessus pour ses dépendances et son rechargement. L’export ne connecte pas le site à votre serveur.