Skip to content

Commit b63e10a

Browse files
Pyrhameclaude
andcommitted
Update docs for v1.4: Support link, SkyUI recommendation, gamepad section
- README.md: new "Support the Project" section at the top with Buy Me a Coffee link; "SkyUI strongly recommended" line in Requirements; new "Gamepad / Controller Support" section at the end listing all LB combos for scanner, map, and menus in bullet form. - LISEZMOI.md: French mirror with "Soutenir le projet", SkyUI mention, and full "Support manette" section. - GUIDE.md and GUIDE_FR.md: "SkyUI strongly recommended" line added to the "Before You Start" section. - CHANGELOG.md: LB+Y contextual stats and LB+Y map custom marker entries updated to reflect the final gamepad feature set shipped in v1.4. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 4d3c7e8 commit b63e10a

5 files changed

Lines changed: 122 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- LB + Right stick Up/Down: change sub-filter
1414
- LB + A: start/stop autowalk
1515
- LB + B: teleport to scanned target
16-
- LB + Y: announce health, magicka, stamina
16+
- LB + Y: contextual stats — in game announces health, magicka, stamina; in inventory, container or barter menu announces gold and carry weight (same behavior as H key on keyboard)
1717
- LB + LS click: toggle sneak (crouch/stand)
1818
- LB + RS click: toggle first/third person camera
1919
- RS click alone: lock nearest enemy
@@ -22,6 +22,7 @@
2222
- LB + D-pad Left: announce marker details
2323
- LB + D-pad Right: set reference point for distance calculation
2424
- LB + A: fast travel to selected marker (custom system, more reliable than vanilla)
25+
- LB + Y: place or remove a custom marker on the currently selected map marker (same as P key on keyboard) — the marker becomes a navigable target in the in-game scanner
2526
- LB + Right stick Left/Right: cycle location sub-filter (All types → Cities → Towns → Dungeons → Forts → Camps)
2627
- LB + Right stick Up/Down: cycle main filter (All → Discovered → Undiscovered → Quest Targets)
2728
- **Automatic remapping**

GUIDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Make sure you have:
1111
- The game launched through `skse64_loader.exe` (not the normal Skyrim launcher)
1212
- The SkyrimNVDA plugin installed
1313
- Skyrim Accessibility mod by Dio Kyrie installed — download the latest release at https://github.com/DioKyrie-Git/SkyrimAccessibility/releases
14+
- **SkyUI strongly recommended** — SkyrimNVDA was primarily designed and tested with SkyUI's inventory / container / barter layout. The plugin still works without SkyUI but some menu readings may be less accurate or miss details. Install SkyUI if you want the best accessibility experience.
1415

1516
When the game starts, NVDA will automatically begin reading menus and HUD elements.
1617

GUIDE_FR.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Assurez-vous d'avoir :
1010
- NVDA lance avant de demarrer le jeu
1111
- Le jeu lance via `skse64_loader.exe` (pas le lanceur normal de Skyrim)
1212
- Le plugin SkyrimNVDA et le mod d'accessibilite de Dio installes
13+
- **SkyUI fortement recommande** — SkyrimNVDA a ete concu et teste en priorite avec la disposition d'inventaire / conteneur / marchand de SkyUI. Le plugin fonctionne aussi sans SkyUI mais certaines lectures de menus peuvent etre moins precises ou manquer des details. Installez SkyUI pour une meilleure experience d'accessibilite.
1314

1415
Quand le jeu demarre, NVDA commence automatiquement a lire les menus et les elements du HUD.
1516

LISEZMOI.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,20 @@ Plugin d'accessibilite pour Skyrim Special/Anniversary Edition. Vocalise automat
44

55
---
66

7+
Soutenir le projet
8+
9+
Si vous souhaitez me soutenir et m'encourager dans mon travail d'accessibilite sur ce mod et les futurs que je ferai, vous pouvez retrouver ma page de dons ici et m'offrir un cafe ! Un grand merci !
10+
11+
https://buymeacoffee.com/pyrhame?l=en
12+
13+
---
14+
715
Configuration requise
816

917
- Skyrim Special Edition ou Anniversary Edition
1018
- SKSE64 (Skyrim Script Extender)
1119
- Lecteur d'ecran NVDA (doit etre lance avant le jeu)
20+
- **SkyUI fortement recommande** — SkyrimNVDA a ete concu et teste en priorite avec la disposition d'inventaire/conteneur/marchand de SkyUI. Sans SkyUI le plugin fonctionne quand meme mais certaines lectures de menus peuvent etre moins precises ou manquer des details.
1221

1322
---
1423

