Skip to content

Program Arguments

Program arguments make configuration in the terminal easier.

Provides a list of all available program arguments.

Terminal window
./void-linux-x64 --help
Description:
Runs the proxy
Usage:
void-linux-x64 [options]
Options:
-?, -h, --help Show help and usage information
-p, --plugin Provides a path to the file, directory or URL to load plugin.
-r, --repository Provides a URI to NuGet repository [--repository
https://nuget.example.com/v3/index.json or --repository
https://username:password@nuget.example.com/v3/index.json].
--forwarding-modern-key Sets the secret key for modern forwarding
--ignore-file-servers Ignore servers specified in configuration files
--interface Sets the listening network interface
--logging Sets the logging level
<Critical|Debug|Error|Information|None|Trace|Warning>
--offline Allows players to connect without Mojang authorization
--port Sets the listening port
--read-only Disables saving changes to the configuration files
--server Registers an additional server in format <host>:<port>
--version Show version information
  • --offline
    Allows players to connect without Mojang authentication.

    Example Usage
    ./void-linux-x64 --offline
  • --read-only
    Disables automatically saving changes to the configuration files.

    Example Usage
    ./void-linux-x64 --read-only
  • --interface
    Overrides the listening network interface.

  • --port
    Overrides the listening port for the proxy.

    Example Usage
    ./void-linux-x64 \
    --interface 0.0.0.0 \
    --port 25565
  • --server Registers a server in format <host>:<port> where the port is between 1 and 65535. IPv6 addresses must be enclosed in square brackets.

  • --ignore-file-servers Ignore servers specified in configuration files.

    Example Usage
    ./void-linux-x64 \
    --ignore-file-servers \
    --server 127.0.0.1:25565 \
    --server [2001:db8::1]:25565
  • --forwarding-modern-key Sets the secret key for Modern (Velocity) forwarding.

    Example Usage
    ./void-linux-x64 --forwarding-modern-key YourSecretKeyHere
  • --plugin Allows you to specify plugins to load.

  • --repository Allows you to specify NuGet repositories to resolve plugin dependencies.

    Example Usage
    ./void-linux-x64 \
    --plugin https://example.org/download/YourPlugin1.dll \
    --plugin /home/YourPlugin2.dll \
    --repository https://nuget.example.com/v3/index.json
  • --logging Sets the logging level. Valid values are Trace, Debug, Information, Warning, Error and Critical.

    Example Usage
    ./void-linux-x64 --logging Debug
  • --version
    Displays the current version of Void Proxy.

    Example
    ./void-linux-x64 --version