Git Product home page Git Product logo

squiffy's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.