@@ -426,4 +435,54 @@ Creation de personnage
426435

427436
---
428437

438+
Support manette / Xbox / PlayStation
439+
440+
Support complet des manettes Xbox et PlayStation. LB est la touche modificateur pour toutes les combinaisons d'accessibilite. Vous pouvez reconfigurer quel bouton fait quoi dans la page MCM "Gamepad" si vous voulez changer les mappings par defaut.
441+
442+
Remappages automatiques faits par le plugin :
443+
444+
- Sprint : remappe de LB vers Stick gauche cliquable (aucune configuration manuelle necessaire)
445+
- Furtivite : remappe de Stick gauche cliquable vers LB + Stick gauche cliquable
446+
- Actions vanilla de LB dans les menus inventaire / conteneur / marchand : desactivees pour eviter les conflits avec nos combinaisons
447+
- L'action vanilla du bouton Y (Favori) est temporairement desactivee pendant que LB est maintenu dans un menu d'objets, donc LB + Y ne declenche pas un favori par accident. Y tout seul continue de fonctionner normalement pour marquer les favoris.
448+
- Sur la carte : l'inclinaison de camera via le joystick droit est desactivee (elle provoquait des lectures NVDA parasites des marqueurs survoles). Nos propres combinaisons sur le stick droit restent actives.
449+
- La touche P (Place Player Marker) est desactivee sur la carte au clavier pour eviter le conflit avec notre propre systeme de marqueur personnalise.
450+
451+
Scanner (en jeu, LB comme modificateur) :
452+
453+
- LB + D-pad Bas : objet suivant (plus loin)
454+
- LB + D-pad Haut : objet precedent (plus proche)
455+
- LB + D-pad Gauche : annoncer la cible actuelle
456+
- LB + Stick droit Gauche / Droite : changer de categorie (Tous, PNJ, Portes, etc.)
457+
- LB + Stick droit Haut / Bas : changer de sous-filtre
458+
- LB + A : demarrer / arreter la marche auto (detecte si vous etes a cheval et utilise automatiquement le mode monte)
459+
- LB + B : teleporter vers la cible scannee
460+
- LB + Y : stats contextuelles — en jeu annonce sante / magicka / vigueur ; dans un inventaire, conteneur ou marchand annonce l'or et le poids porte
461+
- LB + Stick gauche cliquable : basculer la furtivite (accroupi / debout)
462+
- LB + Stick droit cliquable : basculer la camera premiere / troisieme personne
463+
- Stick droit cliquable seul : verrouiller l'ennemi le plus proche
464+
465+
Menu carte (manette) :
466+
467+
- LB + D-pad Bas / Haut : marqueur suivant / precedent dans le filtre actuel (trie par distance)
468+
- LB + D-pad Gauche : annoncer les details du marqueur
469+
- LB + D-pad Droite : definir le point de reference pour le calcul des distances
470+
- LB + A : voyage rapide vers le marqueur selectionne (systeme custom, plus fiable que le vanilla)
471+
- LB + Y : poser ou retirer un marqueur personnalise sur le marqueur actuellement selectionne — le marqueur devient une cible navigable dans le scanner en jeu
472+
- LB + Stick droit Gauche / Droite : cycler le sous-filtre de lieux (Tous types, Villes, Bourgs, Donjons, Forts, Camps)
473+
- LB + Stick droit Haut / Bas : cycler le filtre principal (Tous, Decouverts, Non decouverts, Cibles de quete)
474+
475+
Menus (message box, level up, etc.) a la manette :
476+
477+
- D-pad Gauche / Droite / Haut / Bas : naviguer dans les choix (oui/non pour les message boxes, sante/magicka/vigueur pour le level up)
478+
- Bouton A : confirmer le choix selectionne
479+
- Bouton B : annuler la message box
480+
- Chaque changement de selection est vocalise automatiquement
481+
482+
Demarrer la marche auto a cheval : montez manuellement sur votre cheval d'abord, puis declenchez la marche auto (LB + A a la manette). Le plugin detecte que vous etes a cheval et c'est le cheval lui-meme qui marche vers la destination au lieu de vous forcer a descendre. Apres l'arret, il est possible que vous deviez descendre et remonter manuellement (E deux fois) pour recuperer le controle clavier / stick du cheval — c'est une particularite du moteur Skyrim qui affecte tous les mods utilisant ce systeme.
483+
484+
Le mouvement avec le stick gauche annule la marche auto — comme WASD au clavier.
485+
486+
---
487+
429488
*Plugin developpe par Pyrhame. Necessite NVDA.*

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,21 @@ Accessibility plugin for Skyrim Special/Anniversary Edition. Automatically vocal
44

