atrogue Documentation
for Users
Command-Line Options
Introduction
atrogue allows you to specify several settings on the command-line when you
start the program. Some of these are only available if the respective compile-time configuration options have been enabled
before.
The Command-Line Options
- --animation=off - disable animation
- --animation=on - enable animation
- --colors=off - disable colors for the map display
- --colors=on - enable colors for the map display (default); this is
only possible if you have enabled the respective compile-time configuration option OPTION_COLORS. If you
enable colors but your terminal does not support them, atrogue still works, it
just doesn't use colors.
- --colorhl=value - when you've enabled color support, some
colors can look darker than they should; for example, a yellow obstacle symbol
({) in the dungeon
map might look brown with some VGA graphics cards. To avoid that, use this
"highlighting" option which sets the yellow color to a "real" yellow (use
yellow for value) or highlight all the other colors too (use
any for value). If you don't like this highlighting, don't use
this option at all or use none for value (default).
- --log=off - disable writing game messages into a log file
(default)
- --log=on - enable writing all game messages into a log file; the log
file is called ".atrogue-log" and lies in your home directory. (If the
environment variable "HOME" isn't set, the log file lies in the current
directory instead.) Do not play several atrogue games simultaneously with
logging enabled - the messages would intermix in the log file!
- --pref=string - the string presets options which
appear on the intro screen; this way, you need
not change the preferences manually whenever you start a new game. A template
string with the current preferences can be found on the Base Attributes
screen during gameplay; use the keyboard command Ctrl-x
to get there. The string has a simple, quite obvious structure: a letter
indicates which preference shall be set, and the following letter or number
specifies the desired value. This example shows default preferences:
"--pref=d2rrc4m3f5e2".
- --scr-width=number - the width of your terminal screen
(number of columns); you can use this if atrogue can't figure out the correct
screen size by itself
- --scr-height=number - the height of your terminal screen
(number of rows); you can use this if atrogue can't figure out the correct
screen size by itself
- --sec-width=number - the maximum width of dungeon sections;
currently, values from 60 to 120 are allowed here; if you don't use this
option, atrogue tries to adapt the section width to the width of your terminal
automatically when it starts.
- --sec-height=number - the maximum height of dungeon sections;
currently, values from 20 to 40 are allowed here; if you don't use this option,
atrogue tries to adapt the section height to the height of your terminal
automatically when it starts.
- --version - print a short version information and quit
This documentation file is part of version 0.3.0 of atrogue, a
"Rogue-like game" created by Arne Thomaßen.
atrogue is basically released under certain versions of the GNU General Public
License and WITHOUT ANY WARRANTY. Copyright (C) 2001-2010 Arne
Thomaßen. The project home page is atrogue.sourceforge.net.