#AUDIO:
What it Does: Plays an audio file once. It supports .mp3, .mp4, and .wav files.When to Use It: Anytime you want a sound effect or music to play.
NOTE: The audio will play as soon as the knot opens, no matter where you place the tag inside it.
How to Use It: Write the tag in all caps followed by the EXACT FILE name (including the extension, like .mp3 or .mp4). One typo and the audio won’t play.
NOTE: The audio file must be in the same folder as your .ink file.
#AUDIO: crowdChatter.mp3
#AUDIOLOOP:
What it Does: Loops an audio file.When to Use It: This is useful for ambient noise, background chatter, looping music, etc.
NOTE: When switching scenes, add a blank #AUDIOLOOP tag to stop the playback. Otherwise, the audio will continuously play throughout your story.
How to Use It: Write the tag in all caps followed by the EXACT FILE name (including the extension, like .mp3 or .mp4). One typo and the audio won’t play.
#AUDIOLOOP: crowdChatter.mp3 // Use this to stop the audioloop after a choice or transition to knot. #AUDIOLOOP:
#CLEAR
What it Does: Clears all text from the screen.When to Use It: Great when switching scenes, locations, POVs, or decluttering the screen.
How to Use It: Best to attach this tag, in all caps, to a choice. Then redirect to the next knot.
Where would you like to go? * [The Beach] #CLEAR -> beach * [The Store] #CLEAR -> store
#RESTART
What it Does: Restarts the story and all variables.When to Use It: I use this at the beginning of my stories when asking the player for a name. When I ask for verification of the name, I present a Yes or No choice. If they select No, the story restarts so they can input the name they want.
How to Use It: Best to attach this tag, in all caps, to a choice. Here’s an example of how I use it:
That's your name? Are you <i>sure</i>? You <b>cannot</b> change it later. ** [Yes] "I'm sure." ** [No] #RESTART
#IMAGE
What it Does: Add an image (.jpg, .png) or a GIF (.gif)!When to Use It: Anywhere you want to add visuals in your story.
How to Use It: Write the tag in all caps followed by the EXACT FILE name (including the extension, like .jpg or .gif). One typo and the image won’t show.
NOTE: Images won’t appear in Inky. Only after you export your story for the web.
#IMAGE: plant.jpg
#UNCLICKABLE
What it Does: Makes a choice unclickable!When to Use It: When you want to show the player/reader that they could do something but can’t for some reason.
How to Use It: Write the tag AFTER a choice.
NOTE: Does require a bit more coding to make a choice conditional.
* [Go to the Cafe] * [Go to the Library] #UNCLICKABLE
Recommended sites
If you’re looking for some sites that offer good images and audio, here are my recommendations.Pixabay — Offers royalty free images, videos, and audio!
Unsplash — Offers royalty free, high-quality images!
Freepik — Offers some royalty free audio and images. WARNING: Does have AI features.