Connect Other Tools

Optional integrations are imported only when both tools are installed. The base package remains complete without them.

• Timeline for authored sequences.
• Input System for wait-for-input actions.
• Adventure Creator, Game Creator 2, Ink, Naninovel, Pixel Crushers, and Yarn Spinner for dialogue flow.
• Unity Localization for localized content.

UniText 3 for advanced Unicode shaping, bidirectional layout, fallback fonts, color glyphs, and animation without a TextMeshPro component.

UIEffect for TextMeshPro transitions that remain visible and follow animated text in Live Preview.

• Unity Visual Scripting and Game Creator 2 for events and triggers.
• LED Studio as an optional renderer.

PlayMaker 2 for typed FSM actions, callback waits, markers, and optional always-on event routing.

PrimeTween for whole-element UI Toolkit motion around Text Studio animated labels.

Integration installation model

Text Studio integrations are optional nested packages. Install Text Studio and the companion first, then import the matching integration package. Guarded assemblies compile only when their required package version or verified source symbol is present. Removing an integration must leave base Text Studio free of missing scripts and missing types.

One system should own content progression. Text Studio owns markup, reveal, effects, placement, presentation, and renderer output for the current line. The companion continues to own its narrative state, localization tables, timeline, UI lifecycle, board scheduling, or other domain behavior.

Integration	Requires	Companion owns	Text Studio owns
Input System	Input System 1.4.0+	Input actions and device bindings	Keyed wait and skip lifecycle
Timeline	Timeline 1.7.0+	Clip sequencing and playable time	External effect evaluation
Unity Splines	Splines 2.0.0+	Spline assets and knots	Text selection, effects, and placement dispatch
Unity Localization	Localization 1.0.0+	Tables, entries, and locale	Localized markup presentation
Visual Scripting	Visual Scripting 1.0.0+	Graph flow	Text commands, state, and events
Adventure Creator	Verified 1.86.2 source	Speech, menus, and narrative flow	Subtitle reveal and effects
Game Creator 2	Verified source package	Instruction and trigger flow	Text commands and callbacks
PlayMaker 2	2.0.0-beta.77 to <3.0.0	FSM state, input, variables, and event routing	Markup, reveal, effects, waits, and callbacks
Ink	Ink Unity Integration	Story state and choices	Line reveal and markup
Naninovel	Naninovel 1.21.0+	Script and printer flow	Revealable text presentation
Pixel Crushers	Dialogue System 2.2.70	Conversation and panel lifecycle	Subtitle reveal and effects
Yarn Spinner	Yarn Spinner 3.2.4+	Dialogue execution and options	Standard presenter, reveal, and markup
LED Studio	LED Studio 1.0.0+	Board scheduling and scrolling	Animated text capture
PrimeTween	com.kyrylokuzyk.primetween	Whole-element motion and opacity	Glyph markup, reveal, motion, and color
UIEffect	UIEffect 5.0.0+	UI proxy effects and transitions	Animated TMP mesh source
UniText 3	3.0.0-pre.6 to <4.0.0	Shaping, order, and fallback fonts	Semantic animation and presentation

Open Tools > Text Studio > Integrations to search the complete support catalog. Each card reports package, define, sample, selected-object, and setup readiness, then offers the relevant setup, fix, sample, or documentation action. Configure Selected is the fastest path when an integration needs components or serialized wiring on the current object.

The Integrations hub and Health Check use the same catalog. If one reports that a package or symbol is missing, resolve that readiness issue before debugging the runtime scene.

Input System

Requires Input System 1.4.0 or newer. The guarded TextStudio.InputSystem assembly supplies keyed input through InputActionReference mappings. Map project names such as submit or next, optionally auto-enable the actions, and use the same key in <waitForInput input=submit timeout=5>. The wait resumes on the mapped action, timeout, or cooperative skip. Missing mappings should fall back deliberately or produce a setup warning.

Timeline

