1arx(6)                           Games Manual                           arx(6)
2
3
4

NAME

6       arx - Arx Libertatis, a cross-platform port of Arx Fatalis
7

SYNOPSIS

9       arx [-hnl] [-d data-dir] [-u user-dir] [-c config-dir] [-g debug-spec]
10

DESCRIPTION

12       arx  is the main executable of Arx Libertatis, a cross-platform port of
13       the first-person role-playing game Arx Fatalis. You will need the  data
14       from  the original Arx Fatalis to run the game. See https://arx.vg/data
15       for where you can get it.
16

OPTIONS SUMMARY

18       Here is a short summary of the options available in arx.  Please  refer
19       to the detailed  documentation below for a complete description.
20
21       Generic options:
22               -h --help               Show supported options
23               -g --debug LEVELS       Set debug output levels
24               --benchmark[=TIMELIMIT] Log loading times and framerates
25               --debug-gl[=MODE]       Enable OpenGL debug output
26               --override-gl OVERRIDES Override OpenGL extensions
27
28       Search path options:
29               -n --no-data-dir        Don't automatically detect data directories
30               -d --data-dir DIR       Where to find the data files (can be repeated)
31               -u --user-dir DIR       Where to store user-specific files
32               -c --config-dir DIR     Where to store config files
33               -l --list-dirs          List the searched user and data directories
34
35       Startup options:
36                  --loadlevel LEVELID  Load a specific level
37                  --loadsave SAVEFILE  Load a specific savegame file
38                  --loadslot SAVESLOT  Load a specific savegame slot
39                  --skiplogo           Skip logos at startup
40

OPTIONS

