CLANNAD Access 1.1
A screen reader accessibility mod for CLANNAD (Steam, English HD Edition).

With this mod, CLANNAD can be played without sight. The mod reads dialogue,
narration, speaker names, choices, menus, save slots and the story date
through your screen reader, describes what is on screen, and lets you use the
keyboard for all the menus the game normally only lets you use with the mouse.
It runs inside the game itself: there is no extra program to start.


WHAT'S NEW IN 1.1

- Scenes are described: places, characters and what they wear, and the art the
  story text leaves out, joined to the next line: description, then name, then
  dialogue. Shift with A chooses how often they come.
- Text drawn into pictures is read, along with the opening's lyrics and the
  endings' lyrics.
- Up and Down read the dialog box row by row while the story is going.
- Menus have a short description of how they look.
- The main menu grows as you finish more of the game, and the mod follows it.
  CG Mode and Music Mode work with the keyboard.
- Choices shown as buttons now work with Enter, and the save question drawn in a
  picture is read.
- Save and Load can swap and delete saves, write memos, and turn the
  confirmation messages on or off.
- Speech now uses Prism in place of Tolk. If NVDA starts or stops while you play,
  speech moves to it or away from it by itself.
- Lines that are only dots on screen now say "dots", so Enter is never silent on
  them.
- Fixed: lines where several characters speak at once were silent, and when a
  character's line started with your name or was a shout, the speaker or part of
  the line could be lost.
- The logos at the start of the game are read, and the legal notice once.


WHAT YOU NEED

- CLANNAD on Steam, with the game language set to English (this is the default).
- Windows 10 or 11.
- A screen reader such as NVDA or JAWS. If no screen reader is running, the mod
  uses a Windows voice instead, so Windows Narrator users will still hear it.


HOW TO INSTALL

The mod is three files. Installing means copying them into the game folder;
there is nothing to run.

1. Close CLANNAD if it is running.
2. Open the CLANNAD game folder. In Steam: open your Library, open the context
   menu on CLANNAD, choose Manage, then Browse local files. The folder that opens
   contains a file called SiglusEngine_Steam.exe.
3. Copy these files from this zip into that folder, next to
   SiglusEngine_Steam.exe (not into a sub-folder):
     version.dll
     prism.dll
     clannad_access_scenes.txt
     clannad_access.ini (optional: the settings file)
   If Windows asks for permission, choose Continue.
4. Start CLANNAD from Steam as usual. After a few seconds you will hear
   "CLANNAD Access 1.1 loaded".

If you have version 1.0: copy the new files over the old ones. You can then
delete Tolk.dll and nvdaControllerClient32.dll from the game folder, because the
mod doesn't use them any more.

clannad_access_scenes.txt holds every description in the game, so it contains
spoilers for the whole story. The mod reads it for you at the right moments;
you don't need to open it.

The game's language in Steam must be English (Steam, Library, CLANNAD,
Properties, Language). Other language versions of CLANNAD on Steam use a
different game engine, and the mod stays switched off there.

Some antivirus programs are suspicious of a new version.dll in a game folder,
because that is how mods like this one load. The mod does not change any game
files. If your antivirus removes version.dll, restore it or allow it, and copy
it again.


KEYS

The mod's keys only work while the CLANNAD window is in focus.

Everywhere
  Up and Down arrows: move through menu items
  Home and End: jump to the first or last item
  Enter: choose the current item
  Escape: go back or close
  A: turn the songs' subtitles on or off (the opening and the endings)

If you leave the main menu alone for about 40 seconds, the opening plays. Enter or
Escape ends it and goes back to the menu.

