diff --git a/README.md b/README.md index 6c97470..3e04c49 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,16 @@ mods without ever touching the original files, and lets you build new levels, ed ones and share them as small files. Everything is based on a complete reverse engineering of the game's level formats and its object scripts ("strats"). +![The LlamaMod launcher: tick mods, set their options, Apply and Play](docs/img/readme-launcher.jpg) + +*The launcher: tick the mods you want, set their options, click Apply and Play.* + +![The LlamaMod level editor with Village chapter 1 open](docs/img/readme-editor.jpg) + +*The level editor with Village chapter 1 open: outliner (left), 3D view, inspector (right), assets and scripts (bottom).* + +More pictures: + | | | |---|---| | ![LlamaMod launcher](docs/img/launcher.jpg) | ![Level editor](docs/img/editor.jpg) | @@ -93,9 +103,16 @@ python3 tools/asf2wav.py /path/to/cd/music/Village.asf village.wav python3 tools/cor2png.py /path/to/cd/t111.cor t111.png ``` -Some scripts have hard-coded paths of the original Wine setup at the top (`WADS`, `MODWAD` in -`levelbuild.py`, `CD_WADS` in `debugviz.py`, `PREFIX`/`LAMA_MOD` in `lamatest.py`) – adjust them or -pass `--base`/`--src`. All tools: [docs/tools.md](docs/tools.md). +Where the tools look for the game files (or pass `--base`/`--src`): + +| Variable | Meaning | Default | +|---|---|---| +| `LLAMAMOD_CD` | the CD folder (`wads/`, `music/`, …), also for the Gradle tests | `~/.wine-lama/iso-dk/Setup/Eng/Cd` | +| `LAMA_WINEPREFIX` | Wine prefix of a hand-made game setup (`lamatest.py`, `levelbuild.py --install`) | `~/.wine-lama` | +| `APPTEST_ROOT`, `APPTEST_ISO` | session folders and ISO of `apptest.py` | `~/.cache/llamamod-apptest`, `~/Downloads/GROOVE_DK.iso` | +| `LLAMAMOD_DATA` | data folder of the app | `~/.local/share/LlamaMod` (Windows `%LOCALAPPDATA%\LlamaMod`) | + +All tools and variables: [docs/tools.md](docs/tools.md#paths). ### Key facts in one minute diff --git a/docs/img/readme-editor.jpg b/docs/img/readme-editor.jpg new file mode 100644 index 0000000..5b64271 Binary files /dev/null and b/docs/img/readme-editor.jpg differ diff --git a/docs/img/readme-launcher.jpg b/docs/img/readme-launcher.jpg new file mode 100644 index 0000000..d2db3cf Binary files /dev/null and b/docs/img/readme-launcher.jpg differ