Skip to content

README.md

Latest commit

 

History

History
154 lines (114 loc) · 5.15 KB

README.md

File metadata and controls

154 lines (114 loc) · 5.15 KB
Raw

Ravenfield Access

An accessibility mod for Ravenfield that makes the game playable with a screen reader. Built as a BepInEx plugin using the Tolk library for screen reader output.

Supported screen readers: NVDA, JAWS, and SAPI (fallback).

Features

  • Screen reader announcements for menus, health, ammo, kills, deaths, damage, objectives, and weapon switches
  • Full keyboard navigation of all menus, loadout screens, and picker UIs (map, mode, vehicle, etc.)
  • Enemy detection with spatial audio beacons and aim assist (bullet magnetism + recoil compensation)
  • Pathfinding navigation using the game's A* pathfinding system with spatial audio beacons to guide you to objectives, vehicles, ladders, and resupply points
  • Obstacle and wall detection with radar scanning and optional proximity tones
  • Zone and surface callouts when moving between areas
  • Cover detection to find nearby cover positions
  • Vehicle support including enter/exit announcements, turret aiming, and approach guidance
  • Squad awareness with teammate status and squad order callouts
  • Game score tracking across all game modes
  • Victory/defeat announcements with auto-return to menu

Installation

Prerequisites

  • Ravenfield on Steam
  • BepInEx 5.4.x (NOT v6 -- v6 is incompatible)
  • A screen reader (NVDA recommended) or SAPI voices

Steps

  1. Install BepInEx 5 into your Ravenfield game folder (C:\Program Files (x86)\Steam\steamapps\common\Ravenfield). Follow the BepInEx installation guide. Run the game once after installing BepInEx so it creates its folder structure, then close it.

  2. Download the latest release zip from the Releases page.

  3. Extract the zip into your Ravenfield game folder. This will place:

    • BepInEx/plugins/RavenfieldAccessibility/RavenfieldAccessibility.dll (the plugin)
    • Tolk.dll, nvdaControllerClient64.dll, SAAPI64.dll (screen reader bridge, in game root)

  4. Launch Ravenfield. You should hear "Ravenfield Access loaded" from your screen reader.

Verifying Installation

Your Ravenfield folder should look like this:

Ravenfield/
  BepInEx/
    plugins/
      RavenfieldAccessibility/
        RavenfieldAccessibility.dll
  Tolk.dll
  nvdaControllerClient64.dll
  SAAPI64.dll
  ravenfield.exe
  ...

Keyboard Shortcuts

Status Keys (During Gameplay)

Key Action
H Health status
J Ammo status
K Objective / capture point status
L Location and nearest objective
I Nearby enemies (within 100m)
Shift+I Squad members status
U Closest enemy
Shift+U Nearby teammates (within 100m)
P Game score and victory condition

Camera and Aiming

Key Action
Left/Right Arrow Turn camera
Up/Down Arrow Look up/down
Shift+Up Arrow Level camera to horizontal
Ctrl Fire weapon

Navigation and Pathfinding

Key Action
Z Current zone
O Radar scan (walls/obstacles)
Shift+O Toggle wall proximity tones
C Find nearby cover
Page Up/Down Browse category (objectives, vehicles, ladders, resupply)
[ / ] Browse previous/next item in category
\ Track browsed item (start pathfinding beacon)
Shift+\ Stop tracking

Menu Navigation

Key Action
Up/Down Arrow Navigate menu items
Left/Right Arrow Navigate or cycle dropdowns
Tab / Shift+Tab Cycle through all UI elements
Enter or Space Activate button/toggle
Escape Go back

Loadout Screen

Key Action
1-5 Select weapon/gear slot
Left/Right Arrow Cycle weapons in slot
S Weapon stats
Tab Announce full loadout
Enter Deploy

Configuration

After first launch, a config file is created at:

Ravenfield/BepInEx/config/com.accessibility.ravenfield.cfg

You can toggle individual features on/off:

  • Announcements: Health, Damage, Kills, Objectives, Weapon Switch, Ammo, Menus, Hit Markers, Item Pickups, Squad Orders
  • Navigation: Zone Announcements, Surface Callouts, Wall Proximity Tones

Building from Source

Requires .NET Framework 4.6 targeting pack and the game installed.

dotnet build RavenfieldAccessibility.csproj

Use deploy.bat to build and copy files to the game folder automatically.

Known Limitations

  • This is a beta release -- expect rough edges
  • Workshop maps may have pathfinding quirks
  • Some UI elements in modded content may not be fully accessible
  • BepInEx 6 is not supported; use BepInEx 5.4.x

License

This project is provided as-is for accessibility purposes.

Credits