-
Notifications
You must be signed in to change notification settings - Fork 0
Options
This page goes over the Engine Options that you can set. Engine options can be modified by the app using the GalaxiOption class or at start-up using their respective -Dgalaxi system flags.
Default Value: (auto)
Type: File
This option defines the return value of Galaxi.getAppDataDirectory(), which is typically used to store files related to user data that the user doesn't need or shouldn't have direct access to. The default value platform-dependent, meaning that it will be different depending on which operating system you are using (thus, auto).
Start-up Flag: -Dgalaxi.log.color_levels=
Default Value: true
Type: Boolean
This option enables/disables the automatic ansi coloring of the prefix on log messages. This setting only applies to the prefix; apps and plugins still have full control over the formatting of the messages themselves.
Start-up Flag: -Dgalaxi.console.scaling=
Default Value: (auto)
Type: Float
This option sets the scaling factor that Galaxi's console window will be rendered with. When left unset, the console window will automatically scale to fit your screen. Apps have no influence over this option.
Default Value: false
Type: Boolean
This option enables/disables the /reload command. This value defaults to false because it requires the app (and it's plugins) to listen for an extra event in order to be effective (GalaxiReloadEvent). This, however, does not prevent apps from running this event themselves.
Default Value: RUNTIME_DIRECTORY/Logs
Type: File
This option defines where the Galaxi logs will be placed. Despite using another option's value to construct the default, overriding APPLICATION_DIRECTORY alone will not change the value of LOG_DIRECTORY.
Start-up Flag: -Dgalaxi.console.max_scrollback=
Default Value: 15000
Type: Integer
This option sets how many log messages should be stored in memory for Galaxi's console window. This option has no effect when the console window is not visible.
Start-up Flag: -Dgalaxi.console.parse_vars=
Default Value: false
Type: Boolean
This option defines whether or not the Galaxi console will parse both Environment Variables (%) and System Property Variables ($) upon submitting a command. When parsing for these variables is disabled they are treated literally and do not need to be escaped. See the Commands page for more information on using variables in commands.
Start-up Flag: -Duser.dir=
Default Value: ./
Type: File
This option defines the return value of Galaxi.getRuntimeDirectory().
Start-up Flag: -Dgalaxi.console=
Default Value: (auto)
Type: Boolean
This option defines whether Galaxi should show the console window on GalaxiEngine.init(). The default value is true when Galaxi is run outside of a terminal on non-headless systems (thus, auto). It should be noted that the console window can be opened at any time regardless of this option's value using ConsoleCommandSender.openWindow().
Start-up Flag: -Dgalaxi.log.debug=
Default Value: false
Type: Boolean
This option defines whether the DEBUG log level is visible in both the console and log files.
Start-up Flag: -Dgalaxi.terminal.ansi=
Default Value: true
Type: Boolean
Changing this option signals to Galaxi that your terminal does not support ansi formatting. As such, it may correct some issues with formatting. This has no effect on Galaxi's own console window. Apps have no influence over this option.
Start-up Flag: -Dgalaxi.terminal.jline=
Default Value: true
Type: Boolean
Changing this option signals to Galaxi that your terminal does not support jline functionality. As such, it may correct some issues with formatting. This has no effect on Galaxi's own console window. Apps have no influence over this option.
Start-up Flag: -Dgalaxi.terminal.interruptable=
Default Value: true
Type: Boolean
Changing this option signals to Galaxi that it should ignore CTRL+C and terminal interrupt signals while your app is running. These will be re-enabled while your application is shutting down, however.
Start-up Flag: -Dgalaxi.log=
Default Value: true
Type: Boolean
This option defines whether or not Galaxi will write a log file. When this option is false, LOG_DIRECTORY may not be created.
Start-up Flag: -Dgalaxi.log.raw=
Default Value: (auto)
Type: Boolean
This option defines whether or not Galaxi will write the log in HTML formatting or use the raw console output. This can be helpful for debugging because the HTML is only written after every new line character (\n). The default value is false unless Java detects you are running Galaxi on a headless operating system (thus, auto).