Aller au contenu
← Toute la documentation

/// 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

  1. Vérifiez la version installée

    Ce guide décrit Custom Rewards 2.2.0. Le configurateur doit utiliser cette même version.

  2. 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.

  3. 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 6
Version du format de configuration
Choix · obligatoire

Repère interne du format de configuration. Conservez la valeur fournie pour cette version du plugin.

Chemin JSONData Version

Valeurs possibles : 4

Activer
Activé / désactivé · obligatoire

Autorise l’ouverture et la distribution des gains de ce catalogue. Le joueur doit aussi avoir sa permission d’accès.

Chemin JSONEnabled
Commandes d’ouverture
Liste · obligatoire

Alias de chat qui ouvrent ce catalogue, sans barre oblique. Le nom du fichier reste l’identifiant utilisé par les autres plugins.

Chemin JSONCommands for show UI
Animations de récompense
Liste d’objets

Animations interactives nommées que les récompenses peuvent référencer par leur identifiant. Elles présentent le gain, mais ne choisissent pas la récompense et ne la distribuent pas seules.

Chemin JSONInteractive experiences
Next reward ID (managed by plugin)
Nombre entier
Chemin JSONNext reward ID (managed by plugin)

Minimum : 0 · Maximum : 2147483647

Legacy reward ID map (managed by plugin)
Valeur JSON
Chemin JSONLegacy reward ID map (managed by plugin)
Progression 11
Source des points
Choix

Externe laisse un autre plugin attribuer les points. Temps de jeu récompense l’activité, Quotidien donne un bonus après le temps actif requis, Bienvenue le donne à la première connexion.

Chemin JSONBuilt-in progression → Mode

Valeurs possibles : external, playtime, daily, welcome

Intervalle de jeu actif (s)
Nombre entier

Temps actif nécessaire par attribution en mode Temps de jeu. Le temps considéré comme AFK ne progresse pas.

Chemin JSONBuilt-in progression → SecondsPerPoint

Minimum : 1 · Maximum : 2147483647

Points par attribution
Nombre entier

Points de base accordés par intervalle de jeu, bonus quotidien ou bienvenue. Les multiplicateurs de permission s’appliquent ensuite.

Chemin JSONBuilt-in progression → PointsPerInterval

Minimum : 1 · Maximum : 2147483647

Inactivité avant AFK (s)
Nombre entier

Au-delà de cette durée sans activité détectée, le temps du joueur n’est plus compté pour cette progression.

Chemin JSONBuilt-in progression → AfkAfterSeconds

Minimum : 5 · Maximum : 86400

Activité requise pour le bonus quotidien (s)
Nombre entier

Temps actif à atteindre dans la journée pour recevoir le bonus en mode Quotidien.

Chemin JSONBuilt-in progression → MinimumActiveSeconds

Minimum : 0 · Maximum : 86400

Fuseau horaire
Texte

Fuseau utilisé pour la journée du bonus. UTC fonctionne sur Oxide et Carbon ; un autre identifiant doit être reconnu par le système du serveur.

Chemin JSONBuilt-in progression → TimeZoneId
Début de journée
Nombre entier

Heure de début d’une nouvelle journée de bonus, de 0 à 23 dans le fuseau choisi.

Chemin JSONBuilt-in progression → DailyResetHour

Minimum : 0 · Maximum : 23

Durée d’un cycle (s)
Nombre entier

Zéro garde la progression sans remise à zéro périodique. Sinon, au moins 60 secondes ; réservé aux modes Temps de jeu et Quotidien.

Chemin JSONBuilt-in progression → CycleSeconds

Minimum : 0 · Maximum : 2147483647

Gains en attente à la fin du cycle
Choix

Attendre reporte le nouveau cycle tant qu’il reste des gains à récupérer. Expirer abandonne ces gains. Un journal de livraison non résolu bloque toujours le changement de cycle.

Chemin JSONBuilt-in progression → PendingOnReset

Valeurs possibles : wait, expire

Reprendre l’ancien temps de jeu
Activé / désactivé

Autorise la reprise de l’ancien compteur de temps de jeu lors de la migration vers la progression intégrée.

Chemin JSONBuilt-in progression → AdoptLegacyPlaytime
Multiplicateurs de permission
Valeur JSON

Multiplie les points pour les joueurs ayant ces permissions. Valeurs de 1 à 100 ; le multiplicateur le plus élevé s’applique, sans cumul.

Chemin JSONBuilt-in progression → PermissionMultipliers
Récompenses et paliers 1
Récompenses
Liste d’objets · obligatoire

Chaque gain peut réunir des objets, versements, kits ou commandes. Son identifiant persistant conserve l’historique lorsque vous changez l’ordre ; ne le réutilisez pas pour un autre gain.

Chemin JSONRewards Settings → Rewards List
Interface 24
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 JSONUI Settings → Max Reward By Page

Valeurs possibles : 3, 4, 5, 8

