Warning: file_get_contents(./documentation/config/control console.prefix): failed to open stream: No such file or directory in /var/www/k9720-1/htdocs/hexaverse/html.php on line 65
Hexaverse - Documentation
Top Banner

Server Control Console

Hexaverse comes with a localhost-only control console of running server instances. It is provided in the ControlConsole\ subdirectory of the install directory. The program will automatically connect with any local server running on the default server port. If no server is running, or the connection is lost, the client will continuously probe localhost for a connection. It is not possible to connect to a remote server, as the server rejects all non-localhost connections.


The program loosely follows a unix-like syntax, with commands and variables arranged in virtual directories by the server. Use the help command to get started.

Some hints:

  • ls lists the contents of the current virtual working directory
  • cd [X] changes to the relative path [X]. Use cd .. to move the respective virtual parent directory. Paths starting with a / indicate absolute paths.
  • exit closes the console
  • help [X] prints any available help text about [X] (variable or command)
  • [X]=[Y] defines or updates a variable [X] to a new value [Y]. Not all variables can be updated. Others may execute complex code upon change

Simply enter a command to execute it. 'Executing' a variable prints its current value.

The console allows partial auto-completion. Use tab on an incomplete input to display and/or automatically chose a complete command/path/variable.

Virtual Working Directory

The server maintains one single working directory across all connected control consoles. To assure non-global commands are always executed correctly in a scripted environment use absolute paths (with a leading /).

Runtime Parameters

By default the server connects to the default port using interactive mode. The following runtime parameters may be used to alter this behavior:

  • -p/--port [port]: Use non-default base port.
  • -s/--server: Start and supervise server.
  • -c/--command [cmd]: Explicitly connect, execute remote command(s), and terminate. Virtual directory updates are printed with a leading =, Regular results with a +, errors with a -. Multiple commands can be chained using ; as separator.
  • Anything else: Interpreted as a command, and executed as if -c was declared.

Server Supervision Mode

If the console is started with the --server option, then it will automatically start a server for you, and attempt to connect to it. Regular heartbeats make sure the control console closes when the server does, and vice versa. This option can be combined with the --port option, changing the server to a different base port. Should not be combined with any other option.