U7Revisited

# Ultima VII: Revisited

Welcome to Ultima VII: Revisited, my attempt to write a replacement engine for Ultima VII: The Black Gate.

If you like this project, please consider supporting me!

https://ko-fi.com/viridiangames

https://www.patreon.com/c/viridiangames

<a href="https://www.youtube.com/watch?v=iDK5f3IkmrQ">
  <img width="1280" height="720" alt="image" src="https://github.com/user-attachments/assets/c85f4858-9468-4a19-8698-f62361a0df4a" />
</a>
(Click for a preview of coming attractions.)

## Installation and Running the Engine

To run this program, you will need to copy the contents of your original DOS ULTIMA7 folder to `/Data/u7`.  This
will allow the replacement engine to read in the maps and graphics from the original files.

- Locate your Ultima 7 game files (eg. `C:\Program Files (x86)\GOG Galaxy\Games\Ultima 7`)
![Typical GoG U7 folder](./screenshots/install-1.png)

- Copy ALL of these files, folders and subfolders into `./Data/U7` (*hint: look for the `U7.txt` file*)
![Project U7 Data folder](./screenshots/install-2.png)


## Developer Installation Notes

- Clone the project into a local folder using whatever git interface you prefer
- Copy the entire contents of your original DOS ULTIMA7 directory to `$(SolutionDir)/Redist/Data/U7/`

### Building with Meson (Cross-platform)

- Make sure you have the [Meson Build system](https://mesonbuild.com/) installed
- Run `meson setup build`, or if you want to generate a Visual Studio project, `meson setup --backend vs build`
- Run `meson compile -C build` to build the project
- Run the game from `Redist` so it can find its assets: `cd Redist && ../build/U7Revisited`

### Building on macOS

Use CMake to build both the game and the Ghost GUI editor on macOS.

**Required tools:**

- **Xcode Command Line Tools:** Apple Clang with C++17 support, Make, Git, and the macOS SDK. A full Xcode installation also provides these tools.
- **[CMake 3.15 or newer](https://cmake.org/download/):** Configures and builds the project, downloads raylib, and includes CTest for running the contract tests.

Meson, Ninja, and Python are not required for this workflow.

Install the Command Line Tools if they are not already installed, and finish the installer before continuing:

```bash
xcode-select --install
```

Install CMake from its website and make sure `cmake` and `ctest` are on your `PATH`. If you install the official CMake app in `/Applications`, you can add its tools to the current shell with:

```bash
export PATH="/Applications/CMake.app/Contents/bin:$PATH"
```

Alternatively, if you already use [Homebrew](https://brew.sh/), install CMake with:

```bash
brew install cmake
```

**Libraries provided by the project or macOS:**

- **raylib 5.0:** CMake downloads a checksum-verified source archive from GitHub and builds it for your Mac. Its GLFW window backend and audio/image dependencies are bundled with raylib.
- **Lua 5.4.7:** Built from the sources in `ThirdParty/lua`.
- **nlohmann/json:** Headers are inc