42       --benchmark[=TIMELIMIT]
43              Log time taken for startup, loading levels and shutdown, and the
44              minimum, maximum and average framerate.
45
46              If a TIMELIMIT argument is given, the game will exit  after  the
47              specified  amout of time has been spent rendering normal frames.
48              This time does not include the startup or  loading  time.  Valid
49              values  are a number, optionally followed by a unit. Valid units
50              are "ms" (milliseconds), "s" (seconds), "m"  (minutes)  and  "h"
51              (hours). The default unit is milliseconds.
52
53              This  option can be combined with the --loadlevel, --loadsave or
54              --loadslot options to benchmark a specific scene.
55
56       -c, --config-dir=DIR
57              By default arx will store  configuration  files  in  directories
58              specified  by the XDG Base Directory Specification.  This option
59              overrides the directory where config files are loaded  from  and
60              saved to.
61
62       -d, --data-dir=DIR
63              Arx Libertatis will look for data files in directories specified
64              by the XDG Base Directory Specification  and  in  the  directory
65              containing the game executable. Besides the system-wide data di‐
66              rectory, data files are also loaded  from  the  user  directory,
67              which can be set by the --user-dir option.
68
69              This option adds additional directories to search for data files
70              before the detected system-wide directories, but after the  user
71              directory.  To override the detected data directories combine it
72              with the --no-data-dir option.
73
74              The --data-dir option can be repeated to add multiple  data  di‐
75              rectories,  in  which  case  they are searched in the order pro‐
76              vided.
77
78              See https://arx.vg/paths and the --list-dirs output for more de‐
79              tails.
80
81              Use arx-install-data(1) to extract and install the required data
82              files from the various different Arx Fatalis setup  executables,
83              archives, CDROMs and existing installs.
84
85       -g, --debug=LEVELS
86              This  option can be used to enable debug output for debug builds
87              of Arx Libertatis. For non-debug build, this option is not  very
88              useful but recognized for convenience.
89
90       --debug-gl[=MODE]
91              Control  OpenGL  context  type  and debug output from the OpenGL
92              driver.
93
94              The following modes are possible:
95
96
97              "enabled" Enable additional error checks in  the  OpenGL  driver
98                     and  log  all reported errors. This is the mode used when
99                     --debug-gl is specified with no MODE argument.
100
101              "ignored" Enable only the standard OpenGL error checks  required
102                     by the standard and ignore all errors.
103
104              "noerror" Tell the OpenGL driver to assume that there will be no
105                     errors. Will fall back to "ignored" if not supported.
106
107              "default" Select one of the above modes depending on  the  build
108                     type and enabled features. This is the default when --de‐
109                     bug-gl is not used.
110
111       -h, --help
112              Show a list of the supported options.
113
114       -l, --list-dirs
115              Show the data, user and config search directories and  how  they
116              were  determined.  To  adjust  the  search  directories, use the
117              --no-data-dir, --data-dir, --user-dir and --config-dir options.
118
119       --loadlevel=LEVELID
120              Load a level immediately after startup, without displaying logos
121              or  the  main  menu.  LEVELID  is  the number of the level to be
122              loaded.
123
124       --loadsave=SAVEFILE
125              Load a save file immediately after startup,  without  displaying
126              logos  or the main menu. SAVEFILE is the path of the save direc‐
127              tory or .sav file to be loaded.
128
129       --loadslot=SAVESLOT
130              Load a save file immediately after startup,  without  displaying
131              logos  or  the main menu. SAVESLOT is the index of the save slot
132              to be loaded.
133
134       -n, --no-data-dir
135              Disables looking for default data directories. Default user  and
136              config  directories  and  data  directories  provided  using the
137              --data-dir option are still searched. This option  can  be  used
138              for portable setups where user, config and data files are all in
139              the current directory:
140
141              arx --no-data-dir --user-dir=. --config-dir=.
142
143       --override-gl=OVERRIDES
144              Overrides the used OpenGL extensions and features.  By  default,
145              Arx Libertatis will use all extensions that the driver claims to
146              support except for some that are known to cause issues with cer‐
147              tain drivers. This options allows the user to disable additional
148              extensions or re-enable extensions that are by default disabled.
149              It  will  not make Arx Libertatis attempt to use extensions that
150              the driver does not claim to support.
151
152              The overrides passed to this option are parsed after,  and  thus
153              overrride,  those  in  the  extension_override  setting  in  the
154              [video] section of cfg.ini which is in turn  applied  after  the
155              built-in driver quirk overrides.
156
157              All  disabled extensions - either by built-in rules or user-sup‐
158              plied overrides are logged.
159
160              The override string is made up of a series  of  override  tokens
161              separated by whitespace. Supported overrides are:
162
163              "-GL_ext": Disable OpenGL extension GL_ext.
164
165              "+GL_ext":  Re-enable OpenGL extension GL_ext if it was disabled
166                     by a previous  token  (including  built-in  driver  quirk
167                     rules).
168
169              "GLx.y",  "x.y",  "GLxy"  or  "xy": Re-enable extensions part of
170                     OpenGL version x.y and disabling all others
171
172              "GLx" or "x": Re-enable extensions part of  OpenGL  version  x.0
173                     and disabling all others
174
175              "+*" or "+": Re-enable all non-core OpenGL extensions
176
177              "-*"  or  "-" Re-enable extensions part of any known OpenGL ver‐
178                     sion and disabling all others
179
180              Note that the version overrrides (i.e. all except "-GL_ext"  and
181              "+GL_ext") fully override the set of allowed extensions and thus
182              make all previous tokens  meaningless.  In  particular,  --over‐
183              ride-gl="+"  will  disable  both the built-in driver quirk over‐
184              rides  and  the   extension_override   setting   while   --over‐
185              ride-gl="1.5" will disable the use of all optional extensions.
186
187       --skiplogo
188              Don't  display  Logo  images at startup. Currently this will not
189              skip the intro cutscene.
190
191       -u, --user-dir=DIR
192              By default arx will store user files (saves, etc.)  in  directo‐
193              ries  specified  by  the XDG Base Directory Specification.  This
194              option overrides the directory where user files are loaded  from
195              and saved to.
196
197              Configuration files are not stored in the user directory, but in
198              a separate directory that can be set by the --user-dir option.
199
200              The user directory will also be used to load  data,  overwriting
201              resources  from the system-wide data directories amd from direc‐
202              tories specified by the --data-dir option.
203

SEE ALSO

205       arx-install-data(1), arxsavetool(1), arxunpak(1)
206

BUGS

208       To view known bugs and report new ones, please visit  https://bugs.arx-
209       libertatis.org/.
210
211
212
2131.2.1                             2022-04-10                            arx(6)
Impressum