# Start Here

[**Yarn Spinner**](https://yarnspinner.dev) **is a set of friendly tools for writing interactive narratives and games.**

Try Yarn Spinner online at [try.yarnspinner.dev](https://try.yarnspinner.dev)!

Yarn Spinner is easy for writers to use, but also has powerful features for programmers, game designers, narrative directors, producers, and more.

Try Yarn Spinner online at [https://try.yarnspinner.dev](https://try.yarnspinner.dev/)

Yarn Spinner is used in thousands of amazing games, including Rift of the Necrodancer, Demonschool, [Night in the Woods](http://nightinthewoods.com), [A Short Hike](https://ashorthike.com), [Lost in Random](https://www.ea.com/en-au/games/lost-in-random), [Dredge](https://www.dredge.game), [Frog Detective](https://frogdetective.net), [Button City](https://www.buttoncitygame.com), [Escape Academy](https://escapeacademygame.com/en), [Baladins](https://www.baladinsgame.com), and [Unbeatable](https://www.unbeatablegame.com).

<table data-view="cards" data-full-width="false"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden><select></select></th><th data-hidden></th></tr></thead><tbody><tr><td><strong>New? Start Here!</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-7dfab4f80b5d20989666e7ea87c0fdad209378d3%2FTry.png?alt=media">Try.png</a></td><td><a href="write-yarn-scripts/start-here">start-here</a></td><td></td><td></td></tr><tr><td><strong>Scripting Fundamentals</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-41005e8618e13ff79e251356edd08bf6a1715c7a%2FSyntax.png?alt=media">Syntax.png</a></td><td><a href="write-yarn-scripts/scripting-fundamentals">scripting-fundamentals</a></td><td></td><td></td></tr><tr><td><strong>Advanced Scripting</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-354b051b944714a37a6f9140592b6a814259804c%2FAdvanced.png?alt=media">Advanced.png</a></td><td><a href="write-yarn-scripts/advanced-scripting">advanced-scripting</a></td><td></td><td></td></tr><tr><td><strong>Yarn Spinner for Unity</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-af35d59fff65576262c359d09caa2502fad2b6de%2FUnity.png?alt=media">Unity.png</a></td><td><a href="yarn-spinner-for-unity/overview">overview</a></td><td></td><td></td></tr><tr><td><strong>Unity Add-Ons</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-00326f4af7cee23501d0517522a49987d30a7d9a%2FAddOns.png?alt=media">AddOns.png</a></td><td><a href="yarn-spinner-for-unity/unity-add-ons">unity-add-ons</a></td><td></td><td></td></tr><tr><td><strong>Community Discord</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-42b868db7a1f36949d786c097fb48caf60c322f6%2FDiscord.png?alt=media">Discord.png</a></td><td><a href="https://discord.com/invite/yarnspinner">https://discord.com/invite/yarnspinner</a></td><td></td><td>Join the community.</td></tr><tr><td><strong>Show us your game</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-a519d5eba721f792787a608d6730d4896ff57c90%2FTellUs.png?alt=media">TellUs.png</a></td><td><a href="https://www.yarnspinner.dev/tell-us">https://www.yarnspinner.dev/tell-us</a></td><td></td><td></td></tr><tr><td><strong>Crediting Yarn Spinner</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-c3d3d6db8e1806715c351eb09c3d76c3bfce2455%2FCredit.png?alt=media">Credit.png</a></td><td><a href="branding">branding</a></td><td></td><td></td></tr><tr><td><strong>FAQ</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-6fde0fe26631620bac28d2e863e8a6c5a16d9797%2FFAQ.png?alt=media">FAQ.png</a></td><td><a href="faq">faq</a></td><td></td><td></td></tr><tr><td><strong>Story Solver</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-8061f05b38fcd083af9d86f4ef4ff07195f37fa4%2FStorySolver.png?alt=media">StorySolver.png</a></td><td><a href="https://www.yarnspinner.dev/storysolver">https://www.yarnspinner.dev/storysolver</a></td><td></td><td></td></tr><tr><td><strong>Yarn Spinner for Godot</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-cb92239acf2d2fd080dacc7df4fb987998dc9593%2FGodot.png?alt=media">Godot.png</a></td><td><a href="yarn-spinner-for-godot/godot-csharp">godot-csharp</a></td><td></td><td></td></tr><tr><td><strong>Yarn Spinner for Unreal</strong></td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-06d7e3e0c60a3d286225ecb870635822e0accfff%2FUnreal.png?alt=media">Unreal.png</a></td><td><a href="yarn-spinner-for-unreal/unreal">unreal</a></td><td></td><td></td></tr></tbody></table>

## What to do next

{% stepper %}
{% step %}
[**Join the Yarn Spinner Discord**](http://discord.com/invite/yarnspinner)

[Join our friendly community Discord](http://discord.com/invite/yarnspinner) before you start working with Yarn Spinner. It's the best place to keep up to date, get support and advice, and share what you're working on
{% endstep %}

{% step %}
[**Read the Beginner's Guide**](https://docs.yarnspinner.dev/beginners-guide)

Yarn Spinner includes a narrative scripting language, Yarn, that allows you to write your game narratives, quests, and logic in a friendly format. The Beginner's Guide will start you off on your path to learning Yarn Spinner.
{% endstep %}

{% step %}
**Use**[ **Yarn Spinner in Unity**](https://docs.yarnspinner.dev/yarn-spinner-for-unity/overview)**, Godot, or Unreal**

Once you're comfortable writing Yarn Scripts, you can integrate Yarn Scripts with a game engine, such as Unity, Godot, or Unreal. Buy one of [our useful add-ons](https://docs.yarnspinner.dev/yarn-spinner-for-unity/unity-add-ons), too, if you need it!
{% endstep %}

{% step %}
**Build a Game**

Simply draw the rest of the owl.
{% endstep %}

{% step %}
[**Tell us about your game**](https://yarnspinner.dev/tell-us) **and** [**Credit Yarn Spinner**](https://docs.yarnspinner.dev/branding)

We'd love to hear about your game, and show it off when we talk about awesome Yarn Spinner-powered games. And please, don't forget to include a credit for Yarn Spinner!
{% endstep %}
{% endstepper %}

## Yarn Spinner powers amazing games, including:

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>DREDGE</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-dd5154a1535dc983a8fcaebe3a4883bee8e8e0e3%2FKey%2BArt%2B-%2BDREDGE.png?alt=media">Key+Art+-+DREDGE.png</a></td><td><a href="https://www.gamedeveloper.com/design/dredge-wasn-t-originally-going-to-be-a-narrative-game-but-then-it-became-one-of-2023-s-best">https://www.gamedeveloper.com/design/dredge-wasn-t-originally-going-to-be-a-narrative-game-but-then-it-became-one-of-2023-s-best</a></td></tr><tr><td>A Short Hike</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-74d675a05e68fbea0b713a6c579e78a2133e50f2%2FA%2BShort%2BHike.jpg?alt=media">A+Short+Hike.jpg</a></td><td><a href="https://ashorthike.com/">https://ashorthike.com/</a></td></tr><tr><td>Lil' Guardsman</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-6d4ca8b8c006f62a2d038a448ded0cab07f4abdd%2FLiL_Guardsman_key_art_landscape_3840x2160.jpg?alt=media">LiL_Guardsman_key_art_landscape_3840x2160.jpg</a></td><td><a href="https://store.steampowered.com/app/1924360/Lil_Guardsman/">https://store.steampowered.com/app/1924360/Lil_Guardsman/</a></td></tr><tr><td>Demonschool</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-e0e7db91eb51a6af4e48403a3887280b58138559%2Fdemonschool.jpg?alt=media">demonschool.jpg</a></td><td><a href="https://necrosoftgames.com/demonschool/">https://necrosoftgames.com/demonschool/</a></td></tr><tr><td>Little Kitty Big City</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-f9ab302c92cea2fc9c9e57dff4ce2a65a8dcd885%2Flittlekitty.jpg?alt=media">littlekitty.jpg</a></td><td><a href="https://www.littlekittybigcity.com/">https://www.littlekittybigcity.com/</a></td></tr><tr><td>Rift of the Necrodancer</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-961ba34f155fbfc3dee54057d3f76c104341421b%2FRift-of-the-NecroDancer-Review-Gamers-Heroes-1-3877274311.jpg?alt=media">Rift-of-the-NecroDancer-Review-Gamers-Heroes-1-3877274311.jpg</a></td><td><a href="https://braceyourselfgames.com/rift-of-the-necrodancer/">https://braceyourselfgames.com/rift-of-the-necrodancer/</a></td></tr><tr><td>Venba</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-e3db6607fc71b5e0ce72a941e4d32bad4e00be57%2Fvenba.jpg?alt=media">venba.jpg</a></td><td><a href="https://venbagame.com/">https://venbagame.com/</a></td></tr><tr><td>Unbeatable</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-cb0a3d05a2224253e3c49e5484709f97dd45f0b5%2F10009766.jpeg?alt=media">10009766.jpeg</a></td><td><a href="https://www.unbeatablegame.com/">https://www.unbeatablegame.com/</a></td></tr><tr><td>Luma Island</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-c47bacc1ce069aeef382232b1babd37cdbce3cc7%2Fluma-island-pc-game-steam-cover-1276614569.jpg?alt=media">luma-island-pc-game-steam-cover-1276614569.jpg</a></td><td><a href="https://store.steampowered.com/app/2408820/Luma_Island/">https://store.steampowered.com/app/2408820/Luma_Island/</a></td></tr><tr><td>NORCO</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-c931b4f4f862910b5c25a286057b2333eb44509d%2Fnorco.jpg?alt=media">norco.jpg</a></td><td><a href="https://store.steampowered.com/app/1221250/NORCO/">https://store.steampowered.com/app/1221250/NORCO/</a></td></tr><tr><td>Night in the Woods</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-d5837b73b7223f681080446782e6dcb890e258e5%2Fshare.jpg?alt=media">share.jpg</a></td><td><a href="http://www.nightinthewoods.com/">http://www.nightinthewoods.com/</a></td></tr><tr><td>ENA: Dream BBQ</td><td><a href="https://463139507-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGAKWviXNATe9kDFWZAco%2Fuploads%2Fgit-blob-705d92bdc03fe2a5d415d47ba1b6189bdc2f8a32%2F15558-download-ena-dream-bbq-pc-mac-game-steam.jpeg?alt=media">15558-download-ena-dream-bbq-pc-mac-game-steam.jpeg</a></td><td><a href="https://joelgc.com/">https://joelgc.com/</a></td></tr></tbody></table>

**... use it to power your game too!**


---

# Agent Instructions: 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:

```
GET https://docs.yarnspinner.dev/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
