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. Importez votre configuration

    Ouvrez le configurateur et importez le JSON actuel. Pour une nouvelle installation, vous pouvez partir de l’exemple proposé.

  3. 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 4
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

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 JSONEnabled
Commandes d’ouverture des récompenses
Liste · obligatoire

Commandes chat sans le caractère / initial.

Chemin JSONCommands for show UI
Interactive experiences
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
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 JSONRewards Settings → Rewards List

Instructions du plugin

Contrat de configuration CustomRewards 4.1.0

Chaque fichier configure un type de récompense dans oxide/data/CustomRewards_rewards/<reward-type>.json. Conservez Data Version à 4. Le catalogue, les conditions, les commandes et les expériences interactives restent dans ce même fichier.

UI Settings choisit le thème, la présentation, la décoration et la disposition. La disposition fixe le nombre maximal de récompenses par page : command-center 3, field-journal 5, signal-deck 8. Réglez Max Reward By Page en conséquence. CuiDocument est un document runtime PimpMyCUI facultatif, produit par l’éditeur du site pour le profil choisi. Omettez-le ou mettez null pour conserver le document intégré. Un document incompatible empêche l’ouverture, sans interface de repli.

L’éditeur peut modifier l’aspect visuel, ajouter des éléments décoratifs ou des boutons de fermeture et supprimer des éléments. Les éléments d’action existants doivent conserver leurs identifiants, leur type et leurs liaisons ; les chemins de modèle doivent provenir du document intégré. Exportez le JSON complet du type de récompense. Installer seulement un projet ou package PimpMyCUI ne modifie pas l’interface de ce plugin.

Chaque entrée de Interactive experiences peut définir séparément CuiDocument pour son Rich template id (les six modèles coffre, roue et scan). Le champ principal UI Settings.CuiDocument ne modifie pas les scènes interactives. Le même contrat visuel et le même refus sans repli s’appliquent à chaque expérience.

Migration depuis le contrat 4.0.0 : les fichiers existants gardent leur comportement. Le nouveau champ UI Settings.CuiDocument est facultatif et nécessite la prise en charge des documents personnalisés dans le plugin serveur et PimpMyCUI.

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

Suivez les instructions du plugin ci-dessus pour ses dépendances et son rechargement. L’export ne connecte pas le site à votre serveur.