/calico

a web engine for interactive fiction

Primary LanguageJavaScriptMIT LicenseMIT

Calico

Calico is a web engine developed for use with inkle's narrative scripting language Ink.

This project has an itch page here.

Due to browser security issues, you may need to use Catmint, or run a local server, in order to test your game. These issues won't be present once your game is uploaded to a website like itch.io.

If you're interested in contributing, please don't hesitate to submit a pull request.

Resources

Using Calico

Getting Started

How to set up Calico, import patches, build a game, and upload everything to itch.io.

Tags

A list of tags offered out of the box by Calico, and an explanation of how to create your own.

Patches

A guide covering some of the more complicated patches provided by Calico. If a patch isn't working as expected for you, check in here!

Using Ink

A Beginner's Guide To Ink

A condensed introduction to ink, the narrative scripting language that powers Calico.

Ink Symbols

A list of symbols used in ink (and their corresponding function), with links to the official documentation. Designed to be easy to control-F through.

Advanced Features

Creating Patches

A guide covering how to create patches yourself.

Events

An explanation and list of the custom events that Calico offers, which allow you to easily tweak the engine's functionality.

Ink Esoterics

A list of some very obscure ink features. In all honesty, these are mostly here for when I forget.

License

Calico and all patches are released under the MIT license. Additionally, a small number of patches rely on other MIT licensed code.

At runtime, Calico will automatically generate and compactly print all necessary licenses to the browser console.