# Ashlar Ashlar is a fork of [OpenMW](https://gitlab.com/OpenMW/openmw) focused on making open-world RPG play feel modern. Ashlar is licensed under GPLv3, like OpenMW, and ships no commercial game data. ## Principles - **Engine work stays game-neutral.** Features are built as engine and Lua capabilities that work with whatever content is loaded. - **Test content is original.** Features are developed and tested with the asset-free OpenMW Game Template and CC0 assets. - **Players bring their own data.** OpenMW's data-file loading is unchanged, so players can point Ashlar at game files they own. The project does not distribute, convert or remaster commercial game content. - **Stay close to upstream.** Changes should be easy to rebase, and general fixes should be offered back to OpenMW. ## Roadmap Progress is tracked in the repository's milestones. 1. **Baseline:** reproducible build, tests, CI and performance numbers. 2. **Feel:** combat, movement, camera, animation blending and IK, controller support. 3. **Interface:** a modern Lua UI to replace the MyGUI menus. 4. **Visuals:** PBR materials, lighting, shadows and post-processing. Vulkan only if profiling justifies it. ## Building The Docker build needs no host packages other than Docker: ```bash docker/ashlar-build.sh ``` Build output and the compiler cache go to `~/.cache/ashlar`. Set `JOBS` and `MEMORY` to tune resource use, for example `JOBS=8 MEMORY=16g`. The script builds the engine and runs both unit test suites. To boot the built engine on the asset-free Game Template: ```bash docker/ashlar-run.sh ``` This uses a virtual display and software rendering, then saves a screenshot to `~/.cache/ashlar/run/boot.png`. The log is `~/.cache/ashlar/run/stdout.log`. To play it in a window on this desktop with the NVIDIA GPU and PulseAudio: ```bash docker/ashlar-play.sh ``` Extra arguments go to `openmw`, for example `--skip-menu --new-game`. Settings persist in `~/.cache/ashlar/play/home/.config/openmw/`. To play with game data you own, point `MORROWIND_DATA` at its `Data Files` folder. The folder is mounted read-only, and Tribunal and Bloodmoon load if present. Settings and saves go to `~/.cache/ashlar/play-morrowind/`. ```bash MORROWIND_DATA="/path/to/Data Files" docker/ashlar-play.sh ``` To record a frame-time baseline on the NVIDIA GPU without opening a window: ```bash docker/ashlar-bench.sh ``` See `docs/ashlar/BENCHMARK.md` for the method and the recorded baseline. ## Git remotes - `origin` is `git@gitea.eom.dev:Gaming/ashlar.git`. - `upstream` is `https://gitlab.com/OpenMW/openmw.git`. - `tes3mp` is `https://github.com/TES3MP/TES3MP.git`. - `tes3mp-corescripts` is `https://github.com/TES3MP/CoreScripts.git`. Ashlar's `main` is based on OpenMW's `master`. Upstream's tags are kept for reference. ## CI Ashlar's CI is `.gitea/workflows/`. Gitea ignores upstream's `.github/workflows` only for commits that contain `.gitea/workflows`, so pushing a ref that doesn't, such as a new upstream tag, would queue upstream's macOS and Windows jobs on the shared runner. Don't push upstream tags or branches to `origin` until that's handled. The `vendor/tes3mp-0.8.1` and `vendor/tes3mp-corescripts-0.8.1` branches hold TES3MP's unmodified source for reference. Multiplayer is currently out of scope.