Spoken

Discord: https://spoken.quest/discord

Voiced dialogue, lore and text for World of Warcraft Forever. The other clients' code is still here, with no new work going into it.

Spoken is one download: Spoken itself and its three modules, Spoken Quests, Spoken Places and Spoken Readables. Each is a folder of its own, grouped under Spoken in the AddOns list. Spoken plays every line and owns the settings page, the minimap button, the queue and the narrator window or subtitles; each module reads one kind of text and has a page of its own under Spoken's settings. Every module comes installed. A player who does not want one switches it off on its card on Spoken's page, disables it in the AddOns list, or deletes its folder. The voice packs are separate downloads. Spoken_Developer, the debug log, is for developers and is not in the zip.

Folder	Addon	Voices	Voice packs
Spoken	Spoken	nothing itself: it plays every module's lines	—
Spoken_Quests	Spoken Quests	quest dialogue and NPC gossip	All, or Alliance · Horde · Shared · Gossip — or all in one from GitHub
Spoken_Readables	Spoken Readables	books, letters and other in-world texts	CurseForge · GitHub
Spoken_Places	Spoken Places	zone and subzone lore	CurseForge · GitHub
Spoken_Bosses	Spoken Bosses	the story of each dungeon and raid boss	CurseForge, in Places and Bosses · GitHub

make package-spoken builds the download, Spoken-<version>.zip, with every module built by its own packager. A module's voice pack holds its recordings; the module has nothing to play without one, and the pack does nothing without the module.

The sound packs are not on Wago. Each is 280 to 452 MB and Wago's upload endpoint refuses a file this size, so a pack comes from CurseForge or from a GitHub release, one tag per pack, <pack>/vX.Y.Z. English quests are the four split packs on CurseForge, and the same four in one quests-audio zip on GitHub. scripts/audio-github-release.sh cuts the release from the machine that built the audio, since the audio is outside git and no runner can rebuild it.

On the stores, spoken is Spoken and ships the zip above, and spoken-english is a meta addon that pulls in Spoken and every English voice pack. spoken-quests, spoken-zones and spoken-books are retired. Each has a page in publishers/ that says so. The module folders were SpokenQuests, SpokenZones and SpokenBooks until 3.0.0-beta.3, and those names belong to the retired projects, so the modules moved to Spoken_Quests, Spoken_Places and Spoken_Books; Spoken_Books has since become Spoken_Readables. The voice packs name Spoken as their dependency. Folders an older release left behind (SpokenPlayer, VoiceOverRedux, ZoneLore, and a full old copy of a module under its old name) are found at login, and the player is asked to delete them.

What players see

Narrator styles. Spoken shows a line in one of four ways, five with DialogueUI, chosen on the Spoken settings page or in the welcome window on first login:

• Subtitles Only, the default unless DialogueUI is installed: the speaker's name and the words low in the middle of the screen over a soft shadow, at most four lines at a time. A longer line turns its pages as the voice reaches them, one fading out before the next fades in. The words show whole, with the word being read lit; Type Words Out in the settings types them in instead, a little ahead of the voice. Stop or Replay, skip and Report appear on hover.
• Small Window (Minimal Classic): a round portrait, the speaker's name and the title (a slim progress bar under them with Show Progress Bar on), with the controls and the queue on interaction. See docs/minimal-classic/.
• Large Window: the game's Talking Head frame where the client has its art: a bigger portrait, with the speaker's name, the words, the controls and a count of the lines waiting beside it in one box.
• DialogueUI, offered only with the DialogueUI addon installed: a smaller twin of its quest window, in its own parchment or dark art. See docs/spoken/PLAYER-STYLES.md.
• Voice Only: nothing on screen.

The windows can show the words as caption lines too, with the words being read lit in gold (Highlight Words, on by default); see caption controls. Word timing is an estimate, because the recordings do not mark where each word falls. The subtitles light a word only while Highlight Words is on and Type Words Out is off, since a word lit as it is typed shows every miss.

Languages. Menus, settings and messages follow the game's text language: English, German, Spanish, French, Korean, Brazilian Portuguese, Russian and both Chinese scripts. The language the voices speak is a separate choice, Voice Language on Spoken's page: Auto follows the game, and a language is heard only when its voice pack is installed.

This is the beginning of the README. Read the rest at the original. Read the full README ↗