Requires Timeline 1.7.0 or newer. Blendable reveal and effect clips drive Text Studio from Timeline time while ordinary markup effects remain active underneath. Add Text Studio Control markers for one-shot text changes, reveal, waits, events, disappearance, and effect commands without creating a clip for each cue. Overlaps respect effective weights and remain stable while scrubbing, pausing, seeking, or playing in reverse. Use Timeline for authored cinematic timing and the component API for gameplay-driven effects.

Unity Splines

Requires Unity Splines 2.0.0 or newer. SplinePlacementProvider contributes a package-owned placement choice while Text Studio retains source, effects, timing, selection, serialization, and dispatch. The shipped showcase persists three editable spline containers and provider setups. Use this integration to arrange glyph origins along a scene-authored curve.

Unity Localization

Requires Unity Localization 1.0.0 or newer. TextStudioLocalizeString resolves a LocalizedString into Text Studio content and can restart reveal after a locale change. TextStudioLocaleSwitcher provides sample locale selection. Localized entries may contain Text Studio markup, but each locale must preserve valid tag structure and semantic ranges. Validate missing tables, missing entries, fallback fonts, RTL layout, and repeated enable or disable.

Unity Visual Scripting

Requires Unity Visual Scripting 1.0.0 or newer. The integration exposes curated units for show, set, append, clear, reveal, hide, waits, speed, progress, loop, state, and markers. TextStudioVisualScriptingEvents forwards shown, disappeared, marker, wait-started, and wait-finished events. Enable glyph events only when a graph truly needs their high-frequency callbacks. Wait units require a coroutine-capable graph root.

Adventure Creator

The verified source integration uses Adventure Creator 1.86.2 with the TEXTSTUDIO_ADVENTURE_CREATOR symbol. Add TextStudioAdventureCreatorSpeechBridge to the subtitle Canvas and route the visible line through TextStudioDialogueSource. Adventure Creator owns speech, menus, audio, translations, action lists, and final line advance. Text Studio owns the complete subtitle string, markup, reveal, effects, markers, glyph audio, and TMP output.

Do not let an AC MenuLabel write the same visible TMP field. Use TextStudioOwnsReveal for new projects. AdventureCreatorScrollSync exists for an established project that must mirror AC character progress through DriveRevealProgress. Run the setup validator and test speech start, complete, skip, repeated lines, and menu teardown.

GAME CREATOR 2

The Game Creator 2 integration supplies complete visual-scripting coverage for text, reveal, disappearance, effects, waits, events, speed, progress, callbacks, and state conditions. TextStudioGameCreator2EventRelay routes completion or markers into a local Trigger, while the optional Dialogue skin adapter keeps Game Creator actors, portraits, choices, and story timing intact and lets Text Studio remain the only visible subtitle writer.

PlayMaker 2

Requires PlayMaker 2 2.0.0-beta.77 or newer and below 3.0.0. Typed actions under Text Studio/PlayMaker 2 control content, reveal, hide, waits, effects, speed, state, and dialogue selection. State listener actions wait for Text Studio callbacks while their FSM state is active. Add TextStudioPlayMaker2EventRelay only when show, disappear, marker, wait, or optional per-glyph events must always reach one chosen FSM.

Open the Whisperwood demo and inspect Dialogue Director. Its parallel Dialogue Flow and Controls and Event Monitoring regions keep branching, input, variables, and event routing in PlayMaker while Text Studio owns markup, reveal, effects, waits, markers, and disappearance.

Ink

Install Ink Unity Integration, import the integration, add TextStudioInkStoryBridge next to TextStudioDialogueSource, assign compiled Ink JSON, and call StartStory. Ink owns story state, continuation, choices, and tags as narrative metadata. Text Studio owns the visible line, markup, reveal, effects, and continue-or-skip presentation. SaveStateJson and LoadStateJson let save slots, checkpoints, and scene transitions preserve the exact Ink story position without serializing Text Studio presentation state.

Bind choice buttons to ChooseChoiceAt(index). AdvanceOrSkip completes the current reveal but refuses to advance while choices are pending. Avoid raw Text Studio hexadecimal color tags in .ink source because Ink treats # as its tag syntax; use named colors or a verified escaping workflow.

Naninovel

