Documentation API Récompenses Serveurs

🔌 Plugin Officiel

Le VotePlugin est un outil essentiel pour accroître la visibilité de votre serveur Hytale en encourageant les joueurs à voter. Il lie directement votre serveur à l’API de hytale.game pour offrir une expérience fluide et automatisée.

Voici une présentation synthétique du VotePlugin pour vos serveurs Hytale, basée sur les fichiers de configuration et les captures d’écran fournis :

VotePlugin : Automatisez les récompenses de votre serveur

Le VotePlugin est un outil essentiel pour accroître la visibilité de votre serveur Hytale en encourageant les joueurs à voter. Il lie directement votre serveur à l’API de hytale.game pour offrir une expérience fluide et automatisée.

Fonctionnement Clé

• Synchronisation API : Le plugin utilise une clé secrète unique pour communiquer avec le site de vote et vérifie les nouveaux votes toutes les 120 secondes par défaut.
• Système de Lots Aléatoires : Vous pouvez configurer différents niveaux de rareté pour les récompenses (par exemple : Commun à 60%, Rare à 30%, et Légendaire à 10%).
• Récupération Intelligente : Si un joueur vote alors qu’il est hors-ligne ou que son inventaire est plein, le plugin met la récompense en attente. Le joueur reçoit un rappel pour utiliser la commande /pickupvote une fois de la place libérée.
• Annonces Globales : Chaque vote réussi est annoncé sur le chat du serveur pour valoriser le joueur et inciter les autres à faire de même.

📦 Configuration

vote-api.properties : Gère la connexion technique (clé secrète, URL de l’API et délais de vérification).

# Clé secrète unique du serveur (fournie par hytale.game)
secret_key=7BC-086-094

# Base URL de l'API
base_url=https://hytale.game/wp-json/hytale-api/v1

# Vérification automatique (seconds)
poll_interval_seconds=120

# Anti-spam message au joueur (seconds)
notify_cooldown_seconds=600

# Clé secrète unique du serveur (fournie par hytale.game)
secret_key=7BC-086-094

# Base URL de l'API
base_url=https://hytale.game/wp-json/hytale-api/v1

# Vérification automatique (seconds)
poll_interval_seconds=120

# Anti-spam message au joueur (seconds)
notify_cooldown_seconds=600

vote-rewards.json : Permet de définir les messages de chat et le contenu exact des lots (ID des items et quantités). Vous avez accès à une bibliothèque complète d’objets, allant des ressources de base comme le lait aux équipements de combat plus rares

{
  "broadcast_prefix": "[Vote] ",
  "broadcast_template": "{username} vient de voter pour le serveur et reçoit {count} récompense(s) !",
  "pending_message_template": "[Vote] Récompense(s) de vote en attente, faites /pickupvote.",
  "inventory_full_message": "[Vote] Tu n'as pas assez de place dans ton inventaire pour récupérer {count} vote(s). Libère de la place et refais /pickupvote.",
  "pickup_success_message": "[Vote] Récompense(s) récupérée(s) ! (+{count})",
  "lots": [
    {
      "name": "Lot Commun",
      "chance": 60,
      "items": [
        { "id": "*Container_Bucket_State_Filled_Milk", "amount": 8 },
        { "id": "*Container_Bucket_State_Filled_Mosshorn_Milk", "amount": 4 }
      ]
    },
    {
      "name": "Lot Rare",
      "chance": 30,
      "items": [
        { "id": "*Container_Bucket_State_Filled_Water", "amount": 16 },
        { "id": "*Deco_Bucket_State_Filled_Milk", "amount": 2 }
      ]
    },
    {
      "name": "Lot Légendaire",
      "chance": 10,
      "items": [
        { "id": "*Deco_Bucket_State_Filled_Mosshorn_Milk", "amount": 1 },
        { "id": "*Deco_Bucket_State_Filled_Water", "amount": 1 }
      ]
    }
  ]
}

{
  "broadcast_prefix": "[Vote] ",
  "broadcast_template": "{username} vient de voter pour le serveur et reçoit {count} récompense(s) !",
  "pending_message_template": "[Vote] Récompense(s) de vote en attente, faites /pickupvote.",
  "inventory_full_message": "[Vote] Tu n'as pas assez de place dans ton inventaire pour récupérer {count} vote(s). Libère de la place et refais /pickupvote.",
  "pickup_success_message": "[Vote] Récompense(s) récupérée(s) ! (+{count})",
  "lots": [
    {
      "name": "Lot Commun",
      "chance": 60,
      "items": [
        { "id": "*Container_Bucket_State_Filled_Milk", "amount": 8 },
        { "id": "*Container_Bucket_State_Filled_Mosshorn_Milk", "amount": 4 }
      ]
    },
    {
      "name": "Lot Rare",
      "chance": 30,
      "items": [
        { "id": "*Container_Bucket_State_Filled_Water", "amount": 16 },
        { "id": "*Deco_Bucket_State_Filled_Milk", "amount": 2 }
      ]
    },
    {
      "name": "Lot Légendaire",
      "chance": 10,
      "items": [
        { "id": "*Deco_Bucket_State_Filled_Mosshorn_Milk", "amount": 1 },
        { "id": "*Deco_Bucket_State_Filled_Water", "amount": 1 }
      ]
    }
  ]
}

🔑 Vos informations de connexion

• Base URL : https://hytale.game/wp-json/hytale-api/v1
• Votre Clé Secrète : XXX-XXX-XXX (Disponible dans votre interface de gestion)
• Pseudo de test : Leviauzah

🛠️ Intégration Manuelle (Développeurs)

Le système fonctionne sur un cycle simple : Vérifier (Check) puis Valider (Claim).

Étape 1 : Vérifier les votes en attente

Dès qu’un joueur se connecte à votre serveur, interrogez l’API pour récupérer ses votes non réclamés.

• Méthode : GET
• URL d’exemple : https://hytale.game/wp-json/hytale-api/v1/check?username=Leviauzah&secret_key=XXX-XXX-XXX
• Réponse JSON : L’API renvoie une liste d’objets contenant l’ID du vote et la date.

Étape 2 : Valider le vote (Claim)

Une fois la récompense donnée en jeu, vous devez valider le vote pour qu’il disparaisse de la file d’attente.

• Méthode : POST (ou GET)
• URL d’exemple : https://hytale.game/wp-json/hytale-api/v1/claim?vote_id=1&secret_key=XXX-XXX-XXX