> For the complete documentation index, see [llms.txt](https://frostember-studios.gitbook.io/frostspeech-tts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://frostember-studios.gitbook.io/frostspeech-tts/readme.md).

# Welcome

Welcome to the comprehensive documentation for **FrostSpeech TTS**. This guide covers everything from basic Editor usage to advanced runtime API scripting.

{% hint style="info" %}
WE STRONGLY RECOMMEND TRYING THE DEMO SCENE WHILE READING THE DOCUMENTATION TO BETTER UNDERSTAND THE CONTEXT
{% endhint %}

### Getting Started

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-fire">:fire:</i></h4></td><td><strong>Core Concepts &#x26; Engines</strong></td><td><em>FrostSpeech TTS operates by wrapping three distinct Text-to-Speech engines. Understanding their differences is crucial for choosing the right tool for your project.</em></td><td><a href="/files/BHjaAsN1wqHbYsCNsYdQ">/files/BHjaAsN1wqHbYsCNsYdQ</a></td><td></td><td><a href="/pages/7FvWQMF0kTK7HGhlQfmo">/pages/7FvWQMF0kTK7HGhlQfmo</a></td></tr><tr><td><h4><i class="fa-leaf">:leaf:</i></h4></td><td><strong>Editor Setup &#x26; Workflow</strong></td><td><p><em>Navigate to <code>Tools > Frostember Studios</code></em></p><p> <em><code>> FrostSpeechTTS</code>.</em></p></td><td><a href="/files/USInQi2AJ0aPntlgXhL4">/files/USInQi2AJ0aPntlgXhL4</a></td><td></td><td><a href="/pages/QPzbTvC6XsT5gERiU43E">/pages/QPzbTvC6XsT5gERiU43E</a></td></tr><tr><td><h4><i class="fa-star-exclamation">:star-exclamation:</i></h4></td><td><strong>Understanding the Generation Settings</strong></td><td><em>Depending on the engine selected, different sliders will appear to fine-tune the output.</em></td><td><a href="/files/v7ZAJg1orbp5DzcH9WT1">/files/v7ZAJg1orbp5DzcH9WT1</a></td><td></td><td><a href="/pages/i73g4LZQanoLj7XtSO18">/pages/i73g4LZQanoLj7XtSO18</a></td></tr><tr><td><i class="fa-markdown">:markdown:</i> </td><td><strong>Using the Profile System</strong></td><td><em>If you are developing a game with multiple characters, you want their voices to sound consistent every time you generate a new line. <strong>FrostSpeechTTSProfiles</strong> solve this.</em></td><td><a href="https://images.unsplash.com/photo-1511367461989-f85a21fda167?crop=entropy&#x26;cs=srgb&#x26;fm=jpg&#x26;ixid=M3wxOTcwMjR8MHwxfHNlYXJjaHwxfHxwcm9maWxlfGVufDB8fHx8MTc3Mzg1MTcwMnww&#x26;ixlib=rb-4.1.0&#x26;q=85">https://images.unsplash.com/photo-1511367461989-f85a21fda167?crop=entropy&#x26;cs=srgb&#x26;fm=jpg&#x26;ixid=M3wxOTcwMjR8MHwxfHNlYXJjaHwxfHxwcm9maWxlfGVufDB8fHx8MTc3Mzg1MTcwMnww&#x26;ixlib=rb-4.1.0&#x26;q=85</a></td><td></td><td><a href="/pages/AD9lDCmpddI5WAY92HgG">/pages/AD9lDCmpddI5WAY92HgG</a></td></tr><tr><td><i class="fa-arrow-down-9-1">:arrow-down-9-1:</i></td><td><strong>C# Scripting API (FrostSpeechAPI)</strong></td><td><em>The <code>FrostSpeechAPI</code> class allows you to generate audio entirely via code. This is incredibly powerful for custom Editor tools, dialogue importers, or runtime procedural generation.</em></td><td><a href="/files/khIpFFK58K2bOSRIAbJt">/files/khIpFFK58K2bOSRIAbJt</a></td><td></td><td><a href="/pages/scPRmf2UHNygzfDCY7Iu">/pages/scPRmf2UHNygzfDCY7Iu</a></td></tr><tr><td><i class="fa-map-location">:map-location:</i></td><td><strong>Best Practices &#x26; Troubleshooting</strong></td><td></td><td><a href="https://images.unsplash.com/photo-1641531105535-1ead3c1784ab?crop=entropy&#x26;cs=srgb&#x26;fm=jpg&#x26;ixid=M3wxOTcwMjR8MHwxfHNlYXJjaHwxfHxiZXN0JTIwcHJhY3Rpc2V8ZW58MHx8fHwxNzczODUxNzI2fDA&#x26;ixlib=rb-4.1.0&#x26;q=85">https://images.unsplash.com/photo-1641531105535-1ead3c1784ab?crop=entropy&#x26;cs=srgb&#x26;fm=jpg&#x26;ixid=M3wxOTcwMjR8MHwxfHNlYXJjaHwxfHxiZXN0JTIwcHJhY3Rpc2V8ZW58MHx8fHwxNzczODUxNzI2fDA&#x26;ixlib=rb-4.1.0&#x26;q=85</a></td><td></td><td><a href="/pages/6b1YRtQKzZ6H7qMKCpJS">/pages/6b1YRtQKzZ6H7qMKCpJS</a></td></tr><tr><td><i class="fa-location-crosshairs">:location-crosshairs:</i> </td><td><strong>Roadmap</strong></td><td><em>Project Roadmap</em></td><td><a href="https://images.unsplash.com/photo-1531403009284-440f080d1e12?crop=entropy&#x26;cs=srgb&#x26;fm=jpg&#x26;ixid=M3wxOTcwMjR8MHwxfHNlYXJjaHw1fHxyb2FkbWFwfGVufDB8fHx8MTc3MzczOTMxMnww&#x26;ixlib=rb-4.1.0&#x26;q=85">https://images.unsplash.com/photo-1531403009284-440f080d1e12?crop=entropy&#x26;cs=srgb&#x26;fm=jpg&#x26;ixid=M3wxOTcwMjR8MHwxfHNlYXJjaHw1fHxyb2FkbWFwfGVufDB8fHx8MTc3MzczOTMxMnww&#x26;ixlib=rb-4.1.0&#x26;q=85</a></td><td></td><td><a href="/pages/2xHK37pgVG8sKLEZ46P7">/pages/2xHK37pgVG8sKLEZ46P7</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://frostember-studios.gitbook.io/frostspeech-tts/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.