CyberPunkGameJam

Dependencies

• YarnSpinner; there are paid packages on the asset store but they have instructions to install the free build as well here

Writing in YarnSpinner

• You can experiment with it their online editor
• A comprehensive guide to writing in Yarn is here
  • If you use VSCode you can install the extension which makes the online editor available locally

YarnSpinner in our Jam

Functions: General

• wait <time_sec> -- waits a specific amount of time
• switchScene "<new_scene>" -- transfers from the narrative / visual novel to a different scene. Currently supported scenes values are:
  • tycoon -- this is the tycoon minigame. Before transfering to this scene you should probably set volume to zero and fade to black.

Functions: Client Requests

• addRequest "<client>" "<description>" <cycles> -- adds a new request to your order book.
  • valid clients are rose, sif, eli
  • cycles is how many cycles you have to fill that request
  • description is a description of the request. it's in the form <number>:<item> and additional entries may be added if separated by a ;. Examples of usage:
    • 2 tomatoes: 2:tom
    • 2 tomatoes, 1 tilapia: 2:tom;1:til
    • 3 eggplant, 2 salmon: 3:egg;2:salmon
    • valid items are:
      • tom / tomato
      • egg / eggplant
      • cuke / cucumber
      • let / lettuce
      • salmon
      • cod
      • til / tilapia
  • example usage:
    • <<addRequest eddy "2:tom" 1000>> -- adds a request from eddy for 2 tomatoes, you have 1000 days to fill it (this is the tutorial request)
    • <<addRequest sif "1:salmon;2:let" 2>> -- adds a request from Tychus & Sif for 1 salmon and 2 lettuce
• canFill <client> -- this is a function that can be used to check if an existing request exists and can be filled by the current inventory. See example usage in h4de.yarn
• hasDelivery -- this is a function than can be used to check if Carrier has any orders that can be filled. See exampl eusage in h4de.yarn
• fillRequest <client> -- fill an existing request for client. No validation is done that you have enough inventory to fill this request so make sure to call canFill <client> somewhere before ending up here
• completedRequests <client> returns how many orders have been completed for this client. Example usage might be <<if completedRequests("sif") > 3>> to guard against dialogue that should only happen after 3 filled requests.

Functions: Visuals

• reset -- this unloads the left+right characters and sets the Background to the "no-signal" screen
• loadBG "<path>" -- takes a path to a background image and sets it; we'll discuss how to add background images in a bit
• loadLeft "<path>", loadRight "<path>" -- loads a left or right image into the character slot
• unloadLeft, unloadRight -- makes the left or right character slot empty
• fadeIn <time_sec>, fadeOut <timeSec> -- fades a scene in or out in a set amount of time

Functions: Audio

• playBG "<track_name>" -- start playing the specified track at the current volume. valid track_name values right now are:
  • Dead Rain
  • Remember Yesterday
  • The Color Purple
• volumeBG <level> <time_sec> -- fade from the current volume to the specified level (range: 0 to 1) over the time_sec seconds. A time is optional and change will be instant if omitted. Examples:
  • volumeBG .5 -- instantly sets the volume to half
  • volumeBG .75 5 -- fades the volume from the current value to .75 over 5 seconds
• crossfadeBGTo "<track_name>" <time_sec> -- fades the current track out and a new track in over time_sec. The new track will be playing at the same level as the previous track.

Indicating you would like to call a function in the script is done by <<function_name args>>. If there are no args you can omit them and just <<function_name>>. Multiple args are space separated.

Adding new art
All the paths above get loaded from a Resources directory; see Art/Resources/Bar/BarBG1 as an example. To add new art drag it into the Project in the place you want it saved. Because of our current config it should get treated as a Sprite by default.

When loading new art with loadBG, loadLeft, loadRight or any other new functions provide a path that is relative to Resources/ e.g. in the example above you would use: <<loadBG "Bar/BarBG1">>.

Editing scripts
Start by checking out the sample script I have in place. This includes examples of: function calls, dialogue, choices, scene jumps, loading characters, setting/referencing variables.

The scripts are:

• DemoScript.yarn
• h4de.yarn

From there you can find examples and a full walkthrough in the YarnSpinner docs here.

Right now the Bar scene will automatically start playing at the Begin node. If you want you can swap that node to something like the following to debug without starting playing the whole thing from the beginning.

title: Begin
---
<<set $any_variables_you_need = "whatever">>
<<jump TheNodeYoureExperimentingWith>>
===

Adding new scripts
Currently all script files live under Dialogue. When you add a new one it needs to be recognized by the CyberpunkJam.yarnproject asset. If you click on it and check the inspector it will tell you which script files are loaded:

If you add a new script and it doesn't show up right click the yarnproject and reimport it:

.