![GreenBean-LethalSpeechOutput icon](https://gcdn.thunderstore.io/live/repository/icons/GreenBean-LethalSpeechOutput-1.0.0.png.128x128_q95.jpg)
LethalSpeechOutput
A mod for Lethal Company that allows mod developers to provide speech output to the NVDA screen reader.
By GreenBean
Last updated | 6 months ago |
Total downloads | 165 |
Total rating | 1 |
Categories | Tools Misc Client-side |
Dependency string | GreenBean-LethalSpeechOutput-1.0.0 |
Dependants | 0 other packages depend on this package |
README
Lethal Speech Output
Overview
Lethal Speech Output is a straightforward and easy-to-implement mod designed to provide speech output to the NVDA (NonVisual Desktop Access) screen reader.
Usage
- Call the
SpeakText
function followed by the string to be spoken. You can useLSO
to call to the function by default.
Example:
LSO.SpeakText("Great asset to the Company.");
- ForceLogSpeech: You can set the
ForceLogSpeech
variable toTRUE
to log all speech output, regardless of whether NVDA is opened or not. Useful for debugging without having to install NVDA.
Guidelines
- Avoid placing the
SpeakText
function in areas of your code that trigger frequently, such as inside ofUpdate()
. This can lead to excessive speech output, spamming the user. If you need to use it in such areas, ensure you have a system in place to prevent spamming the screen reader.