In the story
  Enter: next line (the game's own key)
  Escape: open the system menu (save, load, configuration, return to title...)
  Up and Down: read the dialog box row by row. The rows are any description or
     drawn text, the speaker's name, then the text. A new line starts on the text.
  S: say what is on screen: the place, who is there, what they look like, what
     they wear and their expression. During the credits, S reads the staff list.
  Shift with S: turn the scene descriptions and drawn text on or off.
  Shift with A: choose how often places and characters are described. Always (the
     first choice) describes a place each time you arrive at it and a character
     once at each place; if you press on quickly it is said at most twice. Then
     once per session, once ever, and no reading, which is the same as turning
     them off with Shift and S.
  Left bracket: read the previous line in the text log. Hold it to move quickly.
  Right bracket: read the next line in the text log.
     These are the two keys to the right of P on a US keyboard. On another layout,
     use those same two keys, whatever is printed on them.
  Shift with left bracket: jump to the oldest line in the log.
  Shift with right bracket: jump back to the latest line.
  P: play the character's voice again for the current line, or for the line
     you are reviewing in the log.
  D: say the current story date, or the name of the chapter if it has no date.

A, Shift with A and Shift with S are saved in clannad_access.ini.

Notifications
  When the story unlocks a new Dangopedia entry, you hear "Dangopedia term
  added" and the term (if Dangopedia notifications are on in the game). When
  you earn an achievement, you hear "Achievement unlocked" and its name.

Choices
  When a choice appears, all the options are read. Use Up and Down to pick one
  and Enter to select it. The text log keys still work during a choice.

Save and Load
  Up and Down: move between the 10 slots on a page. Each slot tells you if it
  is empty, or the chapter, the date and time it was saved, whether it is your
  newest save, and your memo if it has one.
  Left and Right: change page (10 pages).
  Enter: save to or load from the slot.
  Escape: go back.
  H: hear these extra keys.
  E: pick up a slot. Press E on another slot to swap the two, even on another
  page or with an empty slot. E on the same slot, or Escape, puts it back.
  Delete: delete the save in this slot.
  M: write a memo on this save. Type it, up to 32 letters, then press Enter to
  store it or Escape to cancel.
  C: turn the game's confirmation messages on or off.

Yes and No questions
  Left and Right: choose Yes or No. Enter: accept.

System menu extras
  "No menu transition delay" and "Auto Mode" tell you whether they are on or
  off; Enter switches them. "Close window" hides the text box; Enter brings it
  back. "Skip previously read text" runs through lines you have read; Escape stops
  it. "Return to previous choice" asks Yes or No, then reads the choice again.
  "Auto mode settings" opens the auto mode timing panel. In auto mode each line
  waits for its number of characters times the character delay, plus the base
  delay. Up and Down move between Character delay, Base delay, Restore
  defaults and Close. Left and Right change a delay and tell you the new value
  in seconds. Escape closes the panel.

Configuration
  Up and Down: move through the settings. Each one tells you its current
  state: which option is selected, whether a box is checked, or a slider's
  level in percent.
  Page Up and Page Down: jump between sections (Display, Sound, Character
  voices, Window background, Text, Other settings, Exit).
  Left and Right: change a setting that has two options (for example
  Fullscreen or Windowed), or move a slider (volumes, text speed, window
  colours) by about 13 percent. Hold Shift for small steps of about 2 percent.
  Use fade has a shorter bar, so it moves about 24 percent, or 3 with Shift.
  Enter: tick or untick a box, press a button, or turn a sound on or off.
  Escape: leave the configuration screen.

Dangopedia (the game's glossary)
  Up and Down: move between the entries you have discovered on this page, then
  the two checkboxes and Exit.
  Enter on an entry: read its full description.
  Left and Right: change page (5 pages).
  Escape: close.

Achievements (from the title screen)
  Tells you how many achievements you have unlocked. Up and Down go through
  the unlocked ones (name and what it was for) and the ones you can already
  see; achievements that are still secret are counted together. Then the two
  checkboxes and Exit. Escape: close.

CG Mode and Music Mode (from the title screen, once they appear)
  Up and Down: move between the pictures or tracks you have unlocked on this
  page, then the buttons.
  Left and Right: change page.
  Enter: view the picture or play the track. In the picture viewer, Enter goes
  to the next picture and Escape closes it.
  Escape: go back.

Name change (from the title screen)
  Type the last name, press Tab, type the first name, then press Enter to
  confirm or Escape to cancel. Each name can be up to 16 letters. F5 restores
  the default names. If the name is the same as a character's, the game asks
  whether to keep it; Escape answers No. After you confirm, the game asks whether
  to turn off voices (the voices still say the default name). Use Left and Right
  to choose and Enter to accept.


KNOWN LIMITS

- The text log keeps the last 200 lines read since you started the game, including
  lines from before you loaded a save. Lines you didn't read this time, such as
  the story before the point you loaded, are not in it.
- Voices for lines you skipped quickly can sometimes not be replayed.
- The Window mode "Settings", "Select font", "Movie settings" and "MMX
  settings" buttons open normal Windows dialogs, which your screen reader reads
  by itself (Tab and arrow keys). The mod names the ones whose title is not in
  English.
- The game's HELP button on the Save and Load screen shows a picture that isn't
  read. The H key tells you the same things.


WINDOWED OR FULLSCREEN

The mod works in both, but windowed mode is recommended. In fullscreen, the
game itself shows extra Windows popups each time it starts, and the mod's keys
only work once they are closed:

- "Change resolution": the game has switched your screen resolution and asks
  whether to keep it. Press Escape to switch back straight away, or wait 15
  seconds and it switches back by itself.
- "Screen settings": the game opens this after switching back. Press Escape
  to close it and go back to the game.
- Sometimes a window about the opening movie appears. Its text is in
  Japanese, so your screen reader may read question marks; the mod tells you
  what it says. Press Escape to skip the movie.

To go back to windowed mode: in Configuration, move to Window mode and press
the Right arrow (Windowed).


SETTINGS FILE

clannad_access.ini in the game folder turns parts of the mod on or off
(1 means on, 0 means off). Restart the game after changing it. For example,
set narration=0 if you only want dialogue read. It also says how often the
menu descriptions are read.


IF SOMETHING GOES WRONG

- You hear nothing when the game starts: check that version.dll and prism.dll
  are both in the same folder as SiglusEngine_Steam.exe.
- You hear no descriptions: check that clannad_access_scenes.txt is in that
  folder too, and press Shift with A to check how often they come. If it's set
  to once ever, the mod keeps track of them in clannad_access_heard.txt, and
  deleting that file brings them all back.
- You hear "this version of the game is not supported": the game files are
  different from the version the mod was made for, usually because the game's
  language in Steam is not English. The game still works normally, only the
  mod stays off.
- To report a problem, please send the file clannad_access_log.txt from the
  game folder, and say what you did just before it went wrong. The log from the
  session before that is kept as clannad_access_log_prev.txt.


HOW TO UNINSTALL

Close the game and delete these files from the game folder: version.dll,
prism.dll, clannad_access_scenes.txt, clannad_access.ini and
clannad_access_heard.txt, plus the log files clannad_access_log.txt and
clannad_access_log_prev.txt if they are there. If you used an older version of
this mod, also delete Tolk.dll, nvdaControllerClient32.dll and version_real.dll.
The game is then back to normal; your saves are not touched.


CREDITS AND LICENCES

Speech output uses Prism. Function hooking uses MinHook. See
THIRD-PARTY-NOTICES.txt and the licenses folder.
