Skip to content

cliffhall/NextRock

Repository files navigation

NextRock

Run a colony on the Red Planet. An episodic series of Twine games.

Colony Map Screenshot

GAME

STATUS

Work in Progress

  • UI is styled and works on mobile, tablet, and desktop.
  • All locations on map exist and you can navigate between them via links.
  • Plot, Scene, Branch, Action, Location macros written to support multiple plots with branching scenes.
  • A few initial scenes are set up for testing the macros.
  • Twee structure set up to support common elements and episode specific elements for compilation.
  • More scenes, character, and location sketches are being written in Scrivener (NextRock - Ep1.scriv)

DEVELOPER SETUP

Prerequisites

  • Node v12.6.0 or above (also installs npm)
  • Tweego v2.0.0 or above

If Installing Tweego on Windows

If Installing Tweego on Mac or Linux

  • Unzip distribution file in your home directory
  • Create a symbolic link to the executable: ln -s ~/tweego-2.0.0-macos-x86/tweego /usr/local/bin/tweego
  • Create a symbolic link to the storyformats: ln -s ~/tweego-2.0.0-macos-x86/storyformats ~/.storyformats

Download the project

  • Download the project as a .zip file and unzip wherever you keep your projects.
  • OR if you have git installed on your system:
cd path/to/your/projects
git clone https://github.com/cliffhall/NextRock.git

Install dependencies

cd path/to/NextRock
npm install

Build the entire project once

npm run build-once

Test the output

Open docs/index.html in your browser of choice

CONTINUOUS DEVELOPMENT

To work on JS, CSS, and TWEE sources and have them continuously compiled as you make changes, you need to open two dedicated terminal windows and run:

npm run watch:gulp

and

npm run watch:twee

Project structure and build process

The skeleton for this project is called slim-tweego. For more information about how it works or to start your own tweego project, go there.