Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
title: Sample story format
description: The story description goes here
author: Your name here!
image: https://getfind.app/image.png
emoji: 😀
date: 08/31/21
> *The code for this story is at https://gist.github.com/aheze/4997b82828718e05ea3ec20f3902dd57*.
> Hello! Lines starting with `>` are sent by Findbot.
! Hi! Lines starting with `!` are sent by Guide.
> Each message is 1 line. If you want more lines, use `<n>` for a newline.
! That's the basics. Here's some more advanced stuff:
> **How to pause the story with a button**<n>Once the reader presses the button, the story will resume.
> First, indent 4 spaces (` `), then type in the name of the button.
> Here's an example:<n>```! Why did the chicken cross the road?<n> I don't know. Keep going.<n>! To get to the other side.```
! Why did the chicken cross the road?
I don't know. Keep going!
! To get to the other side.
> **How to add a branch with 2 or more options**<n>The reader can choose which branch to follow! Findbot will add a button for each branch.
> For each branch, indent 4 spaces (` `), then type in the branch-button's name.
> Once the story runs out branches, it will end. Have fun 😄!
> Here's an example:<n>```! Let's play rock-paper-scissors! What do you choose?<n> Rock<n> > You chose rock!<n> Paper<n> > You chose paper!<n> Scissors<n> > You chose scissors!```
! Let's play rock-paper-scissors! What do you choose?
Rock
> You chose rock!
Paper
> You chose paper!
Scissors
> You chose scissors!
> Cool, right?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment