« RemoteToolkit » : différence entre les versions

De Nefald Wiki
Aller à la navigation Aller à la recherche
Hiob (discussion | contributions)
mAucun résumé des modifications
Hiob (discussion | contributions)
Aucun résumé des modifications
Ligne 8 : Ligne 8 :


== Installation ==
== Installation ==
= Installation and startup =
=== Wrapper installation ===
#Download the .zip provided in the Remote Toolkit [http://forums.bukkit.org/threads/674 thread].
#Create a new folder anywhere on your computer and extract the .zip there
#Open the '''serverdir''' folder (which should be where you extracted the .zip) and copy Minecraft_RKit.jar, the .sh/.bat files and the toolkit folder to the root of your minecraft server directory. (That's the folder with craftbukkit.jar in it)
#If your craftbukkit .jar is not named craftbukkit.jar, then you will need to open '''wrapper.properties''' (which is inside the toolkit folder) with your favorite text editor, and set '''minecraft-server-jar=''' to the name of your bukkit server jar file.
#Optional: If you need more than 1024M (1GB) of RAM allocated to your server, just edit '''initial-heap-size''' and '''maximum-heap-size''' to suit your needs.
=== Installation du plugin ===
#Copiez MinecraftRKitPlugin.jar se trouvant dans serverdir/plugins dans le dossier des plugins bukkit.
=== Lancer le wrapper ===
#Depending on your operating system, open either the included.bat file or the included .sh file in your favorite text editor.
#If you are editing the .bat file, change the user and pass arguments in '''user:pass''' to a username and password of your choosing (e.g. bobby:ilikepies123). Otherwise, if you are editing the .sh file, change the USER and PASS variables to anything of your choosing.
#Double click the script, or run it from the terminal/cmd prompt!
{{note|If you are using the .sh, remember to give execute permissions to it by navigating to the folder with the .sh in it and running the following command: '''chmod +x rtoolkit.sh'''}}
If you are experiencing problems with running it that way, try opening a terminal/cmd window, navigating to the directory that holds Minecraft_RKit.jar, and running the command:
java -Xmx30M -Xms30M -XX:MaxPermSize=40M -jar Minecraft_RKit.jar USER:PASS
{{note|Remember to replace USER and PASS with something else!}}
== Spécificités ==
== Spécificités ==
== Commandes ==
== Commandes ==
=== Console telnet ===
=== Console (telnet) ===
 
;<font style="color:red;">ATTENTION</font>
;C'est du telnet, alors on oublie pas le <font style="color:red;">.</font> devant chaque commande. o/
 
 


