Skip to content

Lirin111/Slots-and-daggers-access

Repository files navigation

Slots And Daggers - Full Accessibility Mod

A comprehensive accessibility modification for Slots And Daggers that provides complete Text-To-Speech support for blind and visually impaired players using screen readers.

Features

Complete Screen Reader Support

  • Full Menu Navigation: All main menu, pause menu, and sub-menu items are announced
  • Game State Announcements: Every game phase is announced (Your Turn, Enemy Turn, Level Selection, etc.)
  • Combat Feedback: Real-time announcements of attacks, damage dealt, health changes
  • Slot Results: Detailed announcements of spin results including:
    • Attack symbols with damage amounts (physical/magical)
    • Healing symbols with health restoration
    • Coin symbols with amounts gained
    • Shield symbols with protection gained
    • Respin symbols
    • Critical hits and mega critical hits

Status Updates

  • Health Monitoring: Current health and max health announced after changes
  • Shield Status: Shield values announced when gained or lost
  • Coin Tracking: Total coins announced when collected
  • Enemy Information: Enemy names, health, and defeat notifications

Interactive Elements

  • Button Announcements: All UI buttons announce their names when focused
  • Power-Up Selection: Power-up names and descriptions read aloud
  • Level Selection: Available levels announced during selection
  • Equipment Selection: Starting equipment options announced

Technical Details

Screen Reader Compatibility

Uses TOLK (Text Output Library Kit) to support multiple screen readers:

  • NVDA (NonVisual Desktop Access)
  • JAWS (Job Access With Speech)
  • System Access
  • Window-Eyes
  • ZoomText
  • SAPI (Microsoft Speech API) as fallback

Implementation

  • Built using MelonLoader mod framework
  • Harmony patches for non-intrusive game hooks
  • Automatic detection of screen readers
  • Smart announcement filtering to prevent spam
  • Delayed announcements for timing-critical information

Installation

Prerequisites

  1. Slots And Daggers v1.0.19 or compatible version
  2. MelonLoader installed in the game directory
  3. Screen Reader (one of the following):

Installation Steps

  1. Copy SlotsAndDaggersAccessibilityMod.dll to [Game Directory]\Mods\
  2. Copy Tolk.dll to [Game Directory]\ (game root)
  3. Copy nvdaControllerClient32.dll to [Game Directory]\
  4. Copy nvdaControllerClient64.dll to [Game Directory]\
  5. Launch your screen reader software
  6. Start Slots And Daggers

The mod will automatically load and announce "Slots And Daggers Accessibility Mod loaded successfully"

Usage

Main Menu Navigation

  • Use Tab/Arrow keys to navigate menu buttons
  • Each button is announced when focused
  • Press Enter/Space to activate buttons

Gameplay

  • Spinning Phase: When it's your turn, the game announces "Your turn. Spin the slots"
  • Results: Each slot result is announced with specific details
  • Combat: All damage dealt and received is announced
  • Status: Health, shields, and coins are announced when changed

Tips for Best Experience

  1. Listen for State Changes: The game announces when entering different phases
  2. Health Monitoring: Pay attention to health announcements during enemy turns
  3. Critical Hits: Special announcements for critical hits and mega criticals
  4. Power-ups: Descriptions are read when power-up selection phase begins

Game Mechanics (for Context)

Slots And Daggers Overview

Slots And Daggers is a roguelike slot machine RPG where you:

  • Spin slot machines to generate attacks, healing, coins, and shields
  • Battle enemies in turn-based combat
  • Collect power-ups and equipment
  • Progress through levels with increasing difficulty
  • Use coins to purchase upgrades

Symbol Types

  • Attack Symbols: Deal physical or magical damage to enemies
  • Heal Symbols: Restore your health
  • Coin Symbols: Gain currency for upgrades
  • Shield Symbols: Gain temporary protection
  • Respin Symbols: Spin additional reels
  • Bonus Symbols: Provide various bonuses

Critical Hits

  • 3 of a kind: Triple effect (Critical)
  • 5 of a kind: Even greater effect (Mega Critical)

Building from Source

Requirements

  • .NET 6.0 SDK or later
  • PowerShell (for build script)
  • MelonLoader installed in game directory
  • Game assemblies for references

Build Steps

  1. Ensure all paths in SlotsAndDaggersAccessibilityMod.csproj are correct
  2. Run BuildAndDeploy.ps1 in PowerShell:
    .\BuildAndDeploy.ps1
  3. The script will build the mod and copy all files to the game directory

Alternatively, build manually:

dotnet build SlotsAndDaggersAccessibilityMod.csproj -c Release

Troubleshooting

Mod doesn't load

  • Verify MelonLoader is properly installed (check for MelonLoader folder in game directory)
  • Check [Game Directory]\MelonLoader\Latest.log for errors
  • Ensure the mod DLL is in the Mods subfolder

No speech output

  • Verify a screen reader is running before launching the game
  • Check that Tolk.dll and NVDA DLLs are in the game root directory
  • Try NVDA (free) if other screen readers don't work: https://www.nvaccess.org/

Announcements are too fast/slow

  • Adjust speech rate in your screen reader settings
  • The mod uses brief pauses between announcements to prevent overlap

Duplicate announcements

  • The mod has built-in cooldown protection
  • If issues persist, check for conflicting mods

Known Limitations

  1. Visual-only elements (particle effects, animations) are not described
  2. Some complex combat mechanics may need inference from announcements
  3. Skill check minigames announce start but not the timing mechanism
  4. Tutorial notes and story text may require additional context

Support & Feedback

For issues, suggestions, or contributions:

  • Check game logs in MelonLoader\Latest.log
  • Report specific scenarios where announcements are missing or confusing
  • Suggestions for improving announcement clarity are welcome

Version History

v1.0.0 (Initial Release)

  • Full TOLK integration with screen reader support
  • Complete menu navigation announcements
  • Game state transitions
  • Combat and slot result announcements
  • Health, shield, and coin status updates
  • Enemy encounter information
  • Power-up, level, and equipment selection support

Credits

  • Accessibility Mod: Created for blind and visually impaired players
  • TOLK Library: By Davy Kager (https://github.com/dkager/tolk)
  • MelonLoader: Mod framework by LavaGang
  • Slots And Daggers: By the original game developers

License

This accessibility mod is provided free of charge to improve game accessibility. TOLK is licensed under LGPL v3.


Enjoy accessible gaming!

About

Accessibility mod for Slots And Daggers adding full Text-To-Speech for totally blind players.

Resources

Stars

Watchers

Forks

Packages