Skip to content
This repository has been archived by the owner on Jul 12, 2022. It is now read-only.

[Documentation Request] "Best Practices" page/section for covering general-use cases #1

Open
HeyItsLollie opened this issue Apr 6, 2020 · 0 comments

Comments

@HeyItsLollie
Copy link

A Best Practices page/section can be incredibly helpful for getting started with custom implementations. Something that covers how Yarn Spinner (and Yarn itself) is expected to be used, along with some common use-case scenarios. Having a recognizable starting point to read from is a huge boon for newcomers to assets like Yarn Spinner, and for generally less-experienced devs like myself!

Some suggestions / questions below. This is obviously based on my own thoughts while reading the current documentation for 1.0/1.1 and I'm offering them more as something to bounce thoughts off of rather than a complete request, but I feel these cover some fairly common use-cases and questions:

  • Adding the Dialogue Runner to multiple game objects, VS Controlling a single instance (or multiple instances) of Dialogue Runner with scripts.
  • Use case: Parsing character names from Yarn scripts, to use as a way to control the Dialogue UI.
    (eg: Character names appearing above dialogue text, or the NITW example of controlling the dialogue box's position to appear above the speaking character.)
  • Use case: Working with multiple instances of Dialogue UI to handle different ways of displaying text.
    (eg: Character dialogue boxes in Name/Text format VS "narration" text that appears outside of a dialogue box.)
  • Does the included Variable Storage work across scenes? (Or, is this the use-case where a custom memory manager would be suitable/required?)
  • Is Yarn Spinner suited for handling menu text strings? (for Yarn Spinner's localization support.)

Some of this may seem pretty hand-holdy to cover, but in my experience, I always appreciate having code-examples for anything that's available to interface with. It gives me more confidence to play with the features via scripts, and more room to figure out how everything works together.

@desplesda desplesda transferred this issue from YarnSpinnerTool/YarnSpinner Apr 6, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant