Skip to content

Commit

Permalink
Merge pull request #37 from YarnSpinnerTool/readme-0.2.0
Browse files Browse the repository at this point in the history
Update README.md for 0.2.0
  • Loading branch information
dogboydog authored Mar 2, 2024
2 parents 8813ad2 + 67ef7f2 commit 843cfbe
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,29 @@
Yarn Spinner for Godot is a beta port of [YarnSpinner-Unity](https://github.com/YarnSpinnerTool/YarnSpinner-Unity) integration to the Godot Engine v4 (requires C# support).

Here is a video of one of the samples included in this repository showcasing animations and branching dialogue written via .yarn scripts:
Here is a video of the various samples available as of version 0.2.0:

https://github.com/YarnSpinnerTool/YarnSpinner-Godot/assets/9920963/ec50efb5-0d1e-4353-9c08-71e27ff66038

https://github.com/dogboydog/YarnDonut/assets/9920963/3eecbe38-65e5-4130-a838-8154405df013

To try these samples yourself, open this repository as a Godot project. Feel free to use the code in the samples as the basis for your own game features based on YarnSpinner-Godot.

## Documentation

There is a [guide here](https://docs.yarnspinner.dev/beginners-guide/making-a-game/yarn-spinner-for-godot) on the basic installation and usage of the plugin.

See the [docs directory](./docs/Home.md) for more documentation.

## Roadmap
## Features

Working:
* Create a Yarn Project through the create resource menu
* Create a `.yarnproject` with the Project > Tools > YarnSpinner > Create Yarn Project menu item.
* Manage your Yarn Project with a custom inspector which provides buttons similar to the YarnSpinner-Unity inspector
* Yarn scripts will re-import on change, triggering a compilation of all yarn scripts in the associated project
* Storing a compiled yarn program, a list of errors, line metadata, and string tables.
* Dialogue runners, commands, and functions
* Example line view and option view
* Example line view and option view scripts provided.
* Generate CSV files for localizing your dialogue. The CSV files are not in the Godot format, but they have more context fields than Godot CSVs, and YarnSpinner handles parsing and generating the CSVs, and converting them into Godot `.translation` files.
* MarkupPalette custom resources which allow you to simply color parts of your dialogue

TODO:
* Bug fixes / resilience (bug reports welcome)
* Clean up code comments

### Thanks

Expand Down

0 comments on commit 843cfbe

Please sign in to comment.