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

# Threadlink Framework

![Powered by Threadlink. Weaving worlds together.](https://579206401-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbyEfhDDFuvtAe6OHvveB%2Fuploads%2Fgit-blob-d4515b089d21b383601afff9cd84facc4a91f6b1%2Fthreadlink-banner.png?alt=media)

**Threadlink** is a modular runtime framework for Unity. It provides a core that deploys itself; subsystems for events, time, scenes, input and UI, audio and platform services; type-safe identifiers; a data container for designers; and deterministic maths for reproducible simulation.

This manual covers the runtime, the editor tools and the authoring workflow of **Threadlink 6.6**.

## Organisation

Threadlink separates authored data from code. The manual follows suit: a designer volume and an engineer volume, built on shared foundations.

| Part                                                                           | Audience        | Contents                                                                                                                                                              |
| ------------------------------------------------------------------------------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Getting Started](/threadlink-documentation/getting-started/requirements.md)   | All             | Requirements, installation and first-time project setup.                                                                                                              |
| [Foundations](/threadlink-documentation/foundations/purpose.md)                | All             | Framework purpose, project layout, assembly topology, deployment overview.                                                                                            |
| [Designer Reference](/threadlink-documentation/designer-reference/designer.md) | Content authors | Identifiers, Vaults, spatial audio, input prompts, tuning and content registration. No C# needed.                                                                     |
| [Engineer Reference](/threadlink-documentation/engineer-reference/engineer.md) | Programmers     | Architecture, deployment, subsystem APIs, the PlayerLoop, Sentinel, deterministic and memory tools, code generation, custom subsystems, editor tools and performance. |
| [Reference](/threadlink-documentation/reference/iris-events.md)                | All             | Native Iris events, service access, identifier domains, menus and asset-creation entries, terminology.                                                                |

Both volumes describe the same systems from opposite ends. Where the designer volume says *"declare the identifier in `Vault.Fields.User.txt`"*, the engineer volume explains the pipeline that generates `ThreadlinkIDs.Vault.Fields`, the manifest that keeps its values stable, and the API that reads it.

> API names, identifiers, menu paths, file paths and asset-creation entries are taken from the framework source. Systems that are stubbed or in development are marked as such.

## Where to start

* **New to Threadlink:** [Requirements](/threadlink-documentation/getting-started/requirements.md), then [Installation and Project Setup](/threadlink-documentation/getting-started/installation.md), then [Purpose](/threadlink-documentation/foundations/purpose.md).
* **Designers:** [The Identifier Workflow](/threadlink-documentation/designer-reference/identifiers.md) and [The Vault](/threadlink-documentation/designer-reference/vault.md).
* **Engineers:** [Architecture](/threadlink-documentation/engineer-reference/architecture.md), [Deployment and Initialisation](/threadlink-documentation/engineer-reference/deployment.md) and [Iris](/threadlink-documentation/engineer-reference/iris.md).

***

*Threadlink Framework — Reference Manual. Developed and maintained by Threadforge.*

*Lead Developer: George Rontoulis*