{| class="wikitable3"
{| class="wikitable3"
Ligne 17 : Ligne 45 :
|-
|-
|.help
|.help
|Displays the list of console commands recognized by the wrapper.
|Afficher la liste des commandes utilisables sur le wrapper.
|-
|-
|.hold
|.hold
|Stops the server until .unhold is used. This is useful if you want to perform an update to Bukkit without stopping the wrapper.
|Arrêter le serveur jusqu'à ce que .unhold soit utilisé. Utile si vous souhaitez effectuer une mise à jour de bukkit sans arrêter le wrapper.
|-
|-
|.unhold
|.unhold
|Unholds a held server.
|Relancer le serveur après avoir utilisé <code>.hold</code>.
|-
|-
|.modules
|.modules
|Displays the list of currently loaded Toolkit Modules.
|Afficher la liste des modules Toolkit actuellement chargés.
|-
|-
|.shutdowntime
|.shutdowntime
|Displays the time left until the next Toolkit shutdown.
|Afficher le temps restant avant le prochain arrêt de Toolkit.
|-
|-
|.restarttime
|.restarttime
|Displays the time left until the next server restart.
|Affiche le temps restant avant le prochain redémarrage du serveur.
|-
|-
|.restart
|.restart
|Gracefully restarts the Minecraft server.
|Redémarrer '''correctement''' le serveur Minecraft.
|-
|-
|.reschedulerestart <time>
|.reschedulerestart <time>
|Reschedules the next restart. The time parameter can either be in either the #h #m #s format, or the HH:MM format.
|Reporte au prochain redémarrage. Le paramètre de temps peut être soit au format #h #m #s , soit au format HH:MM.
|-
|-
|.rescheduleshutdown <time>
|.rescheduleshutdown <time>
|(Re)schedules a Toolkit shutdown. The time parameter can either be in either the #h #m #s format, or the HH:MM format.
|Reporte le prochain arrêt de Toolkit. Le paramètre de temps peut être soit au format #h #m #s , soit au format HH:MM.
|-
|-
|.cancelshutdown <time>
|.cancelshutdown <time>
|Cancels a scheduled Toolkit shutdown.
|Annule l'arrêt programmé de Toolkit.
|-
|-
|.stopwrapper
|.stopwrapper
|Stops the wrapper along with the server.
|Arrête le wrapper.
|-
|-
|.users
|.users
|Displays the list of users currently registered with the Toolkit.
|Afficher la liste des utilisateurs actuellement enregistrés sur Toolkit.
|-
|-
|.useradd <name> <password>
|.useradd <name> <password>
|Adds a user to the Toolkit.
|Ajouter un utilisateur à Toolkit.
|-
|-
|.userremove <name>
|.userremove <name>
|Removes a user from the Toolkit.
|Retirer un utilisateur de Toolkit.
|-
|-
|.set <option> <value>
|.set <option> <value>
|Sets a value to an option. (NOTE: Enter '.set help' for a list of valid options and values)
|Définit une valeur pour une option donnée. (REMARQUE: Entrer <code>.set help</code> pour la liste des options et valeurs valides.')
|-
|-
|.version
|.version
|Displays the version of the wrapper.
|Afficher la version du wrapper.
|}
|}
=== En jeu ===
=== En jeu ===
Ligne 73 : Ligne 101 :
|-
|-
|/restartsrv <[username:]password>
|/restartsrv <[username:]password>
|Restart the server from in-game. If no username is provided, then the player's username will be substituted.
|Redémarrer le serveur à partir du jeu. Si aucun nom d'utilisateur n'est fourni, alors le nom d'utilisateur sera substitué par celui du joueur.
|-
|-
|/reschedulerestart <[username:]password> <time>
|/reschedulerestart <[username:]password> <time>
|Reschedules the next server restart. The time parameter can either be in either the #h #m #s format, or the HH:MM format. If no username is provided, then the player's name will be substituted.
|Reporte au prochain redémarrage. Le paramètre de temps peut être soit au format #h #m #s , soit au format HH:MM. <br />Si aucun nom d'utilisateur n'est fourni, alors le nom d'utilisateur sera substitué par celui du joueur.
|-
|-
|/stopwrapper <[username:]password>
|/stopwrapper <[username:]password>
|Stops both the server and the Toolkit. THIS WILL SHUT THE SERVER DOWN AND WILL NOT RESTART IT
|Arrête le serveur et le toolkit. CECI arrête le serveur et ne le RELANCE PAS.
|}
|}


Ligne 86 : Ligne 114 :
==== wrapper.properties  ====
==== wrapper.properties  ====


