The Getaway remaster
====================

A remaster of The Getaway (PS2, 2002). It needs your own copy of the game:
the NTSC-U disc image (SCUS-97133) as an .iso file. Nothing from the
original game is included.

Requirements
------------
- A GPU with a Vulkan 1.2 driver.
- Linux: glibc 2.35 or newer (Ubuntu 22.04, Debian 12 and later).
- Windows: Windows 10 or 11, 64-bit.
- macOS: macOS 12 or newer, Apple silicon or Intel (Vulkan through
  MoltenVK, which the app carries).

First start
-----------
1. Put your disc image next to the game as game.iso, or point iso_path in
   config/settings.ron at it (the game writes that file from
   config/settings.example.ron on its first start), e.g.
     Linux:   iso_path: Some("/home/me/Games/Getaway, The (USA).iso"),
     Windows: iso_path: Some("C:/Games/Getaway, The (USA).iso"),
   (on Windows use forward slashes or double backslashes; a relative path
   is relative to the game's folder).
2. Start the game:
     Linux:   ./getaway.sh
     Windows: getaway.exe (from its own folder)

On macOS move Getaway.app where you like (e.g. Applications) and open
it. It is not notarised: macOS refuses it the first time; allow it under
System Settings -> Privacy & Security -> Open Anyway (or run
  xattr -dr com.apple.quarantine Getaway.app
once). The main menu asks for the disc image. The settings, mods and saves
live in ~/Library/Application Support/getaway-remaster/, the texture cache
in ~/Library/Caches/getaway-remaster/; the folders and settings.ron the
rest of this README names next to the game are there.

Without a disc image the game opens a test scene in Free Roam.

The first time a texture is needed it is converted into a cache, with
these settings in texture-cache/ next to the game. To convert everything up
front:  texcache build

Logs
----
The game writes what it logs to logs/getaway.log next to the game (on
macOS in ~/Library/Application Support/getaway-remaster/logs/); the
sessions before it are getaway.1.log (the last one) to getaway.4.log.
When something goes wrong, send getaway.log, or getaway.1.log when it
happened in the session before; restarting the game moves the logs up.
A crash also leaves a report the main menu offers to send.

Mods
----
With these settings the mods/ folder next to the game is the mods
directory. It holds beta-cars (the disc's unused cars in the traffic),
cheats, strand-hair (strands of hair on the characters) and hd-textures
(the HD texture pack's mod, without the pack). The full (-materials)
package adds generated-materials (normal, height, roughness and metalness
maps for London, made for the HD textures: load it after hd-textures),
london-ground (leaves, moss, weeds and litter on London's ground) and
makehuman-characters (MakeHuman figures for the pedestrians and the
player). A mod runs once it is listed under `mods` in settings.ron;
beta-cars and cheats are on, in the full package london-ground and
makehuman-characters too, e.g.
  mods: ["beta-cars", "cheats", "hd-textures", "generated-materials", "london-ground", "makehuman-characters"],
`getaway-mods list` shows what is installed and active.
The PCSX2 HD texture pack is not included: download it yourself, then
import it into hd-textures with:
  getaway-mods import-pcsx2 <replacements folder>
getaway-mod-manager does all of this in a window: it installs mods from a
.zip or a folder, turns them on and off, orders and deletes them, imports
the HD texture pack (a folder or a .zip) and links to its download page,
and builds a mod from a GTA V car pack you downloaded (for your own use).

Multiplayer
-----------
Hosting from the game starts getaway-server, which must stay next to the
game. The dedicated server can also run on its own:
  getaway-server --bind 0.0.0.0:7777
Large mods for its players come from an HTTPS mirror. getaway-mirror is
one: it serves what `getaway-server --publish-mods DIR` writes, over plain
HTTP on port 7778, for an HTTPS proxy (Cloudflare) in front of it:
  getaway-mirror --dir DIR