Requires Naninovel 1.21.0 or newer. TextStudioNaninovelRevealableText implements the revealable-text target used by a Naninovel printer. The markup compiler and preprocessor translate compatible Naninovel markup and preserve source ranges. Naninovel owns script execution, printer visibility, authors, avatars, input indicators, and continue flow. Text Studio owns visual reveal, effects, and rendered text.

Pixel Crushers Dialogue System

The verified source workspace uses Dialogue System 2.2.70 and the TEXTSTUDIO_PIXEL_CRUSHERS symbol. Replace StandardUISubtitlePanel with TextStudioPixelCrushersSubtitlePanel and assign or colocate TextStudioDialogueSource. Pixel Crushers owns conversation state, panel lifecycle, portraits, response menus, accumulation, scrolling, sequencing, and final advance. Text Studio owns subtitle markup, reveal, effects, sounds, and skip.

Remove competing vendor typewriter behavior from the routed text. The bridge keeps the vendor subtitle mirror updated for accumulation and scroll checks while preventing duplicate reveal playback.

Yarn Spinner

Requires Yarn Spinner 3.2.4 or newer. Select Yarn's standard LinePresenter, open the Integrations hub, and use Configure Selected. Text Studio adds its dialogue source, custom TextStudioYarnTypewriter, and TextStudioYarnMarkupProcessor without replacing Yarn's presenter. Yarn keeps character names, fades, story flow, commands, options, localization, and advancement. Text Studio owns reveal, supported replacement markup, effect tags, timing, actions, markers, and TMP output. Hurry-up completes the current reveal; next-content dismisses the standard presenter so Yarn can continue.

LED Studio

Requires Text Studio 1.0.1 and LED Studio 1.0.0 or newer. LedTextStudioRenderBackend is both a Text Studio renderer and external source bridge for LED Studio. LED Studio owns source scheduling, scrolling, seamless wrap, blinking, and board updates. Text Studio owns markup processing, reveal, effects, placement, presentation, and formatting. The bridge captures the final animated TMP surface into the LED board without reimplementing glyph animation math.

PrimeTween

Install PrimeTween from com.kyrylokuzyk.primetween, then import the Text Studio PrimeTween integration. The shipped UI Toolkit sample attaches Text Studio to ordinary Label elements while PrimeTween moves, rotates, scales, and fades the containing card. Keep glyph markup, reveal, motion, and color in Text Studio; keep whole-element transforms and opacity in PrimeTween.

Unity 2022.3 through 6000.1 uses UI Toolkit Basic mode, where markup, typewriter reveal, actions, events, and PrimeTween element animation remain available. Unity 6000.2 and newer uses Full Parity mode and also applies Text Studio per-glyph motion and color to native text vertices.

UIEffect

Requires UIEffect 5.0.0 or newer and TextMeshProUGUI. Text Studio writes the animated TMP vertices, then the integration marks UIEffect's proxy mesh dirty after upload. The next Canvas rebuild consumes the current animated mesh, including UIEffect transition coordinates and expanded geometry, without creating a TMP regeneration loop. Validate both Raw and Live Preview with an active UIEffect transition.

UniText 3

Requires UniText 3.0.0-pre.6 up to, but not including, 4.0.0. TextStudioUniTextBackend lets UniText own shaping, fallback fonts, bidirectional visual order, ligatures, decorations, and generated glyph geometry while Text Studio owns semantic markup, reveal, effects, placement, and presentation.

The adapter publishes shaped glyph IDs, clusters, advances, font data, visual order, source colors, decorations, and metrics through renderer-neutral contracts. Use it for Arabic, Hebrew, mixed scripts, ligatures, fallback fonts, and other content where simple character-to-glyph assumptions are insufficient. Text Studio 3D can consume the same shaped-glyph contract when its separate sample package is installed.

Integration capability checklist

• Confirm both products and the integration package are installed in the documented order.
• Confirm the guarded integration assembly is present and the base package still compiles when it is absent.
• Assign exactly one source owner and one visible renderer owner.
• Exercise show, reveal, skip, wait, completion, interruption, disable or enable, and repeated-use paths.
• Open the shipped sample or setup scene and compare its serialized wiring with the production scene.
• Record the installed companion version and include it with support requests.