*<code><nowiki>minecraft-server-jar</nowiki></code> - The name of the Minecraft server jar to launch.
*<code><nowiki>minecraft-server-jar</nowiki></code> - Le nom du .jar utilisé pour lancer le serveur.
*<code><nowiki>extra-runtime-arguments</nowiki></code> - A '''comma separated''' list of arguments to be sent to the java runtime environment.
*<code><nowiki>extra-runtime-arguments</nowiki></code> - Une liste d'arguments (séparées par des virgules) devant être envoyées au java runtime.
*<code><nowiki>server-arguments</nowiki></code> - A '''comma separated''' list of arguments to be sent to the server process.
*<code><nowiki>server-arguments</nowiki></code> - Une liste d'arguments (séparées par des virgules) devant être envoyées au processus serveur.
*<code><nowiki>initial-heap-size</nowiki></code> - Initial amount of memory to allocate to the server. This is equivalent to the -Xms flag.
*<code><nowiki>initial-heap-size</nowiki></code> - Montant initial de mémoire à allouer au serveur. Ceci est équivalent à l'indicateur '''-Xms'''.
*<code><nowiki>maximum-heap-size</nowiki></code> - Maximum amount of memory to allocate to the server. This is equivalent to the -Xmx flag.
*<code><nowiki>maximum-heap-size</nowiki></code> -   Montant maximal de mémoire à allouer au serveur. Ceci est équivalent à l'indicateur '''-Xmx'''.
*<code><nowiki>overridden-process-arguments</nowiki></code> - Takes a '''space separated''' list of arguments and overrides the entire command the Toolkit uses to start the Minecraft server. For example setting this to ''java -Xms1024M -Xmx1024M -Djline.terminal=jline.UnsupportedTerminal -jar craftbukkit.jar'' is the same as running the wrapper with the default settings. '''Remember to include -Djline.terminal=jline.UnsupportedTerminal or the console will not work correctly!'''
*<code><nowiki>overridden-process-arguments</nowiki></code> - Définir une liste d'arguments (séparés par des virgules) qui l'emporteront sur les commandes du toolkit utilisées au lancement du serveur. <br/ >'''Par exemple''' : paramétrer  ''java -Xms1024M -Xmx1024M -Djline.terminal=jline.UnsupportedTerminal -jar craftbukkit.jar'' et vous obtenez la configuration par défaut.<br/>
*<code><nowiki>server-restart-alerts</nowiki></code> - A list of times before a restart at which to warn players of a restart. It is in the same format as server-restart-delay, but it can take multiple values. For example, server-restart-alerts=1h 30m, 30m, 10m would warn the players at 1 hour 30 minutes before a restart, 30 minutes before a restart and 10 minutes before a restart.
*<code><nowiki>server-restart-alerts</nowiki></code> - Définir l'interval entre chaque alertes avertissant les joueurs d'un redémarrage. <br/>'''Par exemple''' : ''server-restart-alerts=1h 30m, 30m, 10m'' préviendra 1h30, puis 30 minutes, puis 10 minutes avant le redémarrage.<br/>
*<code><nowiki>server-restart-delay</nowiki></code> - The period at which to restart the server. It is in the format '''#h #m #s''', where h = hours, m = minutes and s = seconds. For example, if you would want it to restart ever 3 hours and 30 minutes, you would set it as server-restart-delay=3h 30m (notice that #s has been omitted. You can omit segments that are not needed). Alternatively, a sequence of explicit times for restarts can be set. This is done by setting the property to a comma separated list of 24hr times in the format '''HH:MM'''. For example, setting it to 09:30,15:30,00:00 would have it restart at 9:30am, 3:30pm and 12:30am. Setting this option to 0 will disable restarts.
*<code><nowiki>server-restart-delay</nowiki></code> - Période de redémarrage du serveur. Le paramètre de temps peut être soit au format #h #m #s , soit au format HH:MM. <br/>'''Par exemple''': ''09:30,15:30,00:00'' redémarrera à 9h30, 15h30 et 12h30. Définir sur ''0'' pour désactiver.<br/>
*<code><nowiki>server-saveall-period</nowiki></code> - The period at which to perform a save-all. Values should be in the '''#h #m #s''' format as specified above. Setting it to 0 will disable automated saves.
*<code><nowiki>server-saveall-period</nowiki></code> - Période entre chaque sauvegarde auto (''save-all''). <br/>Le paramètre de temps peut être soit au format #h #m #s , soit au format HH:MM. Définir sur ''0'' pour désactiver.<br/>
*<code><nowiki>forced-restart-delay</nowiki></code> - The amount of time to wait after a scheduled restart is meant to occur before forcing the server to restart. This acts as a failsafe in the event that the toolkit cannot restart the server normally.
*<code><nowiki>forced-restart-delay</nowiki></code> - Le temps d'attente après qu'un redémarrage planifié est été censé se produire, avant de forcer le redémarrage du serveur.<br/> Il s'agit d'une sécurité intégrée dans le cas où le ToolKit ne pourrez pas redémarrer le serveur normalement.
*<code><nowiki>toolkit-autoshutdown-delay</nowiki></code> - The amount of time to wait before shutting the toolkit (and server) down. Time is specified in the '''#h #m #s''' or '''HH:MM''' format. Leave blank to disable.
*<code><nowiki>toolkit-autoshutdown-delay</nowiki></code> - La quantité de temps à attendre avant de fermer Toolkit (et le serveur donc), au format HH:MM. Laissez vide pour désactiver.
*<code><nowiki>toolkit-autoshutdown-alerts</nowiki></code> - A list of times before a shutdown at which to warn players of a shutdown. It is in the same format as server-restart-alerts.
*<code><nowiki>toolkit-autoshutdown-alerts</nowiki></code> - Intervals durant lesquels les joueurs seront avertis d'un arrêt du serveur, au format HH:MM.
*<code><nowiki>force-save-on-restart</nowiki></code> - True if a save-all should be forced on a server restart/hold/shutdown, false otherwise.
*<code><nowiki>force-save-on-restart</nowiki></code> - définir sur True si une sauvegarde de l'ensemble du serveur doit être faite avant chaque redémarrage / hold / une fois arrêté, false pour désactiver.
*<code><nowiki>restart-on-severe-exception</nowiki></code> - True if the server should restart on some "SEVERE" exceptions, false otherwise.
*<code><nowiki>restart-on-severe-exception</nowiki></code> - définir sur True pour que le serveur redémarre en cas d'exceptions "SEVERE". False pour désactiver.
*<code><nowiki>severe-exception-detection-level</nowiki></code> - Sets the aggressiveness of the severe exception detection algorithm. Aggressiveness is defined by an integer between 1 and 3 (inclusive), where 1 is the least aggressive and 3 is the most.
*<code><nowiki>severe-exception-detection-level</nowiki></code> - Définit l'agressivité de l'algorithme de détection d'exceptions sévères. L'agressivité est définie par un nombre entier compris entre 1 et 3, 1 est la moins agressive et 3 est le plus.
*<code><nowiki>disable-heartbeats-on-missing-plugin</nowiki></code> - True if heartbeat restarts should be disabled when the bukkit plugin is not detected, false otherwise.
*<code><nowiki>disable-heartbeats-on-missing-plugin</nowiki></code> - True si l'heartbeat restarts doit être désactivée lorsque le plugin bukkit n'est pas détecté, false pour désactiver.
*<code><nowiki>server-heartbeat-threshold</nowiki></code> - Sets the amount of time the Toolkit wrapper waits before sending a heartbeat request to the Toolkit plugin.
*<code><nowiki>server-heartbeat-threshold</nowiki></code> - Définit la durée pendant laquelle le wrapper Toolkit attend avant d'envoyer une demande de heartbeat pour le plugin Toolkit.
*<code><nowiki>failed-heartbeat-restart-count</nowiki></code> - Sets the number of unanswered heartbeat requests required before a server restart is forced.
*<code><nowiki>failed-heartbeat-restart-count</nowiki></code> - Définit le nombre de demandes de heartbeat sans réponses nécessaires avant qu'un redémarrage du serveur soit forcé.
*<code><nowiki>filter-ansi-escape-codes</nowiki></code> - Set whether or not the toolkit should filter out ansi escape codes (such as colors) from the server console. This can be set as either true, false or auto.
*<code><nowiki>filter-ansi-escape-codes</nowiki></code> - Activer ou non le filtrage les codes d'échappement ANSI (comme les couleurs) à partir de la console. Ceci peut être défini sur True, False ou auto.
*<code><nowiki>enable-jline</nowiki></code> - True if jline console formatting should be enabled, false otherwise.
*<code><nowiki>enable-jline</nowiki></code> - True si le formatage de la console jline doit être activée, false pour désactiver.