Identifiant du thème
Choix · obligatoire

Palette de couleurs du catalogue pour le profil PimpMyCUI choisi. Vérifiez ensemble le contraste du texte, des cartes et du fond.

Chemin JSONUI Settings → CUI Theme Id

Valeurs possibles : carbon-ledger, industrial-ember, arctic-signal, wasteland-broadcast, monument-dossier

Fenêtre ou plein écran
Choix · obligatoire

Afficher le catalogue en fenêtre ou en plein écran. Vérifiez la lisibilité des titres et des cartes avec le profil choisi.

Chemin JSONUI Settings → CUI Presentation (windowed | fullscreen)

Valeurs possibles : windowed, fullscreen

Décoration riche ou légère
Choix · obligatoire

Choisir l’habillage du catalogue PimpMyCUI : rich garde les détails décoratifs, light utilise une présentation allégée.

Chemin JSONUI Settings → CUI Decoration (rich | light)

Valeurs possibles : rich, light

Modèle de mise en page
Choix

Disposition du catalogue : command-center affiche jusqu’à 3 gains par page, field-journal 5 et signal-deck 8. Adaptez aussi Max Reward By Page.

Chemin JSONUI Settings → CUI Layout Template (command-center | field-journal | signal-deck)

Valeurs possibles : command-center, field-journal, signal-deck

Afficher l’illustration de contexte
Activé / désactivé · obligatoire

Afficher l’illustration de contexte prévue par le profil PimpMyCUI. Cela ne remplace pas les images individuelles des récompenses.

Chemin JSONUI Settings → Show Context Image
Descriptions des gains
Activé / désactivé

Affiche la description propre à chaque gain dans le rendu natif. Le texte se règle dans la récompense concernée.

Chemin JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI Settings → Next Icon Url
Rendu de l’interface
Choix

Natif fonctionne sans PimpMyCUI. PimpMyCUI utilise ses modèles et permet les animations interactives ; son plugin doit être installé.

Chemin JSONUI Settings → Renderer (native | pimpmycui)

Valeurs possibles : native, pimpmycui

Disposition native
Choix

Choisit la présentation des quatre gains par page. Les dispositions Passe, Vitrine et Parcours mettent un gain à la une.

Chemin JSONUI Settings → Native layout (glass | industrial)

Valeurs possibles : glass, industrial, season-pass, showcase, chapters

Couleur d’accent
Texte

Couleur des repères, de la progression et des boutons disponibles dans le rendu natif. RGBA Rust de 0 à 1.

Chemin JSONUI Settings → Native accent (RGBA)
Opacité du panneau
Nombre

Opacité du fond de l’interface native, entre 0,65 et 1. Ne change pas l’assombrissement du jeu derrière le panneau.

Chemin JSONUI Settings → Native panel opacity

Minimum : 0.65 · Maximum : 1

Titre natif
Texte

Remplace le titre traduit de l’interface native. Vide utilise la langue du joueur.

Chemin JSONUI Settings → Native title (empty uses localization)
Sous-titre natif
Texte

Remplace le sous-titre traduit de l’interface native. Vide utilise la langue du joueur.

Chemin JSONUI Settings → Native subtitle (empty uses localization)
Illustrations
Choix

Automatique utilise l’image personnalisée du gain si elle est renseignée, sinon l’icône Rust de son premier objet. Personnalisée demande une image pour chaque gain.

Chemin JSONUI Settings → Reward Illustration (custom | vanilla-item | auto)

Valeurs possibles : custom, vanilla-item, auto

Unité affichée
Choix

Affiche la progression en points ou en votes sans changer leur attribution. VoteReward choisit l’unité selon son mode de progression.

Chemin JSONUI Settings → Progress display units (points | votes)

Valeurs possibles : points, votes

Composition PimpMyCUI
Choix

Page utilise le cadre commun PimpMyCUI, ou la fenêtre que vous avez liée au catalogue dans Interfaces en jeu. Famille et Rendu natif conservent les anciens affichages. Le mode Page nécessite les candidats compatibles CustomRewards et PimpMyCUI.

Chemin JSONUI Settings → PimpMyCUI composition (family | native-match)

Valeurs possibles : family, native-match, page

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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI 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 JSONUI Settings → Theme → Colors → Danger

Instructions du plugin

Configurer CustomRewards 2.2.0

Bêta 2.2.0. La version LTS publiée sur Codefling reste la 2.0.4. Le téléchargement du plugin nécessite une connexion et un droit vérifié pour la version demandée. Consultez sa fiche pour les accès disponibles. Les exports de configuration restent accessibles sans achat du plugin.

CustomRewards distribue des gains à mesure que le joueur progresse. Il peut attribuer ses propres points ou les recevoir d’un autre plugin, comme VoteSystem. Récupérer une récompense ne dépense pas les points.

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.

