Lore Narrator

Overview
Tired of reading Lore Books? Want to know more about the story but reading all the books is so time intensive?? Time that you would rather spend logging trees??!! Then this Mod is for you. Just open the book, walk away and let the lore be poured into your ears while you squash some Kebbits and roast them over the fire.

The narration is based on a Text-To-Speech algorithm with open-source speech samples used for voice cloning.

Installation

• Install UE4SS (link in Requirements), Download the Mod 
• Extract the contents of the archive to your RuneScape game installation directory (like "C:\Program Files (x86)\Steam\steamapps\common\RSDragonwilds").
• Launch the game and the mod will begin playing audio when opening a lore book.

Installation via the Mod Manager should also be possible (not tested).

Open Source
This Mod's source is available on GitHub, see https://github.com/Z0XW1L/RSDragonwilds-Lorebook-Narrator

Features

• Audio Narration - All lore books should be narrated. Some items that are not directly lore books (like these 3 stones in Fellhollow) are not narrated currently.
• Voices
•   MedievalSpeech (LoreNarratorMod_MedievalSpeech_Male_En_vXX)
•   Asya Anara (LoreNarratorMod_AsyraAnara_Female_En_vXX)
• Audio queue management - Prevent overlapping audio playback when visiting multiple locations in quick succession or reopening books
• Configurable Settings - Want to adjust some parameters to your liking? See Feature Details below
• Adjustable Volume - Narrator too loud? Configure the volume in the settings.
• Proximity Based Playing - Play the lore when being near to a lore book without opening it (disabled by default)

Feature Details
Below will be a more detailed description of what a feature does and how it can be used.

Settings
You can change the default settings by creating a new file "settings.lua" that you need to store alongside the main.lua, so e.g. "C:\Program Files (x86)\Steam\steamapps\common\RSDragonwilds\RSDragonwilds\Binaries\Win64\ue4ss\Mods\LoreNarratorMod\Scripts\settings.lua"

Contents of the settings file for example:

return {
    volume = 1.0, -- e.g. 1.0 = full volume, 0.5 = half volume, 0.0 = muted
    playWhenNearLore = false, -- true enables proximity based playing, false disables it
    searchDistance = 500.0, -- lore scanning distance in Unreal units
    checkIntervalSeconds = 3.0, -- how often to check for nearby lore - only matters if playWhenNearLore = true
    debug = false, -- prints debug messages if true. Leave it false if not needed to avoid overhead
}

Proximity Based Playing
This enables you to start the narration when you are close to a lore book without having to open it. This feature is disabled by default and you need to change the settings to enable it. Once it is enabled it will work like this: You get close to a lore book, it will narrate it. The book will then not be narrated again until you come close to another lore book, which is then narrated (so in case you walk back and forth a single book, it will not be played all the time). When you then would return to the first book, it would be narrated again.

You can enable this feature by setting "playWhenNearLore = true". The "searchDistance" should be a bit more than 500.0, like 1000.0.

Credits

• The narration has been done with coqui-ai-TTS
• The narration is based on voice clones from
•   MedievalSpeech.wav by tekgnosis -- https://freesound.org/s/144862/ -- License: Creative Commons 0
•   Asya Anara -- https://huggingface.co/coqui/XTTS-v2

This mod is also available on https://www.nexusmods.com/runescapedragonwilds/mods/178