Start Ashlar: add project docs and Docker build
Build and test / Ubuntu (push) Failing after 1h6m25s
Reusable Windows workflow / windows-${{ inputs.image }} (push) Canceled after 0s
Build and test / MacOS (map[image:macos-26-intel]) (push) Canceled after 0s
Build and test / MacOS (map[image:macos-26]) (push) Canceled after 0s
Build and test / Windows (2022) (push) Canceled after 0s
Reusable MacOS workflow / ${{ inputs.image }} (push) Canceled after 0s
Build and test / Ubuntu (push) Failing after 1h6m25s
Reusable Windows workflow / windows-${{ inputs.image }} (push) Canceled after 0s
Build and test / MacOS (map[image:macos-26-intel]) (push) Canceled after 0s
Build and test / MacOS (map[image:macos-26]) (push) Canceled after 0s
Build and test / Windows (2022) (push) Canceled after 0s
Reusable MacOS workflow / ${{ inputs.image }} (push) Canceled after 0s
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,51 @@
|
||||
# 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.
|
||||
- **Real voices are not cloned.** AI voice-over uses a provider's licensed voices
|
||||
and never imitates a recorded performance.
|
||||
- **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.
|
||||
5. **AI voice-over:** optional bring-your-own-key dialogue voices.
|
||||
|
||||
## 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.
|
||||
|
||||
## Git remotes
|
||||
|
||||
- `origin` is `git@gitea.eom.dev:Gaming/ashlar.git`.
|
||||
- `upstream` is `https://gitlab.com/OpenMW/openmw.git`.
|
||||
|
||||
Ashlar's `main` is based on OpenMW's `master`. Upstream's tags are kept for
|
||||
reference.
|
||||
@@ -1,3 +1,5 @@
|
||||
> **Ashlar** is a fork of OpenMW focused on a modern open-world RPG feel. See [ASHLAR.md](ASHLAR.md). The rest of this file is OpenMW's README.
|
||||
|
||||
OpenMW
|
||||
======
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
FROM debian:trixie
|
||||
|
||||
RUN apt-get update \
|
||||
&& apt-get install -y --no-install-recommends \
|
||||
build-essential ca-certificates ccache cmake git mold ninja-build pkg-config \
|
||||
libavcodec-dev libavformat-dev libavutil-dev libswresample-dev libswscale-dev \
|
||||
libboost-iostreams-dev libboost-program-options-dev libboost-system-dev \
|
||||
libbullet-dev libcollada-dom-dev libfreetype6-dev libgl-dev libicu-dev \
|
||||
libjpeg-dev liblz4-dev libluajit-5.1-dev libopenal-dev libopenscenegraph-dev \
|
||||
libpng-dev libsdl2-dev libsqlite3-dev libtinyxml-dev libyaml-cpp-dev
|
||||
|
||||
WORKDIR /src
|
||||
Executable
+36
@@ -0,0 +1,36 @@
|
||||
#!/usr/bin/env bash
|
||||
# Builds the Ashlar engine and unit tests in Docker, then runs the tests.
|
||||
set -euo pipefail
|
||||
|
||||
repo="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
cache="${ASHLAR_CACHE_DIR:-$HOME/.cache/ashlar}"
|
||||
jobs="${JOBS:-3}"
|
||||
memory="${MEMORY:-6g}"
|
||||
image="ashlar-build:trixie"
|
||||
|
||||
mkdir -p "$cache/build" "$cache/ccache"
|
||||
docker build -t "$image" -f "$repo/docker/Dockerfile.ashlar" "$repo/docker"
|
||||
|
||||
docker run --rm \
|
||||
--memory="$memory" \
|
||||
--user "$(id -u):$(id -g)" \
|
||||
--env HOME=/tmp \
|
||||
--env CCACHE_DIR=/cache/ccache \
|
||||
--volume "$repo:/src:ro" \
|
||||
--volume "$cache:/cache" \
|
||||
"$image" bash -euc "
|
||||
cmake -S /src -B /cache/build -G Ninja \
|
||||
-DCMAKE_BUILD_TYPE=RelWithDebInfo \
|
||||
-DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
|
||||
-DCMAKE_C_COMPILER_LAUNCHER=ccache \
|
||||
-DOPENMW_USE_SYSTEM_MYGUI=OFF \
|
||||
-DBUILD_LAUNCHER=OFF \
|
||||
-DBUILD_OPENCS=OFF \
|
||||
-DBUILD_WIZARD=OFF \
|
||||
-DBUILD_COMPONENTS_TESTS=ON \
|
||||
-DBUILD_OPENMW_TESTS=ON
|
||||
cmake --build /cache/build -j '$jobs'
|
||||
cd /cache/build
|
||||
./components-tests
|
||||
./openmw-tests
|
||||
"
|
||||
Reference in New Issue
Block a user