Difference between revisions of "Command Line Arguments"

From Tales of Maj'Eyal
Jump to: navigation, search
(Update module flag text. Add CLI for indexing)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The <code>t-engine</code> executable supports several command-line arguments.
+
 
 +
<!-- Version of ToME when this page was written -->
 +
{| class="wikitable" style="border: 1px solid gray; font-size: large;"
 +
|ToME Version: || 1.7.2
 +
|}
 +
<!-- Please update if you update the page! -->
 +
 
 +
 
 +
The <code>t-engine</code> executable supports several command-line (CLI) arguments.
  
 
{| class="wikitable"
 
{| class="wikitable"
 
! Argument !! Effect
 
! Argument !! Effect
 
|-
 
|-
| -M''module'' || Automatically load and run ''module'' instead of going to the boot menu
+
| -M''module'' || Automatically load and run the chosen ''module'' instead of going to the boot menu. The module name is based on the ''short_name'' in the module's ''init.lua'' file
 
|-
 
|-
 
| -u''name'' || Use ''name'' for the character name instead of prompting, and either load that character's saved game or create a new game with that name.
 
| -u''name'' || Use ''name'' for the character name instead of prompting, and either load that character's saved game or create a new game with that name.
Line 16: Line 24:
 
| --ypos ''y'' || Create the game window at the given Y coordinate
 
| --ypos ''y'' || Create the game window at the given Y coordinate
 
|-
 
|-
| --flush-stdout || Write to <code>te4_log.txt</code> immediately instead of buffering output.  This facilitates debugging but can slow T-Engine4 down.
+
| --flush&#8209;stdout || Write to <code>te4_log.txt</code> immediately instead of buffering output.  This facilitates debugging but can slow T-Engine4 down.
 
|-
 
|-
 
| --no-debug || Disables most output to <code>te4_log.txt</code>
 
| --no-debug || Disables most output to <code>te4_log.txt</code>
Line 23: Line 31:
 
|-
 
|-
 
| --home ''path'' || Use the given directory instead of your default operating system home directory.  T-Engine's settings and saved games will be saved in a subdirectory under this home directory, as described [[Debugging#Updating_your_configuration|here]].  For example, this can be used to set up a separate directory for developing modules, with cheat enabled and with less "stuff" so it loads faster, without interfering with your regular ToME saved games.
 
| --home ''path'' || Use the given directory instead of your default operating system home directory.  T-Engine's settings and saved games will be saved in a subdirectory under this home directory, as described [[Debugging#Updating_your_configuration|here]].  For example, this can be used to set up a separate directory for developing modules, with cheat enabled and with less "stuff" so it loads faster, without interfering with your regular ToME saved games.
 +
|-
 +
| --no-steam || Disable Steam integration
 
|}
 
|}

Latest revision as of 19:14, 9 January 2021

ToME Version: 1.7.2


The t-engine executable supports several command-line (CLI) arguments.

Argument Effect
-Mmodule Automatically load and run the chosen module instead of going to the boot menu. The module name is based on the short_name in the module's init.lua file
-uname Use name for the character name instead of prompting, and either load that character's saved game or create a new game with that name.
-n Force creating a new game, overwriting any previous saved game for the given character name
-Eargs Passes extra arguments to the game module (?)
--xpos x Create the game window at the given X coordinate
--ypos y Create the game window at the given Y coordinate
--flush‑stdout Write to te4_log.txt immediately instead of buffering output. This facilitates debugging but can slow T-Engine4 down.
--no-debug Disables most output to te4_log.txt
--safe-mode Disables many graphical effects and reverts to minimal screen size and graphics settings
--home path Use the given directory instead of your default operating system home directory. T-Engine's settings and saved games will be saved in a subdirectory under this home directory, as described here. For example, this can be used to set up a separate directory for developing modules, with cheat enabled and with less "stuff" so it loads faster, without interfering with your regular ToME saved games.
--no-steam Disable Steam integration