New [Game] mantling setting, on by default, with mantle max height (1.1 times the actor's height above its feet) and mantle duration (0.4 s). When the player jumps or falls into a wall while moving towards it (within 60 degrees), the movement solver casts the player's collision shape up, across the edge and down. If it finds a surface flat enough to stand on, above the feet and within reach, with headroom and room on top, the player moves up, across and onto it along that checked path. Movement and jump input are ignored meanwhile, and the climb ends any fall without fall damage. No animation is needed. A script move or teleport, noclip or paralysis cancels a climb. Lua: self.controls.mantle (true by default) vetoes climbs while false, and the actor's scripts get an AshlarMantle event with the ledge height when one starts. The engine logs "Ashlar mantle:" lines at verbose level. Player only; with the setting off nothing changes. The geometry rules (reach, headroom, room on top, slope, too high, too low) and the climb path are in mwphysics/mantle.cpp, apart from the physics calls, with unit tests. The new mantle scenario uses a CC0 box mesh written for it: the player climbs an 80 unit ledge, doesn't climb it with the Lua veto, and doesn't climb a 240 unit wall. Closes #28 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Building OpenMW documentation
Building in Docker (the recommended way)
Preparing Docker image
Run the following commands from OpenMW source directory to build a new Docker image openmw_doc:
cd docs
docker build -t openmw_doc .
cd ..
(or run script docs/prepare_docker_image.sh)
This step needs to be repeated only if any dependencies were changed.
The image is based on Ubuntu 22.04 and installs the system tools and Python packages required to build the documentation. The bundled installation script builds Lua 5.1 and LuaRocks and installs a pinned version of openmwluadocumentor.
Generating HTML
Run the following command from OpenMW source directory to generate the documentation:
docker run --user "$(id -u)":"$(id -g)" --volume "$PWD":/openmw openmw_doc \
sphinx-build /openmw/docs/source /openmw/docs/build
(or run script docs/build_docs.sh)
To view the generated documentation just open docs/build/index.html in a browser.
Building without Docker (an alternative way)
Building documentation without Docker is more complicated as it requires multiple dependencies.
Installation of required python packages
From OpenMW source directory
pip3 install -r docs/requirements.txt
Installation of openmwluadocumentor:
Debian/Ubuntu
sudo apt install luarocks
git clone https://gitlab.com/ptmikheev/openmw-luadocumentor.git
cd openmw-luadocumentor/luarocks
luarocks --local pack openmwluadocumentor-0.2.0-1.rockspec
luarocks --local install openmwluadocumentor-0.2.0-1.src.rock
Windows
- install LuaRocks (heavily recommended to use the standalone package) https://github.com/luarocks/luarocks/wiki/Installation-instructions-for-Windows
git clone https://gitlab.com/ptmikheev/openmw-luadocumentor.gitcd openmw-luadocumentor/luarocks- open "Developer Command Prompt for VS <2017/2019>" in this directory and run:
luarocks --local pack openmwluadocumentor-0.2.0-1.rockspec
luarocks --local install openmwluadocumentor-0.2.0-1.src.rock
Generating HTML
Run the following command from OpenMW source directory to generate the documentation:
sphinx-build docs/source docs/build