Skip to content

"Left Sidebar": SugarCube (v2.18)#


SugarCube has a built-in left sidebar whose contents can be changed by adding one of several special passages to your story.

The following list describes each of the special passages in the order that they appear vertically within the sidebar:

  • StoryBanner appears directly above the story's Title. One use is to show the story's icon/image.
  • StorySubtitle appears directly below the story's Title. One use is to show the story's version information.
  • StoryAuthor is used to show the Author's information.
  • StoryCaption is generally used to show dynamic information about the main character or the story's progress.
  • StoryMenu appears directly above the Save button and is used to show custom menu items.
  • StoryShare appears directly below the Restart button and is used to access a dialog containing Author's social media or web-site links.

The sidebar can be manually stowed (hidden) and unstowed (revealed) by selecting the < or > icon in the sidebar's top right corner. The same effect can be achieved programmatically by using the UIBar global object and its UIBar.stow() and UIBar.unstow() functions.



Twee Code#

:: StoryTitle
Left Sidebar in SugarCube

:: Start
<<set $name to "Jane Doe", $location to "Work">>\
[[Another passage]]

<<link "Stow the sidebar!">>
  <<run UIBar.stow() >>
<<link "Unstow the sidebar!">>
  <<run UIBar.unstow() >>

:: StoryBanner
<img src="" width="64" height="64">

:: StorySubtitle
Version: 0.2.1

:: StoryAuthor
by Anonymous

:: StoryCaption
Name: $name
Location: $location

:: StoryMenu
[[New story link!|Start]]

:: StoryShare

:: Another passage
<<set $name to "John Smith", $location to "Shop">>\

Twee Download