an accessability mod for fallout4
  • C++ 95.5%
  • Python 2%
  • Lua 1.1%
  • Papyrus 1%
  • PowerShell 0.3%
Find a file
Alexander Epaneshnikov 49bad7ebba Read junk item component lists aloud in all inventory menus
ItemStatFormatter now detects InfoObj entries with a `components` array
(previously silently dropped) and announces them as e.g.
"Components: Gears 2, Screws 3 tagged, Steel". Count is omitted when 1.
Works in Container, Barter, Pip-Boy, and Examine menus automatically.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-03-20 22:10:49 +03:00
.claude Add Claude Code hook to auto-format C++ files after edits 2026-03-20 22:10:49 +03:00
Data Add fallout4access.esp and justfile for ESP syncing 2026-02-08 21:38:38 +03:00
docs Add caps, weight, trade direction, and quantity picker accessibility 2026-03-20 22:10:49 +03:00
lib Update commonlibf4 submodule and fix resulting build breakage 2026-03-02 18:59:24 +03:00
src Read junk item component lists aloud in all inventory menus 2026-03-20 22:10:49 +03:00
tools move scripts 2026-01-22 17:15:04 +03:00
.clang-format Add clang-format and clang-tidy configuration 2026-03-20 22:10:49 +03:00
.clang-tidy Fix bugprone and performance issues found by clang-tidy 2026-03-20 22:10:49 +03:00
.gitignore build: Ignore compiled Papyrus scripts (.pex) 2026-01-14 20:38:11 +03:00
.gitmodules Add SRAL as git submodule 2026-01-13 21:01:36 +03:00
CHANGELOG.md add docs and changelog 2026-02-16 11:32:01 +03:00
CLAUDE.md Remove hardcoded machine paths from docs and build config 2026-02-09 14:40:27 +03:00
EXCEPTIONS Initial commit 2025-06-21 00:00:05 +03:00
justfile Remove hardcoded machine paths from docs and build config 2026-02-09 14:40:27 +03:00
LICENSE Initial commit 2025-06-21 00:00:05 +03:00
README.md Update README with project description and feature list 2026-02-09 14:30:15 +03:00
xmake-requires.lock Update commonlibf4 submodule and fix resulting build breakage 2026-03-02 18:59:24 +03:00
xmake.lua Remove hardcoded machine paths from docs and build config 2026-02-09 14:40:27 +03:00

Fallout 4 Access

An F4SE plugin that makes Fallout 4 accessible to blind and visually impaired players. Uses SRAL (Screen Reader Abstraction Library) to provide screen reader support through NVDA, JAWS, or SAPI.

Features

Accessible Menus

  • Main Menu, Pause Menu - Full navigation and announcements
  • Settings Menu - All settings categories with values read aloud
  • Save/Load Menus - Save slot details including character level and playtime
  • Pip-Boy - Inventory, Stats, Data (Quests/Workshops/Stats), Map, and Radio pages
  • Container/Looting - Item lists with stats, weight, and value
  • Barter Menu - Vendor trading with side-switching (F key)
  • Terminal Menus - In-game computer terminals
  • Dialogue Menu - NPC conversation options with speaker names
  • VATS - Target selection and body part announcements
  • Level-Up Menu - Perk selection and descriptions
  • Workbenches - Cooking, Power Armor, and Robot workbenches
  • Workshop & Supply Lines - Settlement building and caravan management
  • Message Boxes & Confirmation Dialogs - Prompts and choices
  • S.P.E.C.I.A.L. Menu - Character creation stat allocation
  • Examine Menu - Item inspection
  • Loading Screens - Loading screen text read aloud

Gameplay Accessibility

  • Object Scanner - Scans nearby objects by category (NPCs, items, doors, containers) with subcategories, locked door detection, and corpse loot tracking
  • Crosshair Feedback - Announces what you're looking at
  • Auto-Aim - Continuous target tracking assistance
  • Auto-Walk - Navigate to map markers and scanned objects
  • Audio Hit Markers - Distinct sounds for hits, critical hits, and kills
  • HUD Notifications - Item pickups, location discoveries, and XP gains read aloud
  • Combat Stats (H key) - Press H to hear health, ammo, and other combat stats
  • Contextual Info - Carry weight and caps on Pip-Boy inventory

Requirements

Installation

  1. Install F4SE and Address Library if you haven't already
  2. Copy the fallout4access folder into your Fallout 4 Data directory (or install via a mod manager)
  3. The folder structure should be:
    Data/
      F4SE/
        Plugins/
          fallout4access.dll
      Sound/
        FX/
          F4A/
            UI/
              (sound files)
    
  4. Load fallout4access.esp in your mod load order

Building from Source

Requirements

  • XMake 2.8.2+
  • C++23 compiler (MSVC or Clang-CL)
  • Windows x64

Clone

git clone --recurse-submodules https://git.alex19ep.me/alex19EP/f4access
cd fallout4access

Build

xmake build

Build output is in build/windows/x64/release/fallout4access.dll.

Install to Mod Organizer 2

Set the environment variable XSE_FO4_MODS_PATH to your MO2 mods directory, then:

xmake install

Generate Visual Studio Project (Optional)

xmake project -k vsxmake

License

This project is licensed under the GNU General Public License v3.0.

Credits

  • CommonLibF4 - Reverse-engineered F4SE API
  • SRAL - Screen Reader Abstraction Library
  • F4SE - Fallout 4 Script Extender