Audio Extension
Official compatibility
| Element | Reference |
|---|---|
TypeWriter | Required. Use the official TypeWriter release supported by the extension release. |
| Related extensions | Install the related extensions listed on this page before using entries that depend on them. |
Elevate immersion with dynamic sound profiles and granular control over every character and effect.
The Audio Extension transforms the way sounds are handled in Typewriter. It moves beyond simple sound play commands to provide a comprehensive audio framework. Whether you're building cinematic cutscenes or interactive NPC dialogues, the Audio Extension gives you the tools to create professional-grade acoustic experiences.
[!TIP] Use this extension in conjunction with the Dialogue Extension to create NPCs that "speak" with distinct, procedurally generated audio voices.
- Configuration — Define granular audio profiles for dynamic dialogue sounds.
- Integration — Natively compatible with Typewriter's cinematic and dialogue engines.
Key Features
- Granular Audio Profiles: Define unique sound signatures for letters, punctuation, and spaces to create procedural "voices".
- Dynamic Pitch Variance: Emotional jitter and variance to prevent audio fatigue and add character personality.
- Ambient Soundscapes: Tools for managing complex, layered environmental audio (Under Development).
- Packet-Based Control: Precise control over sound timing and delivery using high-performance network packets.
Commands & Permissions
Permissions
| Permission | Description |
|---|---|
typewriter.audio.admin | Grants access to administrative audio configuration tools. |
Placeholders
| Placeholder | Description |
|---|---|
%typewriter_audio_profile% | Returns the ID of the current active audio profile for the player. |
Dependencies
| Extension | Usage |
|---|---|
| BTC Core | Mandatory. Core engine required for all functionality. |
| Dialogue | Recommended for NPC voice implementation. |
User guide
- Create a
granular_audio_profileand define the sounds used for letters, punctuation, and spaces. - Use that profile from dialogue or cinematic content when the Dialogue extension is installed.
- Test a short sentence with
typewriter.audio.adminonly for administrative configuration, then verify the result with a regular player. - Add pitch variations and ambient layers after the basic profile works, keeping a simple profile available for troubleshooting.
The Audio extension does not require one entry per sound. The profile is the central entry; its exact fields are documented on the related entry page.
Troubleshooting
The extension is not visible
Check that the installed release matches the supported TypeWriter release and that the related extensions listed in the compatibility section are present.
An entry is missing
In the Typewriter Web panel, use the Search bar or the + button to find or create the entry with its exact identifier. Entry IDs and field names are case-sensitive; do not translate them.
The entry saves but nothing happens
Check that the entry is connected to the trigger, command, objective, event, or menu interaction required by its type. Test with optional permissions and criteria removed, then add them back one at a time.
An integration does not work
Verify the dependency and version shown in the extension card, then check the server log for the first error. Do not replace a missing dependency with a similarly named plugin unless the extension source explicitly supports it.