55
---
66

7+
## Support the Project
8+
9+
If you want to support and encourage my accessibility work on this mod and the future ones I will be making, you can find my donation page here and buy me a coffee! A huge thank you!
10+
11+
https://buymeacoffee.com/pyrhame?l=en
12+
13+
---
14+
715
## Requirements
816

917
- Skyrim Special Edition or Anniversary Edition
1018
- SKSE64 (Skyrim Script Extender)
1119
- NVDA screen reader (must be running before launching the game)
1220
- Skyrim Accessibility mod by Dio Kyrie — download the latest release at https://github.com/DioKyrie-Git/SkyrimAccessibility/releases
21+
- **SkyUI is strongly recommended** — SkyrimNVDA has been designed and tested primarily with SkyUI's inventory/container/barter layout. Without SkyUI the plugin still works but some menu readings may be less accurate or miss details.
1322

1423
---
1524

@@ -456,4 +465,54 @@ Word Walls (where you learn dragon shouts) appear in the Activators category of
456465

457466
---
458467

468+
## Gamepad / Controller Support
469+
470+
Full Xbox / PlayStation controller support. LB is the modifier key for all accessibility combos. Configure which button does what in the MCM "Gamepad" page if you want to change the default mappings.
471+
472+
**Automatic remappings done by the plugin:**
473+
474+
- Sprint: remapped from LB to Left Stick click (no manual config needed)
475+
- Sneak: remapped from Left Stick click to LB + Left Stick click
476+
- LB vanilla actions in the inventory / container / barter menus: disabled to prevent conflicts with our combos
477+
- Y button vanilla action (Favorite) is temporarily disabled while LB is held in item menus, so LB + Y does not toggle a favorite accidentally. Y alone still works normally to mark favorites.
478+
- On the map: the right joystick camera tilt is disabled (it was causing NVDA to read nearby markers randomly). Our own combos on the right stick remain active.
479+
- P key (Place Player Marker) is disabled on the map keyboard to prevent conflict with our own custom marker system.
480+
481+
**Scanner (in game, LB as modifier):**
482+
483+
- LB + D-pad Down: next scanned object (farther)
484+
- LB + D-pad Up: previous scanned object (closer)
485+
- LB + D-pad Left: announce current target
486+
- LB + Right stick Left / Right: change category (All, NPCs, Doors, etc.)
487+
- LB + Right stick Up / Down: change sub-filter
488+
- LB + A: start / stop autowalk (detects if you are on a horse and uses mounted mode automatically)
489+
- LB + B: teleport to scanned target
490+
- LB + Y: contextual stats — in game announces health / magicka / stamina; in inventory, container or barter menu announces gold and carry weight
491+
- LB + Left Stick click: toggle sneak (crouch / stand)
492+
- LB + Right Stick click: toggle first / third person camera
493+
- Right Stick click alone: lock nearest enemy
494+
495+
**Map menu (gamepad):**
496+
497+
- LB + D-pad Down / Up: next / previous marker in current filter (sorted by distance)
498+
- LB + D-pad Left: announce marker details
499+
- LB + D-pad Right: set reference point for distance calculation
500+
- LB + A: fast travel to selected marker (custom system, more reliable than vanilla)
501+
- LB + Y: place or remove a custom marker on the currently selected map marker — the marker becomes a navigable target in the in-game scanner
502+
- LB + Right stick Left / Right: cycle location sub-filter (All types, Cities, Towns, Dungeons, Forts, Camps)
503+
- LB + Right stick Up / Down: cycle main filter (All, Discovered, Undiscovered, Quest Targets)
504+
505+
**Menus (message box, level up, etc.) with gamepad:**
506+
507+
- D-pad Left / Right / Up / Down: navigate choices (yes/no for message boxes, health/magicka/stamina for level up)
508+
- A button: confirm the selected choice
509+
- B button: cancel the message box
510+
- Each navigation change is vocalized automatically
511+
512+
**Starting autowalk while mounted:** mount your horse manually first, then trigger autowalk (LB + A on gamepad). The plugin detects you are riding and the horse itself walks to the destination instead of forcing you to dismount. After stopping, you may need to dismount and remount manually (E twice) to regain keyboard / stick control of the horse — this is a Skyrim engine quirk that affects every mod using the mounted travel pattern.
513+
514+
**Left stick movement cancels autowalk** — same as WASD on keyboard.
515+
516+
---
517+
459518
*Plugin developed by Pyrhame. Requires NVDA.*

0 commit comments

Comments
 (0)