==== remote.properties  ====
==== remote.properties  ====

Version du 13 avril 2013 à 14:10


RemoteToolkit
RemoteToolkit
Plugin
Catégorie utilitaire [edit]
Développeur(s) drdanick
Nefald
Status installé [edit]
Grade requis Intendant
Article
Dernière révision 13/04/2013


RemoteToolkit n'est pas un plugin bukkit, il fonctionne en effet avec n'importe quel serveur minecraft.
Il permet le contrôle du serveur, en telnet notamment.

Topic originel sur forums.bukkit.org

Installation

Installation and startup

Wrapper installation

  1. Download the .zip provided in the Remote Toolkit thread.
  2. Create a new folder anywhere on your computer and extract the .zip there
  3. Open the serverdir folder (which should be where you extracted the .zip) and copy Minecraft_RKit.jar, the .sh/.bat files and the toolkit folder to the root of your minecraft server directory. (That's the folder with craftbukkit.jar in it)
  4. If your craftbukkit .jar is not named craftbukkit.jar, then you will need to open wrapper.properties (which is inside the toolkit folder) with your favorite text editor, and set minecraft-server-jar= to the name of your bukkit server jar file.
  5. Optional: If you need more than 1024M (1GB) of RAM allocated to your server, just edit initial-heap-size and maximum-heap-size to suit your needs.

Installation du plugin

  1. Copiez MinecraftRKitPlugin.jar se trouvant dans serverdir/plugins dans le dossier des plugins bukkit.

Lancer le wrapper

  1. Depending on your operating system, open either the included.bat file or the included .sh file in your favorite text editor.
  2. If you are editing the .bat file, change the user and pass arguments in user:pass to a username and password of your choosing (e.g. bobby:ilikepies123). Otherwise, if you are editing the .sh file, change the USER and PASS variables to anything of your choosing.
  3. Double click the script, or run it from the terminal/cmd prompt!


If you are experiencing problems with running it that way, try opening a terminal/cmd window, navigating to the directory that holds Minecraft_RKit.jar, and running the command:

java -Xmx30M -Xms30M -XX:MaxPermSize=40M -jar Minecraft_RKit.jar USER:PASS

Spécificités

Commandes

Console (telnet)

ATTENTION
C'est du telnet, alors on oublie pas le . devant chaque commande. o/


commande description
.help Afficher la liste des commandes utilisables sur le wrapper.
.hold Arrêter le serveur jusqu'à ce que .unhold soit utilisé. Utile si vous souhaitez effectuer une mise à jour de bukkit sans arrêter le wrapper.
.unhold Relancer le serveur après avoir utilisé .hold.
.modules Afficher la liste des modules Toolkit actuellement chargés.
.shutdowntime Afficher le temps restant avant le prochain arrêt de Toolkit.
.restarttime Affiche le temps restant avant le prochain redémarrage du serveur.
.restart Redémarrer correctement le serveur Minecraft.
.reschedulerestart Reporte au prochain redémarrage. Le paramètre de temps peut être soit au format #h #m #s , soit au format HH:MM.
.rescheduleshutdown Reporte le prochain arrêt de Toolkit. Le paramètre de temps peut être soit au format #h #m #s , soit au format HH:MM.
.cancelshutdown Annule l'arrêt programmé de Toolkit.
.stopwrapper Arrête le wrapper.
.users Afficher la liste des utilisateurs actuellement enregistrés sur Toolkit.
.useradd <name> <password> Ajouter un utilisateur à Toolkit.
.userremove <name> Retirer un utilisateur de Toolkit.
.set <option> <value> Définit une valeur pour une option donnée. (REMARQUE: Entrer .set help pour la liste des options et valeurs valides.')
.version Afficher la version du wrapper.

En jeu

commande description
/restartsrv <[username:]password> Redémarrer le serveur à partir du jeu. Si aucun nom d'utilisateur n'est fourni, alors le nom d'utilisateur sera substitué par celui du joueur.
/reschedulerestart <[username:]password> Reporte au prochain redémarrage. Le paramètre de temps peut être soit au format #h #m #s , soit au format HH:MM.
Si aucun nom d'utilisateur n'est fourni, alors le nom d'utilisateur sera substitué par celui du joueur.
/stopwrapper <[username:]password> Arrête le serveur et le toolkit. CECI arrête le serveur et ne le RELANCE PAS.

Configuration

wrapper.properties

  • minecraft-server-jar - Le nom du .jar utilisé pour lancer le serveur.
  • extra-runtime-arguments - Une liste d'arguments (séparées par des virgules) devant être envoyées au java runtime.
  • server-arguments - Une liste d'arguments (séparées par des virgules) devant être envoyées au processus serveur.
  • initial-heap-size - Montant initial de mémoire à allouer au serveur. Ceci est équivalent à l'indicateur -Xms.
  • maximum-heap-size - Montant maximal de mémoire à allouer au serveur. Ceci est équivalent à l'indicateur -Xmx.
  • overridden-process-arguments - Définir une liste d'arguments (séparés par des virgules) qui l'emporteront sur les commandes du toolkit utilisées au lancement du serveur.
    Par exemple : paramétrer java -Xms1024M -Xmx1024M -Djline.terminal=jline.UnsupportedTerminal -jar craftbukkit.jar et vous obtenez la configuration par défaut.
  • server-restart-alerts - Définir l'interval entre chaque alertes avertissant les joueurs d'un redémarrage.
    Par exemple : server-restart-alerts=1h 30m, 30m, 10m préviendra 1h30, puis 30 minutes, puis 10 minutes avant le redémarrage.
  • server-restart-delay - Période de redémarrage du serveur. Le paramètre de temps peut être soit au format #h #m #s , soit au format HH:MM.
    Par exemple: 09:30,15:30,00:00 redémarrera à 9h30, 15h30 et 12h30. Définir sur 0 pour désactiver.
  • server-saveall-period - Période entre chaque sauvegarde auto (save-all).
    Le paramètre de temps peut être soit au format #h #m #s , soit au format HH:MM. Définir sur 0 pour désactiver.
  • forced-restart-delay - Le temps d'attente après qu'un redémarrage planifié est été censé se produire, avant de forcer le redémarrage du serveur.
    Il s'agit d'une sécurité intégrée dans le cas où le ToolKit ne pourrez pas redémarrer le serveur normalement.
  • toolkit-autoshutdown-delay - La quantité de temps à attendre avant de fermer Toolkit (et le serveur donc), au format HH:MM. Laissez vide pour désactiver.
  • toolkit-autoshutdown-alerts - Intervals durant lesquels les joueurs seront avertis d'un arrêt du serveur, au format HH:MM.
  • force-save-on-restart - définir sur True si une sauvegarde de l'ensemble du serveur doit être faite avant chaque redémarrage / hold / une fois arrêté, false pour désactiver.
  • restart-on-severe-exception - définir sur True pour que le serveur redémarre en cas d'exceptions "SEVERE". False pour désactiver.
  • severe-exception-detection-level - Définit l'agressivité de l'algorithme de détection d'exceptions sévères. L'agressivité est définie par un nombre entier compris entre 1 et 3, où 1 est la moins agressive et 3 est le plus.
  • disable-heartbeats-on-missing-plugin - True si l'heartbeat restarts doit être désactivée lorsque le plugin bukkit n'est pas détecté, false pour désactiver.
  • server-heartbeat-threshold - Définit la durée pendant laquelle le wrapper Toolkit attend avant d'envoyer une demande de heartbeat pour le plugin Toolkit.
  • failed-heartbeat-restart-count - Définit le nombre de demandes de heartbeat sans réponses nécessaires avant qu'un redémarrage du serveur soit forcé.
  • filter-ansi-escape-codes - Activer ou non le filtrage les codes d'échappement ANSI (comme les couleurs) à partir de la console. Ceci peut être défini sur True, False ou auto.
  • enable-jline - True si le formatage de la console jline doit être activée, false pour désactiver.

remote.properties

  • remote-control-port - The port to bind the remote control servers to.
  • remote-bind-address - The address to bind the remote control servers to. NOTE: In most cases this should be left blank
  • auth-salt - The string that is concatenated with both the username and password before being hashed. If this is key does not exist, the toolkit will generate a random salt.
  • telnet-enabled - True if the telnet server is enabled. False otherwise.
  • shell-password-mask - The character(s) to use when masking password input.
  • shell-input-echo - True if the telnet shell should echo each character typed, false otherwise.
  • message-playback-count - The number of console lines to send to users connecting to the remote console.

messages.txt

  • restart-kick-message - The kick message used to alert players that the server is being restarted.
  • toolkit-shutdown-kick-message - The kick message used to alert players that the server is shutting down.
  • hold-kick-message - he kick message used to alert players that the server is being held.
  • restart-time-warning - The warning given when a restart alert is scheduled to occur. %t is substituted for the time remaining.
  • restart-warning - Sent to all players approximately 3 seconds before the server is restarted.
  • toolkit-shutdown-time-warning - The warning given when a shutdown alert is scheduled to occur. %t is substituted for the time remaining.
  • toolkit-shutdown-warning - Sent to all players approximately 3 seconds before the server is shut down.
  • hold-warning - Sent to all players approximately 3 seconds before the server is held.
  • auto-save-start - Sent to all players when an auto-save event has started.
  • auto-save-complete - Sent to all players when an auto-save is completed
  • restart-time-left - Reply to players asking for the restart time. NOTE: This is not implemented yet!