Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 790 Bytes

README.md

File metadata and controls

29 lines (20 loc) · 790 Bytes

Spindle

Opinionated Build Tool for building Twine Games. Spindle's purpose is to wrap all all boilerplate for interacting with Twine and provide a "single install" for any game repo.

Powered by Gulp and Tweego.

Install

npm install -D @brisberg/spindle
# or
yarn add -D @brisberg/spindle

Also requires that Tweego be installed:

  • Install golang
  • Install Tweego - go get github.com/tmedwards/tweego

Usage

If your repo is formatted correctly, add a spindle.yml file to your repo root. See config.yml for an example.

Build with a simple command:

npx spindle
# or
yarn run spindle