About this project

SugarCube Starter is a template for creating SugarCube stories with Twine and Tweego. It provides automatic installation of Tweego and SugarCube, configurable builds, automatic production builds, and a development server with Browser-Sync live reload. CSS injection avoids full-page reloads. The source tree includes dedicated folders for custom fonts, media, third-party vendor scripts, story .twee files, and head content. The stack uses Vite, TypeScript, Sass with PostCSS Preset Env, and Node.js 18+. Scripts include npm start or npm run dev for development, npm run build for production output to dist/, npm run tweego to run Tweego manually, and npm run tweego:install to install or reinstall Tweego. Debug View is enabled in development and disabled in production builds by default. The repository links to SugarCube documentation, a SugarCube Basics wiki, and several third-party macro collections. It is MIT licensed.