Battle Network Legacy Collection Vol. 2 Accessibility Mod
=========================================================

An accessibility mod for Mega Man Battle Network Legacy Collection Vol. 2,
covering Battle Network 6 Cybeast Gregar and Cybeast Falzar and the
collection's own menus. It adds screen reader speech, spatial audio cues and
a navigation list with pathfinding for blind and visually impaired players.

This is an early build. Not every screen speaks yet.


Requirements
------------
- Windows 10 or 11, 64-bit
- Mega Man Battle Network Legacy Collection Vol. 2 installed through Steam
- A screen reader, such as NVDA
- A controller is recommended; the mod's own controls are controller buttons


What is included
----------------
- Chaudloader 0.15.0 (dxgi.dll, chaudloader.dll, lua54.dll), the mod loader
  this mod runs on, and a chaudloader.toml that enables this mod
- mods\mmbnlc-accessibility, the mod itself
- This README


How to install
--------------
1. In Steam, right-click Mega Man Battle Network Legacy Collection Vol. 2,
   choose Manage, then Browse local files.

2. Open the folder named exe. It contains MMBN_LC2.exe.

3. Copy everything from this folder (dxgi.dll, chaudloader.dll, lua54.dll,
   chaudloader.toml, the mods folder and this README) into that exe folder.
   Let it merge with an existing mods folder.

4. Start the game from Steam as usual.

When the game starts, Chaudloader shows a small window for about five seconds
and then starts the game by itself. You do not need to press anything.

If you already use other Chaudloader mods, keep your own chaudloader.toml and
add "mmbnlc-accessibility" to its enabled_mods list instead of replacing it.


Controls
--------
Walking around (Lan or MegaMan under your control):
- Hold L2 and press D-pad left or right to change the navigation category.
- Hold L2 and press D-pad up or down to choose a target in that category.
- Hold L2 and press L3 to start guidance to the selected target. A beep
  points the way. Do the same again to cancel it.
- The Main Quest category lists the current story Objective.

Chip selection in battle:
- Press L2 to hear MegaMan's health and position.
- Hold R2 and press D-pad up or down to go through the enemies: name, HP,
  row, column and position in the list.

Menus, dialogue and the PET speak automatically.

Audio cue toggles and volumes are in the collection's Options menu, in the
Accessibility section.


How to uninstall
----------------
Delete mods\mmbnlc-accessibility from the game's exe folder.

If no other Chaudloader mods are installed, also delete dxgi.dll,
chaudloader.dll, lua54.dll and chaudloader.toml from the exe folder. Otherwise
remove "mmbnlc-accessibility" from enabled_mods in chaudloader.toml.

Your settings are stored in mods\mmbnlc-accessibility\wall-tones.settings and
are removed with that folder.


Troubleshooting
---------------
- No speech at all
  Make sure your screen reader is running. Check
  mods\mmbnlc-accessibility\accessibility.log in the exe folder; it records
  what the mod did at startup.

- The mod stopped working after a game update
  The mod checks the game executable and refuses to load on a version it was
  not built for. Wait for an updated mod release.

- Antivirus removed dxgi.dll
  dxgi.dll is Chaudloader's loader. Restore it and add an exception for the
  game's exe folder.

When reporting a problem, include accessibility.log.


Credits and licenses
--------------------
Chaudloader is by bigfarts and contributors (MIT license). Lua is by Lua.org,
PUC-Rio (MIT license). Speech uses Prism and spatial audio uses Steam Audio.
Their licenses and notices are in mods\mmbnlc-accessibility\notices.
