Voice Framework (Regent Mesugaki Voice)

YouTube: 5F-MxO9L4Co

VoiceModFramework

A character voice playback framework for Slay the Spire 2. Supports Regent's Mesugaki voice by default!
This mod was originally "Regent Mesugaki Voice", but the voice playback system has been greatly expanded, so it has been reborn as a framework!
It automatically plays character voices in conjunction with various in-game events and displays subtitles in speech bubbles.

No DLL is required to add voice packs. Simply place a JSON file containing "voicepack" in its name (e.g., Test_voicepack.json) and the audio files (mp3 or ogg) to enable the voice for the corresponding character. When other modders release their own character voice packs, they only need to depend on this framework.

!!!NOTICE!!!
The requirement has been changed from ModConfig to RitsuLib
Baselib is no longer required
As there have been quite a few changes, there may be some bugs...

V1.13 New Features
Reported bug fixes
Added triggers for orb acquisition and activation
Added triggers for minion summoning
Improved the voice playback system for multiplayer (this has not been tested as I do not have any friends who own StS2)
Added a feature to manage the total amount of speech during multiplayer sessions
Modified the system to detect voice packs downloaded from the Steam Workshop
Migration from ModConfig to RitsuLib
Changes have been made to allow multiple voice packs to be registered for a single character so that they can be switched between

Note: Although a ‘Minion’ folder is created when generating a template, voices placed in this folder will not play at present. This feature is currently under development.

Features

Zero-Configuration Voice Packs — Automatic detection and registration just by placing voicepack.json and audio files. No DLL required on the voice pack side.
Over 40 Automatic Triggers — Card usage, HP damage (unblocked/piercing), full block, buff acquisition, debuff application, star acquisition, enemy defeat, combat start/victory/defeat, low HP (once per combat), idle (during player turn), potion usage, card upgrade, shop purchase, treasure chest, etc.
Card-Specific Voices — Add a card_{CardID}/ folder to play exclusive voices for that specific card.
Subtitle Display — Speech bubble overlay with character icons. Supports Japanese, English, Simplified Chinese, and Korean.
Vanilla Bubble Mode — Option to use the game's original overhead speech bubbles (NSpeechBubbleVfx).
Custom Fonts — Specify .ttf / .otf fonts per language to correctly render Japanese, Chinese, Korean, and other texts.
Speech Bubble Image Replacement — Replace native bubble sprites with custom images (PNG/JPG/WEBP).
Rich Text Support — Subtitle JSON allows Godot 4 BBCode tags (bold, color, wave, shake, rainbow, etc.).
Typewriter Effect — Displays text character by character. Speed can be set in cps (characters per second). Does not work in Vanilla Bubble Mode.
Audio Caching & Consecutive Playback Prevention — Pre-decodes files at the start of a run. Prevents the same file from the same folder from playing consecutively.
In-Game Settings — Volume (dB), trigger probability (%), category-specific ON/OFF, idle trigger delay (seconds), subtitle position (choose from four corners), scale, fade time, etc.

Installation

1. Place the VoiceModFramework folder into the game's mods/ directory.
    If you have "Regent Mesugaki Voice" installed, please delete it.
2. Launch the game. All mod folders will be scanned automatically, and voice packs containing voicepack.json will be auto-loaded.

No additional setup is required. Various settings can be changed from the in-game Mod settings panel.

How to Create a Voice Pack (Simplified Version)

Can be published without any DLLs.

1. Create a folder inside mods/ (e.g., MyCharacterVoice/).Create a JSON file containing "voicepack" in its name (e.g., voicepack.json) and write the following:{"character_id": "Character_ID","voices_dir": "voices"}Place audio files (.ogg or .mp3) into category subfolders:voices/card/          ← Plays on any card usedamage/        ← On taking HP damagecombat_start/  ← On combat startvictory/       ← On victory...Launch the game, and it will be automatically detected and enabled during runs with the target character.

You can also do this automatically from the in-game ModConfig menu! Please execute it after entering the combat screen with the character you want to apply it to.

Character IDs can be verified via Settings → VoiceMod → Utility → Export character_ids.json.

For advanced features like font replacement, speech bubble image replacement, rich text, and API hooks, please refer to the [Modder's Guide (Work in Progress)].

For Other Modders (DLL-Based Registration)

For mods with a DLL, you can register directly from ModEntry.Init():

VoiceModApi.Register(new VoicePackConfig
{
CharacterId   = "MYCHARACTER",
VoicesDir     = Path.Combine(modDir, "voices"),
SubtitleDir   = Path.Combine(modDir, "voices"),
IconPath      = Path.Combine(modDir, "icon.png"),
SubtitleColor = "#FFCC88",
});
You can also trigger voices from your own Harmony patches:

VoiceModApi.PlayCurrentPackVoice("my_custom_category");*Not fully tested, so not sure if it works perfectly. Please report any bugs.
Refer to the [Modder's Guide] for details.

Feel free to create and publish voice packs that depend on this framework. No credit is required, but it would be appreciated!

Recommended Mods: 

• Regent Skin Mod by anaertailin

• Regent Cards Anime Rework by DoublePigeon

fun Mesugaki the Spire

V1.12 Update
Fixed an issue where KO and CN subtitles were not displayed during non-combat phases (such as map movement, shops and rest areas).
I initially thought it was a subtitle issue, but the cause turned out to be a reference error in a function.