Documentation

Premiers pas

Installez VoxelBench, lancez un premier benchmark ou un test seul et consultez les résultats, puis choisissez où tournent les benchmarks, liez et vérifiez le serveur, et activez le monitoring.

Prérequis

  • Serveur Minecraft : Spigot, Paper (et ses dérivés comme Purpur), Folia ou un serveur hybride Bukkit. Voir Compatibilité.
  • Version Minecraft : 1.17 ou plus récente, versions 26.x comprises
  • Java : la version exigée par votre serveur Minecraft (Java 16 au minimum ; 21 à partir de 1.20.5, 25 pour les 26.x)
  • Permissions : Opérateur (OP), ou voxelbench.use plus la permission de chaque commande (par exemple voxelbench.start pour /bench start ; voir Permissions)

Installation

  1. Téléchargez le dernier JAR VoxelBench depuis voxelbench.com ou les Releases GitHub
  2. Placez le fichier JAR dans le dossier plugins/ de votre serveur
  3. Redémarrez (ou démarrez) votre serveur
  4. VoxelBench génère ses fichiers de configuration dans plugins/VoxelBench/

Premier lancement

Après l'installation, vous pouvez utiliser VoxelBench immédiatement :

Ouvrir l'interface graphique

/bench gui

Ouvre l'interface d'inventaire principale, qui donne accès à toutes les fonctionnalités : tests, stress limit, monitoring, rapports et paramètres.

Lancer votre premier benchmark

Connectez-vous au serveur et tapez en jeu :

/bench start

Un benchmark complet a besoin d'un joueur connecté : il ne peut pas être lancé depuis la console. Il se déroule en trois phases :

  • Matériel : disque, réseau et mémoire
  • Gameplay : chargement de chunks, hoppers, sauvegarde du monde, explosions, redstone, physique des blocs, chunk ticking, éclairage, tile entities, IA des mobs et croissance au bone meal
  • CPU : single-core puis multi-core, exécutés en dernier pour profiter d'une JVM entièrement chauffée

Avant le départ, VoxelBench effectue des vérifications préalables (monde épinglé non plat ou qui n'est pas un monde de benchmark, autres joueurs connectés, charge actuelle du serveur, hébergement gratuit, plugins susceptibles d'interférer). Si quelque chose est détecté, un écran d'inventaire le liste et vous confirmez ou annulez. Le benchmark complet dure plusieurs minutes selon le matériel de votre serveur.

Consulter les résultats

À la fin du benchmark, le rapport est d'abord sauvegardé localement dans plugins/VoxelBench/reports/benchmark/, puis envoyé à voxelbench.com, qui calcule le VoxelScore. Quand le score revient, il s'affiche dans le chat avec un résumé et un lien vers le rapport en ligne, et il est inscrit dans le rapport local. Si l'envoi échoue, le rapport local est conservé sans score et le chat en indique la raison.

Lancer un test individuel

Pour tester un aspect précis de votre serveur :

/bench test chunkLoading
/bench test mobSpawn
/bench test disk 4 8 512M 3

Tapez /bench test sans argument pour voir tous les tests disponibles. Les paramètres acceptés par chaque test sont décrits dans Commandes.

Configuration optionnelle

Choisir où tournent les benchmarks

Les benchmarks font apparaître des entités et posent des blocs dans leurs zones de test. Par défaut, un run sans monde épinglé utilise un monde plat temporaire, supprimé à la fin (sur Folia, qui ne sait pas en créer, il utilise le monde principal). Pour réutiliser le même monde à chaque fois, créez un monde plat dédié et épinglez-le :

/bench world create bench
/bench world set voxelbench_bench

Voir Mondes de benchmark et Commandes - Mondes de benchmark.

Lier votre compte

Liez votre serveur à votre compte VoxelBench pour garder ses rapports dans votre compte (privés, conservés 30 jours avec l'offre gratuite et 1 an avec Pro, au lieu de 30 minutes) :

/bench link

Voir Liaison de compte pour les détails.

Vérifier la propriété du serveur

Une fois le serveur lié, prouvez que vous le contrôlez à son adresse publique (l'auto-bench l'exige) : générez un code sur la page du serveur sur voxelbench.com, puis lancez :

/bench verify VOXEL-XXXXX

Voir Vérification du serveur pour les détails.

Activer le monitoring

Démarrez le tableau de bord de performance en temps réel :

/bench monitor web start

Par défaut, il n'écoute que sur la machine du serveur : ouvrez-y http://localhost:8080. Pour l'atteindre depuis une autre machine, le tableau de bord exige d'abord un mot de passe (voir Monitoring). Voir Monitoring pour la configuration complète.

Changer la langue

VoxelBench détecte automatiquement la langue du client Minecraft de chaque joueur. Pour la forcer :

/bench lang en_US
/bench lang fr_FR
/bench lang auto

Et ensuite ?