squiffy

a tool for creating interactive fiction

Showing:

Popularity

Downloads/wk

23

GitHub Stars

124

Maintenance

Last Commit

2yrs ago

Contributors

10

Package

Dependencies

8

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Squiffy

Squiffy is a tool for creating multiple choice interactive fiction. Squiffy is written entirely in JavaScript - the compiler uses Node.js and the games it generates run in a web browser.

For installation and usage instructions, see the documentation.

The plans for forthcoming releases are on the development roadmap.

For discussion and help, see the forums.

##Contributing Contributions are welcome! Fork this repo, fix a bug or add a feature, and then create a pull request.

You can run your local copy of Squiffy instead of the globally-installed version from npm by using node squiffy.js in place of the squiffy command. If you're using Windows and want to replace the global squiffy command with your local development version:

  1. Clone master of your fork to your local machine (e.g., C:\projects\squiffy\).
  2. Install Nodejs if you haven't already
  3. From your squiffy directory, run npm install
  4. Next run npm install squiffy -g
  5. Delete the new squiffy folder in your global node_modules folder: C:\Users\[yourUser]\AppData\Roaming\npm\node_modules\squiffy
  6. Open a new command prompt as Administrator.
  7. Create a symlink between your npm and development squiffy folders by running mklink /D C:\Users\[yourUser]\AppData\Roaming\npm\node_modules\squiffy C:\projects\squiffy

Now running squiffy helloworld.squiffy will use the code from your project folder.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100