Aller au contenu
← Toute la documentation

/// PIMPMYRUST PLUGIN

PimpMyCUI

Guide des réglages de PimpMyCUI 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 PimpMyCUI 1.0.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. Modifier et exporter

    Ajustez les réglages, corrigez les erreurs signalées et exportez 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 2
Actions serveur approuvées
Valeur JSON

Approuve les actions de boutons exécutées dans la console serveur pour une version exacte d’un package. Utilisez son ID comme clé et son sha256 intégré comme valeur, uniquement après avoir vérifié ses commandes. Modifier l’interface ou ses commandes chat invalide cette approbation. Elle n’est pas nécessaire pour ouvrir une interface ; la commande serveur pimpmycui.admin trust peut l’enregistrer à votre place.

Chemin JSONtrustedPackageHashes
Interfaces désactivées
Liste

IDs des packages qui ne doivent pas s’ouvrir sur le serveur, y compris par commande chat joueur. Retirez un ID pour autoriser de nouveau son ouverture. Cela ne supprime pas le package installé et n’accorde aucun droit aux joueurs. Les commandes serveur pimpmycui.admin disable et enable peuvent aussi modifier cette liste.

Chemin JSONdisabledPackages

Instructions du plugin

PimpMyCUI 1.0.0 — bêta gratuite

PimpMyCUI affiche les interfaces Rust interactives créées avec l’éditeur web. Un seul fichier PimpMyCUI.cs suffit ; aucun second plugin de rendu n’est nécessaire. La première version Codefling sera gratuite et marquée bêta. Son téléchargement ne sera disponible sur ce candidat staging qu’après publication.

Créer une interface que les joueurs peuvent ouvrir

  1. Ouvrez PimpMyCUI Editor et créez vos écrans.
  2. Sélectionnez l’écran à ouvrir. Dans Propriétés, trouvez Ouverture par commande et cliquez sur Ajouter une commande.
  3. Saisissez une commande sans slash, par exemple menu. Ajoutez une permission ou un groupe autorisé. Pour un accès public, choisissez explicitement Tous les joueurs (groupe default).
  4. Testez les boutons et la navigation avec Aperçu. Il ne vérifie pas les permissions, les conflits de commandes ni le rendu sur votre serveur Rust.
  5. Exportez le Projet modifiable pour conserver une copie éditable, puis le Package à installer destiné au serveur.

Plusieurs commandes peuvent ouvrir le même écran. Une seule permission ou un seul groupe de la liste suffit ; les droits sont vérifiés à chaque appel, sans exception pour les administrateurs. Ajouter une commande n’accorde aucun droit et ne crée aucun groupe. PimpMyCUI enregistre les nouvelles permissions pimpmycui.* ; les autres plugins enregistrent leurs propres permissions.

Pour un /menu privé, choisissez pimpmycui.menu puis accordez ce droit côté serveur :

oxide.grant user <steam-id> pimpmycui.menu

Les commandes commencent par une lettre minuscule, acceptent minuscules, chiffres, _ et -, et comptent 32 caractères maximum. pimpmycui est réservé. Une commande accepte au plus 16 permissions uniques et 16 groupes uniques ; un package accepte 32 commandes et l’ensemble installé, 128.

Les Données initiales fournissent les textes, nombres ou booléens fixes utilisés par l’écran. Un nom tel que player.name est une clé à plat, pas un objet imbriqué. Les arguments chat ne modifient pas ces valeurs et ne permettent pas d’ouvrir l’interface pour quelqu’un d’autre. Les données en temps réel nécessitent une intégration avec un plugin ; elles ne sont pas récupérées automatiquement.

Installer le package exporté

  1. Après publication de la bêta Codefling, installez PimpMyCUI.cs dans le dossier habituel des plugins Oxide ou Carbon.
  2. Ajoutez le package exporté complet à la liste packages de oxide/data/PimpMyCUI/packages.json (ou au dossier de données Carbon correspondant). Conservez les packages existants ; ne remplacez pas leur liste par un seul export.
  3. Lancez pimpmycui.admin reload, vérifiez son résultat puis exécutez pimpmycui.admin list.
  4. Testez la commande chat avec un joueur autorisé et un joueur non autorisé. Vérifiez navigation, fermeture et boutons en jeu avant une utilisation publique.

Les doublons de commande, écrans cibles absents ou conflits avec un autre plugin font refuser le rechargement. PimpMyCUI ne remplace pas les commandes d’un autre plugin. Un refus conserve les packages actifs en mémoire, mais une interface déjà ouverte peut devoir être rouverte si l’activation a fermé sa session. validate et diagnose inspectent la mémoire ; seul reload relit le fichier.

Configuration du runtime

Le configurateur du runtime modifie oxide/config/PimpMyCUI.json, pas le package de l’interface :

  • Actions serveur approuvées (trustedPackageHashes) : ID du package → son sha256 intégré. L’approbation autorise cette version exacte à exécuter les actions de boutons dans la console serveur. Vérifiez les commandes avant de les approuver. Ce n’est pas l’empreinte du fichier JSON téléchargé.
  • Interfaces désactivées (disabledPackages) : IDs des packages qui ne doivent pas s’ouvrir, y compris par commande chat joueur. Retirer un ID autorise de nouveau l’ouverture, sans accorder de permission ni supprimer le package installé.

Les deux collections sont vides par défaut et acceptent 128 entrées maximum. Les IDs correspondent exactement aux packages : minuscules, chiffres, . ou -, en commençant par une lettre, sur 64 caractères maximum. L’import/export conserve les champs de configuration inconnus.

Le serveur peut gérer ces réglages sans modifier le fichier à la main :

pimpmycui.admin trust <package-id> <sha256-intégré-au-package>
pimpmycui.admin disable <package-id>
pimpmycui.admin enable <package-id>

Ouvrir une interface n’approuve pas ses boutons. Leurs permissions, délais et dépendances de providers restent vérifiés. Si une modification de l’interface ou des commandes chat change son empreinte, approuvez le nouveau hash avant de lancer ses actions console serveur. Réservez pimpmycui.admin aux administrateurs de confiance.

Pour ce plugin gratuit, l’éditeur et le configurateur fonctionnent sans compte. Conservez vos exports : il n’y a pas de sauvegarde cloud. L’aperçu navigateur et la compilation hors ligne Oxide/Carbon ne constituent pas une validation en jeu.

Installer le fichier

Après avoir conservé une copie de l’ancien fichier, placez le JSON exporté à cet emplacement sur votre serveur :

oxide/config/PimpMyCUI.json

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