            _______________________
           /\                      \
           \_|         Arx         |
             |      Libertatis     |
             |   __________________|__
              \_/____________________/


Cross-platform port of Arx Fatalis, a first-person role-playing game

Arx Libertatis is based on the publicly released Arx Fatalis source code
(https://web.archive.org/web/20180105233341/https://www.arkane-studios.com/uk/arx_downloads.php).
The source code is available under the GPLv3+ license with some additional terms - see the
COPYING and LICENSE files for details.

 Contact
=========

Website: https://arx-libertatis.org/

Bug Tracker: https://bugs.arx-libertatis.org/

IRC: #arx on libera.chat

Wiki: https://wiki.arx-libertatis.org/

Reddit: /r/ArxFatalis/ (https://old.reddit.com/r/ArxFatalis/)


 Requirements
==============

i686: glibc 2.6+
amd64: glibc 2.6+


 Data file, config and savegame locations
==========================================

You will need to get either the full game or demo data of Arx Fatalis (https://arx.vg/data).

Where arx will look for data files and write config and save files depends on the operating
system and environment - the wiki has a page detailing the full data directory detection algorithm
(https://arx.vg/paths).

For Unix-like systems:
The game will try to rename all used files in the user directory (but not the data directory)
to lowercase on the first run. System-wide installations with case-sensitive filesystems always
need to manually rename the files to lowercase. The arx-install-data script can be used to
install the data files, convert them to lowercase and verify that all required files are present.

To print all directories searched by arx, run

    $ ./arx --list-dirs

By default, user, config and data files will be loaded from and saved to standard system
locations depending on the OS:

Linux and others:
 - user dir: ~/.local/share/arx/
 - config dir: ~/.config/arx/
 - data dir: /usr/share/games/arx/, /usr/local/share/games/arx/ and more

Arx will also try to load data files from the directory containing the game executable.

To use the current working directory for user, config and data files (e.g. for a portable install)
run the game as

    $ ./arx --no-data-dir --user-dir=. --config-dir=.

We have included an arx-portable wrapper that sets these options for you. Combine this with
installing the pak files into the data subdirectory to get one portable install.


 Run
=====

Provided the data files are installed at the correct location, you can simply play the game
using the installed shortcut or by running

    $ ./arx

See the `arx --help` and `man doc/arx.6}` output for more details.


 Tools
=======

 - `arxunpak [options] <pakfile> [<pakfile>...]`
   Extracts Arx Fatalis .pak files containing the game assets.
   See the `arxunpak --help` and `man doc/arxunpak.1}` output for more details.

 - `arxunpak [options] [--all]`
   Extracts all game assets.
   See the `arxunpak --help` and `man doc/arxunpak.1}` output for more details.

 - `arxsavetool <command> <savefile> [<options>...]` - commands are:
   - `extract <savefile>`
     Extract the contents of the given savefile to the current directory
   - `add <savefile> [<files>...]`
     Add files to a savefile, create it if needed
   - `fix <savefile>`
     Fix savegame issues created by previous builds of Arx Libertatis
   - `view <savefile> [<ident>]`
     Print savegame information - leave out <ident> to list root files


 Scripts
=========

The arx-install-data script can extract and install the game data under Linux and FreeBSD from
the CD, demo, GOG.com (https://www.gog.com/) installer or any Arx Fatalis install (such as on
Steam) - simply run it and follow the GUI dialogs. Also see the wiki page on installing the
game data under non-Windows systems at https://arx.vg/install-data.

Or, if you prefer a command-line interface, run it as

    $ ./arx-install-data --cli

More options and required tools (depending on the source file) are documented in the help output:

    $ ./arx-install-data --help
