![Page cover image](https://docs.yarnspinner.dev/~gitbook/image?url=https%3A%2F%2F1350824522-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MUzduXovTOfMmBpZ0Wi%252Fuploads%252F5LwhaChtSwrdiy7Ip3Hw%252FYS-GitBook-Cover.png%3Falt%3Dmedia%26token%3Db3bd9f26-0cb0-4c26-b9bd-3dc28371ee42&width=1248&dpr=4&quality=100&sign=380f463&sv=1)
โญStart Here
Yarn Spinner is the friendly tool for writing dialogue in games. It's easy for writers to use, and has powerful features for programmers.
Yarn Spinner is free and open source and has been used in thousands of amazing games, including Night in the Woods, A Short Hike, Lost in Random, Dredge, Frog Detective, Button City, Escape Academy, Baladins, and Unbeatable.
Are you brand new to Yarn Spinner?
You should start with our Beginner's Guide.
No need to install anything first, just start with the Beginner's Guide, and work your way through three guided tutorials on the syntax of writing Yarn scripts, installing a text editor to write Yarn scripts, and then integrating Yarn scripts with your game, and installing Yarn Spinner as a package into your game engine.
We'd also recommend joining the Yarn Spinner Discord, where you can show off your work, and ask for help.
Yarn Spinner is not just a single project or tool, but is a collection of projects and tools. It consists of a language to write your narratives inโYarnโand tools to display, and use your Yarn in game engines, like Unity, and tools to translate, localize, and connect voice over to your stories.
To get started, dive into the Beginner's Guide.
Yarn Spinner is provided as free, open source software by the team at Yarn Spinner Pty. Ltd. We want this to continue being our full time jobs. You can help by hiring us to help integrate Yarn Spinner in your games, build specific features you want, or consult, and by backing our Patreon.
Last updated
Was this helpful?