/// PIMPMYRUST PLUGIN
VoteCommands
Guide des réglages de VoteCommands 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 VoteCommands 1.0.0. 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 11
- Version du format de configuration
- Choix · obligatoire
Repère interne du format de configuration. Conservez la valeur fournie pour cette version du plugin.
Chemin JSON
SchemaVersionValeurs possibles : 3
- Nombre minimum de votes
- Nombre entier · obligatoire
Nombre minimum de bulletins nécessaire pour exécuter les actions gagnantes. Même avec 0, une session sans aucun vote n’exécute rien.
Chemin JSON
MinimumParticipationMinimum : 0 · Maximum : 10000
- Résultat en cas d’égalité
- Choix · obligatoire
cancel annule le résultat en cas d’égalité ; first retient le premier choix à égalité dans la liste. Sans aucun vote, aucune action n’est exécutée.
Chemin JSON
TieRuleValeurs possibles : cancel, first
- Afficher les résultats pendant le vote
- Activé / désactivé · obligatoire
Afficher le nombre de votes pendant la session. Désactivez pour ne pas montrer les scores en cours aux joueurs.
Chemin JSON
ShowLiveResults - Activer
- Activé / désactivé · obligatoire
Activer ce contrôleur de vote. Chaque fichier de configuration correspond à un contrôleur indépendant, avec ses propres choix et commandes.
Chemin JSON
Enabled - Démarrage automatique
- Activé / désactivé · obligatoire
Démarrer les votes au chargement ou au rechargement du plugin.
Chemin JSON
AutomaticStart - Répéter les sessions de vote
- Activé / désactivé · obligatoire
Répéter les sessions une fois le premier vote démarré, manuellement ou automatiquement.
Chemin JSON
AutomaticSessions - Délai avant le démarrage automatique (secondes)
- Nombre entier · obligatoire
Attente en secondes après le chargement du contrôleur avant le premier vote automatique. Utilisé seulement si le démarrage automatique est activé.
Chemin JSON
DelayBeforeAutomaticStart - Commande de démarrage du vote
- Texte · obligatoire
Commande chat sans le caractère / initial.
Chemin JSON
CommandForStartSessions - Commande d’ouverture du vote
- Texte · obligatoire
Commande chat sans le caractère / initial.
Chemin JSON
CommandForUi - Intervalle entre les débuts de session (secondes)
- Nombre · obligatoire
Temps entre les débuts de session, pas après le résultat. Pour répéter les votes, il doit dépasser leur durée.
Chemin JSON
TimeBetweenSessionsMinimum : 0
Déroulement et choix du vote 2
- Durée du vote (secondes)
- Nombre entier · obligatoire
Temps laissé aux joueurs pour voter, en secondes. À la fin, le contrôleur calcule le gagnant ; l’intervalle de répétition doit dépasser cette durée.
Chemin JSON
CommandsConfiguration → VoteDurationSecondsMinimum : 10 · Maximum : 3600
- Choix proposés au vote
- Liste d’objets · obligatoire
Chaque choix peut avoir des actions exécutées s’il gagne. Les noms et commandes saisis restent inchangés.
Chemin JSON
CommandsConfiguration → VoteCommands
Bouton de fermeture 2
- Taille
- Nombre entier · obligatoire
Largeur et hauteur du bouton de fermeture carré de l’interface historique, en pixels de référence CUI.
Chemin JSON
UIConfiguration → CloseButtonConfiguration → Size - Adresse de l’image
- Texte · obligatoire
Adresse directe de l’image à afficher, et non de sa page web. Utilisez une image accessible aux joueurs ; préférez HTTPS.
Chemin JSON
UIConfiguration → CloseButtonConfiguration → ImageUrl
Compte à rebours 4
- Ancrage minimum
- Texte · obligatoire
Coin inférieur gauche dans le conteneur parent, sous la forme x y entre 0 et 1. 0 0 correspond au bas à gauche. Il ne doit pas dépasser l’ancrage maximum ; des ancrages égaux peuvent utiliser des décalages en pixels.
Chemin JSON
UIConfiguration → CountDownConfiguration → AnchorMin - Ancrage maximum
- Texte · obligatoire
Coin supérieur droit dans le conteneur parent, sous la forme x y entre 0 et 1. 1 1 correspond au haut à droite. Il ne doit pas précéder l’ancrage minimum ; des ancrages égaux peuvent utiliser des décalages en pixels.
Chemin JSON
UIConfiguration → CountDownConfiguration → AnchorMax - Décalage minimum
- Texte · obligatoire
Décalage du coin inférieur gauche, sous la forme x y en pixels, ajouté à l’ancrage. Des valeurs négatives déplacent ce coin vers la gauche ou le bas.
Chemin JSON
UIConfiguration → CountDownConfiguration → OffsetMin - Décalage maximum
- Texte · obligatoire
Décalage du coin supérieur droit, sous la forme x y en pixels, ajouté à l’ancrage. Des valeurs positives déplacent ce coin vers la droite ou le haut.
Chemin JSON
UIConfiguration → CountDownConfiguration → OffsetMax
Titre du vote 1
- Hauteur
- Nombre · obligatoire
Part de la hauteur de la fenêtre réservée à l’en-tête historique. Exemple : 0.1 = 10 %. Elle réduit l’espace restant pour les choix.
Chemin JSON
UIConfiguration → TitleConfiguration → Height
Présentation des choix 4
- Marge verticale
- Nombre · obligatoire
Marge verticale autour des choix, exprimée en part de la hauteur de la fenêtre. Exemple : 0.01 = 1 % par côté.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → MarginHeight - Marge horizontale
- Nombre · obligatoire
Marge horizontale autour des choix, exprimée en part de la largeur de la fenêtre. Exemple : 0.01 = 1 % par côté.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → MarginWidth - Couleur de fond
- 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
UIConfiguration → VoteCommandsConfiguration → BackgroundColor - Espacement entre les choix
- Nombre · obligatoire
Espace entre les choix, exprimé en part de leur conteneur. Exemple : 0.01 = 1 %. Plus d’espace laisse moins de largeur aux cartes.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → MarginBetweenCommands
Fenêtre du vote 4
- Largeur
- Nombre entier · obligatoire
Largeur de la fenêtre historique, en pixels de référence CUI. Une largeur excessive peut sortir de l’écran sur un petit affichage.
Chemin JSON
UIConfiguration → WindowConfiguration → Width - Hauteur
- Nombre entier · obligatoire
Hauteur de la fenêtre historique, en pixels de référence CUI. Prévoyez assez d’espace pour tous les choix du vote.
Chemin JSON
UIConfiguration → WindowConfiguration → Height - Adresse de l’image de fond
- Valeur JSON · obligatoire
Adresse directe de l’image à afficher, et non de sa page web. Utilisez une image accessible aux joueurs ; préférez HTTPS.
Chemin JSON
UIConfiguration → WindowConfiguration → BackgroundImageUrl - Couleur de fond
- 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
UIConfiguration → WindowConfiguration → BackgroundColor
Compte à rebours · Style du texte 4
- Taille du texte
- Nombre entier · obligatoire
Taille du texte de cette zone dans l’interface historique. Vérifiez sa lisibilité et son débordement avec les textes les plus longs.
Chemin JSON
UIConfiguration → CountDownConfiguration → LabelConfiguration → FontSize - Couleur du texte
- 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
UIConfiguration → CountDownConfiguration → LabelConfiguration → Color - Police de caractères
- Texte · obligatoire
Nom d’une police disponible dans le client Rust. Une police installée seulement sur votre PC ne sera pas disponible aux joueurs.
Chemin JSON
UIConfiguration → CountDownConfiguration → LabelConfiguration → Font - Alignement du texte
- Nombre entier · obligatoire
Alignement Unity : 0–2 = haut (gauche, centre, droite), 3–5 = milieu, 6–8 = bas. Exemple : 4 centre le texte sans déplacer son panneau.
Chemin JSON
UIConfiguration → CountDownConfiguration → LabelConfiguration → TextAnchor
Titre du vote · Style du texte 4
- Taille du texte
- Nombre entier · obligatoire
Taille du texte de cette zone dans l’interface historique. Vérifiez sa lisibilité et son débordement avec les textes les plus longs.
Chemin JSON
UIConfiguration → TitleConfiguration → LabelConfiguration → FontSize - Couleur du texte
- 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
UIConfiguration → TitleConfiguration → LabelConfiguration → Color - Police de caractères
- Texte · obligatoire
Nom d’une police disponible dans le client Rust. Une police installée seulement sur votre PC ne sera pas disponible aux joueurs.
Chemin JSON
UIConfiguration → TitleConfiguration → LabelConfiguration → Font - Alignement du texte
- Nombre entier · obligatoire
Alignement Unity : 0–2 = haut (gauche, centre, droite), 3–5 = milieu, 6–8 = bas. Exemple : 4 centre le texte sans déplacer son panneau.
Chemin JSON
UIConfiguration → TitleConfiguration → LabelConfiguration → TextAnchor
Apparence d’un choix 4
- Marge intérieure
- Nombre · obligatoire
Champ historique conservé dans la configuration, mais non utilisé par le rendu de VoteCommands 0.1.3. Ne comptez pas sur ce champ pour changer les marges.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → Padding - Couleur de fond
- 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
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → BackgroundColor - Taille de la zone du nombre de votes
- Nombre entier · obligatoire
Taille réservée à l’affichage du nombre de votes dans une carte, en pixels de référence CUI.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → VotesCountSize - Hauteur de l’image
- Nombre · obligatoire
Part de la hauteur d’une carte réservée à l’image. Exemple : 0.85 = 85 % ; le reste sert au nom du choix.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → ImageHeight
Style du nom du choix 4
- Taille du texte
- Nombre entier · obligatoire
Taille du texte de cette zone dans l’interface historique. Vérifiez sa lisibilité et son débordement avec les textes les plus longs.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → NameLabelConfiguration → FontSize - Couleur du texte
- 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
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → NameLabelConfiguration → Color - Police de caractères
- Texte · obligatoire
Nom d’une police disponible dans le client Rust. Une police installée seulement sur votre PC ne sera pas disponible aux joueurs.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → NameLabelConfiguration → Font - Alignement du texte
- Nombre entier · obligatoire
Alignement Unity : 0–2 = haut (gauche, centre, droite), 3–5 = milieu, 6–8 = bas. Exemple : 4 centre le texte sans déplacer son panneau.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → NameLabelConfiguration → TextAnchor
Style du nombre de votes 4
- Taille du texte
- Nombre entier · obligatoire
Taille du texte de cette zone dans l’interface historique. Vérifiez sa lisibilité et son débordement avec les textes les plus longs.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → VotesCountLabelConfiguration → FontSize - Couleur du texte
- 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
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → VotesCountLabelConfiguration → Color - Police de caractères
- Texte · obligatoire
Nom d’une police disponible dans le client Rust. Une police installée seulement sur votre PC ne sera pas disponible aux joueurs.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → VotesCountLabelConfiguration → Font - Alignement du texte
- Nombre entier · obligatoire
Alignement Unity : 0–2 = haut (gauche, centre, droite), 3–5 = milieu, 6–8 = bas. Exemple : 4 centre le texte sans déplacer son panneau.
Chemin JSON
UIConfiguration → VoteCommandsConfiguration → VoteCommandConfiguration → VotesCountLabelConfiguration → TextAnchor
Instructions du plugin
Contrat de contrôleur VoteCommands 3.0.0
Un fichier JSON sous oxide/config/VoteCommands/ définit un contrôleur de vote. Son nom entre dans celui des permissions ; gardez des noms de fichiers et de commandes de chat uniques. À la première installation, le plugin crée Example.json avec démarrage manuel et toutes les commandes de victoire désactivées. Modifiez-le puis rechargez le plugin avant un vrai vote.
SchemaVersion doit valoir 3. Choisissez CuiTemplate parmi operations-console, civic-ballot, relay-grid, arctic-council, field-terminal ou broadcast-panel ; choisissez CuiPresentation (windowed/fullscreen) et CuiDecoration (rich/light). CuiDocument est un document runtime PimpMyCUI facultatif pour ce profil intégré précis. Omettez-le ou mettez null pour utiliser le document intégré. Un document non nul incompatible bloque l’ouverture, sans repli. Les autres réglages et les actions de victoire restent dans ce fichier.
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 vers le nom du contrôleur. Installer seulement un projet ou package PimpMyCUI ne change pas VoteCommands.
Mise à jour depuis le plugin 0.1.x publié ou un ancien contrat de contrôleur : conservez une sauvegarde, partez d’un exemple actuel en schéma 3 et reportez manuellement les délais, les choix et les actions du gagnant. Les anciens JSON sont rejetés, sans migration automatique. Si un fichier intermédiaire du schéma 2 contient CuiTheme et CuiLayoutTemplate, remplacez-les par un CuiTemplate choisi après vérification. Sans vote, aucune action du gagnant ne s’exécute, même avec TieRule à first et MinimumParticipation à zéro. CuiDocument est facultatif et nécessite une prise en charge compatible dans VoteCommands 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/config/VoteCommands/Example_SkipNight.jsonSuivez les instructions du plugin ci-dessus pour ses dépendances et son rechargement. L’export ne connecte pas le site à votre serveur.