Créer un catalogue

  1. Choisissez le nom du catalogue et ses commandes d’ouverture.
  2. Ajoutez vos récompenses : objets Rust, lots, versements, kits ou commandes.
  3. Dans Progression, choisissez la source des points. Externe laisse cette tâche à un autre plugin ; les autres modes utilisent le temps de jeu actif, un bonus quotidien ou la première connexion.
  4. Activez le catalogue lorsque ses gains et conditions sont prêts.

Exportez le fichier dans oxide/data/CustomRewards_rewards/<nom>.json, ou son équivalent Carbon. Un serveur connecté permet d’envoyer ce même fichier depuis le configurateur. Utilisez le nom du catalogue dans les plugins associés et accordez sa permission customrewards.<nom en minuscules>.use aux joueurs concernés.

Récompenses et paliers

Un gain peut combiner plusieurs objets, des permissions, des groupes et des actions. Les versements Economics/ServerRewards et les kits demandent leurs plugins respectifs. Un fournisseur absent bloque la livraison concernée ; le plugin ne remplace pas cette action par une autre récompense.

Le Palier indique la progression nécessaire. Sans valeur explicite, les paliers suivent l’ordre 1, 2, 3… Un intervalle de répétition permet de recevoir à nouveau le gain après chaque nouvelle étape. Sans intervalle, il reste unique pour le cycle. Vérifiez le rattrapage de progression avant d’activer une récompense répétable sur un serveur existant.

Conservez les identifiants persistants attribués par le plugin lors d’un import ou d’une réorganisation. Ne réutilisez pas l’identifiant d’un ancien gain pour un nouveau. Les fichiers de progression des joueurs ne sont pas édités ici.

Apparence

Le rendu Natif fonctionne sans PimpMyCUI. Ses cinq dispositions — Galerie, Industriel, Passe, Vitrine et Parcours — affichent quatre gains par page. Passe, Vitrine et Parcours mettent un gain à la une. Le titre et le sous-titre vides utilisent les textes traduits ; la progression intégrée peut fournir le sous-titre.

Le mode Page dans une fenêtre (page) utilise le cadre commun PimpMyCUI sans menu quand aucune destination n’est définie. Dans Interfaces en jeu, ajoutez une page Récompenses et renseignez le nom exact du catalogue pour l’ouvrir dans votre propre fenêtre. Les commandes du catalogue ouvrent cette destination ; la progression, les conditions et la récupération restent gérées par CustomRewards. Ce mode nécessite les candidats compatibles CustomRewards et PimpMyCUI ; il n’est pas disponible dans les anciennes versions publiées.

Les compositions historiques du rendu PimpMyCUI restent disponibles. Famille conserve les modèles et les animations coffre, roue et scan. Rendu natif (native-match) reprend les dispositions natives et utilise le runtime PimpMyCUI 1.4.0 compatible avec ce pack. Un document Studio personnalisé concerne les modèles Famille, pas les documents générés par Rendu natif. Le rendu Natif reste indépendant de PimpMyCUI.

L’aperçu permet de vérifier la disposition avec votre catalogue. Ses états de joueur servent à la prévisualisation : ils ne changent aucun gain sur le serveur. L’onglet Langues contient les messages du plugin et les textes du catalogue.

Le mode Page ne prend pas encore en charge les gains qui déclenchent une animation InteractiveExperience. Leur récupération est désactivée dans cette page, avec une explication au joueur. Conservez un affichage historique pour ces catalogues. AITranslation Pro 2.1.0 dispose aussi de pages pour ce cadre commun ; les modèles propres à Dialogs et VoteCommands restent séparés.

Commandes d’administration

/customrewards_give <catalogue> <joueur ou ID> <points> ajoute des points à un joueur. Elle nécessite customrewards.admin ; l’ancienne permission CustomRewards.Admin reste acceptée.

Dans la console, customrewards_wipe_owner <catalogue> <propriétaire> efface la progression de ce propriétaire. customrewards_wipe_all <catalogue> efface celle de tous les propriétaires du catalogue. Ces commandes exigent un accès administrateur.

Versions précédentes

Le configurateur 2.0.4 reste disponible pour une installation de cette version. La précédente bêta 2.2.0 est retirée ; ses brouillons ne sont pas automatiquement appliqués au nouveau contrat normal.

Installer les pages du pack 2.2.0

Le mode Page utilise PimpMyCUI 1.4.0. Installez les fichiers du ZIP, dont oxide/data/PimpMyCUI/plugin-pages/customrewards/manifest.json et les packages qu’il référence, puis rechargez les plugins. Le nom du catalogue est le contexte exact de la page : conservez-le dans CustomRewards, VoteSystem et VoteReward. Une destination liée indisponible ne doit pas ouvrir silencieusement un autre catalogue. Les commandes d’ouverture du catalogue gardent les vérifications de permission et la progression serveur. Une sélection d’export doit conserver les publications CUI dont elle dépend.

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.

Guide de configuration et d’envoi →