You are viewing a potentially older version of this package. View all versions.
Lirin-Hades_2_TOLk_Compatibility-1.0.2 icon

Hades 2 TOLk Compatibility

Integrates TOLk screen-reader into Hades 2

Date uploaded 2 days ago
Version 1.0.2
Download link Lirin-Hades_2_TOLk_Compatibility-1.0.2.zip
Downloads 3
Dependency string Lirin-Hades_2_TOLk_Compatibility-1.0.2

This mod requires the following mods to function

Hell2Modding-Hell2Modding-1.0.28 icon
Hell2Modding-Hell2Modding

Lua Mod Loader for Hades 2

Preferred version: 1.0.28
SGG_Modding-ENVY-1.0.1 icon
SGG_Modding-ENVY

A plugin to allow ReturnOfModding plugins greater control of their environment.

Preferred version: 1.0.1
SGG_Modding-Chalk-2.0.2 icon
SGG_Modding-Chalk

System for handling config files in ReturnOfModding

Preferred version: 2.0.2
SGG_Modding-ReLoad-1.0.1 icon
SGG_Modding-ReLoad

Provides helpers for managing hot reloading and waiting for the right time to load

Preferred version: 1.0.1
SGG_Modding-SJSON-1.0.0 icon
SGG_Modding-SJSON

A plugin for handling .sjson files in ReturnOfModding.

Preferred version: 1.0.0
SGG_Modding-ModUtil-3.1.0 icon
SGG_Modding-ModUtil

Utility mod for mod interactions within lua for SGG's games

Preferred version: 3.1.0

README

Hades 2 TOLk Compatibility

NOTE: With full respect for Erumi321 an original author. I've just grab the mod and continued the work on it adding / fixing stuff.

Without this amazing developer that wouldn't be so easy to do.

Hades II mod which is a dependency of accessibility mods, using H2M we implement a screen reader through TOLk, one which replaces many of the icons in the game with the text they actually represent.

Features

  • On Mousing over a button, the text within the button is read
  • Icons within text are replaced by corresponding text [respects localization in most cases] (ie the Magick symbol is replaced by the word "Magick")

Install

  • Download off of thunderstore

CHANGELOG

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

2.0.0 - 2025-11-05

Added

  • Configuration system with four new options:
    • PopupAnnouncements.ReadInteractPrompts (default: true) - Toggle reading of interact prompts
    • PopupAnnouncements.ReadDamageNumbers (default: false) - Toggle reading of damage numbers
    • Voicelines.ReadDialogues (default: true) - Toggle reading of dialogue lines
    • Voicelines.ReadNonDialogue (default: true) - Toggle reading of non-dialogue voicelines
  • Non-dialogue voiceline reader with proper timing support
  • Combat popup announcements (damage numbers and interact prompts)
  • Critical hit detection - prepends "Crit" to damage numbers containing "!"
  • Banner message reader for info banners
  • Dialogue reader with speaker name and title/epithet support
  • Trade screen prompt reader with complete item exchange information
  • Simple prompt screen reader for title and description
  • Quest Log (Book of Fates) enhancements:
    • Quest descriptions now read by screen reader
    • Reward information (amount and resource name) displayed
  • Silver Pool (Weapon Shop) enhancements:
    • Cost information for unpurchased items
  • Talent Screen (Path of Stars) major enhancements:
    • Status announcements: "On", "Off", "Locked", "On, Queued"
    • Cost display for available talents
    • Full trait descriptions with stat details
    • Icon path to text conversion in descriptions
  • Book of Shadows (Codex) enhancements:
    • Entry descriptions now read by screen reader
    • Gift count tracking (e.g., "Gifts given 3 of 6")
  • Advanced icon path to text conversion system
    • Handles both @GUI\Icons\ and @gui/icons/ path formats
    • Supports Health, Gold, Magick, Armor, Attack, Speed and many more icons

Changed

  • Namespace changed from erumi321 to Lirin
  • Website URL updated to https://github.com/Lirin111/Hades2TolkCompatability
  • Text processing now handles icon paths in descriptions and tooltips
  • Dialogue system now extracts speaker names from voice cue references
  • Updated dependency versions for compatibility with latest modding framework

1.0.2 - 2024-07-11

Fixed

  • (s) now just reads as s, shortening time to read some phrases

1.0.1 - 2024-06-13

Added

  • Main menu has same text processing as the rest of the game

Fixed

  • Main menu now reads text (again)

1.0.0 - 2024-06-12

Fixed

  • No longer stutters when format or "icon" is in text

0.1.2 - 2024-05-27

Fixed

  • Icon typo

0.1.1 - 2024-05-23

Removed

  • Small print line

0.1.0 - 2024-05-23

Added

  • Added TOLK reader and icon replacement