Files
ashlar/docs
claudeandClaude Opus 5.5 9be251af0a Add active blocking for the player
With [Game] 'real time combat' on, the player blocks by holding the new
Block action instead of relying on the classic block roll. Holding Block
with a shield equipped and the weapon drawn raises the block stance: no
new attacks start, movement slows to [Game] 'block stance speed'
(default 0.5), and every melee hit inside the fCombatBlockLeftAngle to
fCombatBlockRightAngle arc is blocked with no roll. Shield durability,
fatigue loss and Block skill training work as before, but the fatigue
cost now falls with Block skill, to half at 100. Without the stance the
player doesn't block. NPCs and creatures keep the classic roll (#20).

Block is engine action 51, exposed to Lua as input.ACTION.Block and as
the player's 'Block' Lua action, with self.controls.block. Defaults are
the middle mouse button and D-pad down, which nothing else uses. With
the setting off, behavior is unchanged.

The pure rules (arc, stance gate, fatigue scaling) live in the new
mwmechanics/activeblock.cpp with unit tests.

Closes #19

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-12 16:01:43 -05:00
..
2026-11-12 16:01:43 -05:00
2026-11-12 13:32:24 -05:00

Building OpenMW documentation

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

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