README.md

Calico Starter project

Calico is a web framework to run and display Ink interactive fiction. This Github template project simplifies how to get started with using Calico.

How to use this starter project

Open a shell and invoke :

npm init using cmcrobotics/calico-starter my-calico-project
cd my-calico-project
# Update the package name and other properties...
npm init
# Install required packages
npm install
# Run a local static web server (for a live server, see instructions below)
npm start

Of course, you're expected to replace my-calico-project by the name of your new project.

Next, you can start developing your new project.

How to develop your story

At this point, you can start a live web server that will automatically refresh the browser window whenever you change your story or any of the project files.

This project comes pre-configured with Five Server.

To install it locally (and replace Live Server which is now unsupported), you can execute :

# Remove live-server (if you have it)
$ npm -g rm live-server

# Install five-server
$ npm -g i five-server

# Run it
$ five-server

For more details about Five Server, please refer to its documentation.

Any modification to your story.ink will automatically trigger an update of the web rendering.

To go further

Please refer to the excellent upstream documentation of Calico.