Yapper
TTS Accessibility Utility for WEBFISHING.
Last updated | a month ago |
Total downloads | 1018 |
Total rating | 1 |
Categories | Mods Client Side |
Dependency string | Macroplastics-Yapper-1.0.0 |
Dependants | 2 other packages depend on this package |
This mod requires the following mods to function
README
Yapper - by Awesomerly & Sulayre
Yapper is an accessibility mod for Webfishing that integrates text-to-speech into the game. It can read out dialog, chat messages, and UI elements (with a hotkey). It uses the very useful godot_tts library by bruvzg to talk to the Microsoft Speech API.
Installation instructions
If you're using a mod manager for Webfishing, you can search for Yapper and click install. Otherwise, make sure that GDWeave is working. Then, drag the zip file from the releases tab into your GDWeave/mods folder, and do the same for Yapper's dependencies:
- LucysLib - for BBCode stripping
- BlueberryWolfi.APIs - For keybinds
- Tacklebox - A convenient ingame mod menu/config API
How to use
Yapper adds a settings page accessible from the main menu that allows you to change various voice parameters (pitch, speed, volume), and change the voicebank. This settings menu has multiple checkboxes for enabling and disabling various sources of TTS input. By default, chat is disabled because it may be undesireable to read out chat messages for people who need TTS for gameplay reasons.
Yapper also adds a hotkey to the settings to read out UI elements and tooltips, which is bound to R by default. To read out extended tooltip descriptions, hold SHIFT while pressing the hotkey.
Building Yapper
We use NotNite's manifestation to package and test Yapper. It builds the C# dll and Godot .pck files and arranges folders to allow for easy distribution of mods. It can also optionally copy the built mod to your mods directory. Running manifestation is as simple as manifestation ./manifestation.toml -copy
. For more info, check out manifestation's README.
Credits
- Awesomerly, Sulayre - Main developers
- ZeaTheMays - Logo design