🎮 Play Accessible PuzzleScript games in your terminal or embed them
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
gist-solutions
gists
script
src try adding a tabindex on the table Oct 20, 2018
test
typings
.dockerignore add docker file Jun 19, 2018
.eslintrc 👕 lint JS files Aug 29, 2018
.gitattributes
.gitignore
.npmignore 🔥 unused files Sep 20, 2018
.travis.yml
Dockerfile
README.md
design.md
index.xhtml
package.json
tsconfig.json undo downgrade Oct 20, 2018
tslint.json
webpack.config.js move webpack-output.js into lib/ Sep 21, 2018
yarn.lock

README.md

Accessible PuzzleScript

NPM version Downloads Build status Dependency status Dev dependency status Code coverage

This is a program that allows people to play PuzzleScript games in a browser or in a terminal.

Also, it is accessible, meaning that blind or visually impaired people can play these games too! See blog post for more info or try the demo.

Play from the command line terminal

  1. Run npm install -g puzzlescript to install
  2. Run puzzlescript to start playing

Embed in a Browser

See ./test/browser/html-table.xhtml for an example of embedding in a browser.

// Include <script src="node_modules/puzzlescript/dist/puzzlescript.js"></script>
// and then the following:
table = document.querySelector('table') // selector to the <table> that will be used
engine = new PuzzleScript.HTMLTableEngine(table)
engine.setGame(gameSourceString, 0 /*startLevel*/)
engine.start()

Screencaps

Here are some screencaps of games being played.

Mirror Isles (original)

This screencast shows playing the game in a terminal using ASCII and ANSI colors.

mirror-isles

Pot Wash Panic! (original)

(click to see the ascii screencast)

video of install and a couple games

Hack the Net (original)

video of a couple levels of Hack-the-Net

Skipping Stones to Lonely Homes (original)

video of the beginning of Skipping Stones (BIG)

Entanglement (original)

video of the beginning of Entanglement

Video games that blind people can play?

PuzzleScript lends itself nicely to be playable by people with low or no vision:

  1. each level is small (~10x10)
  2. each sprite has a human-readable name (since the whole game is in 1 text file and the logic refers to the sprites)
  3. a blind person has 2 sets of directions (one to move the player and one to move the “eye” which reads off which sprite is in that spot)
  4. the games do not require quick reflexes and have Undo built-in so it is easy to think and try different options
  5. we can just print to the terminal whenever something needs to be read (presumably the terminal is read aloud to the person)

If you are blind, you can play the games by running puzzlescript --no-ui and use the I, K, J, L, and P keys to move the cursor to explore the level.

If you want to experience what a non-sighted person would experience but still see the level, run NODE_ENV=development puzzlescript and use the I, K, J, L, and P keys to move the cursor to explore the level.

Screencap

This screencap is a visual demonstration of exploring and then playing a level.

exploring and playing a level without sight (visual depiction)

This screencap is the non-visual version of the same steps as shown above. This is what vision-impaired people will read when they move the Inspector cursor around and then move the player to play the game.

exploring and playing a level without sight

About

The goal of this project is to do 3 things:

  1. make PuzzleScript easier to embed (like in 404 pages, easter eggs, etc). See docs
  2. allow blind people to play video games (by passing the --no-ui argument)
  3. use the terminal as a GUI for playing games

Dev Notes

This is a remake of PuzzleScript that has the following features:

  • There is documentation for using the NPM package
  • There is a Grammar file that parses the game file (uses nearley)
  • The interpreter is a separate component
  • The rendering code is abstracted out so folks can add a different renderer (the example uses ASCII in the Terminal to show the game)
  • The input code is abstracted out so gamepads, buttons, etc can easily be provided
    • This also allows computers to play the games!
  • The game can be imported/exported to JSON for research or other purposes

Research

To convert a game to JSON, run the following:

import { Parser } from 'puzzlescript'
import Serializer from 'puzzlescript/lib/parser/serializer'

const { data } = Parser.parse(gameSource)
const json = new Serializer(data).toJson()
const reparsedData = Serializer.fromJson(json, gameSource)

Commands

  • npm run docs generates docs in the ./docs/ directory
  • npm start runs a game in the ./gists/ directory without debugging info (10x faster) (uses NODE_ENV=production)
  • npm run start:dev runs a game in the ./gists/ directory with sprite info (useful for debugging)
  • npm run start:debug runs a game in the ./gists/ directory with a Chrome Debugger open so you can set breakpoints
  • npm demo runs all of the games in the ./gists/ directory with a few sample moves (up/down/left/right/action)
  • npm test runs all of the unit tests (including solutions in the ./gist-solutions/ directory)
  • npm run watch Run the tests and when you update the source, it re-runs the tests
  • npm run test:debug Run the tests but opens a debugger (remember to add a debugger line into the JavaScript)
  • npm test; open coverage/lcov-report/index.html to see test coverage
  • npm run coverage generates a coverage report which includes the JS code as well as any games that you ran in dev mode (using npm run dev)
  • See the module dependency tree by running npm run build:stats and then uploading webpack-stats.json to https://webpack.github.io/analyse/#modules

Objects

  • Level contains a table of Cells which contain a set of Sprites that should be rendered
  • Rule contains the conditions and actions to be executed.
    • It also contains methods for checking if the Rule matches a Cell and methods for how to change the Cell
  • Cell contains a set of Sprites and is used to represent the current state of the Game

TODO

Want to help? Here is a roadmap of things that need to be implemented:

  • support tabbing through the sprites to say where they are and how many of them are in the puzzle
  • output which sprites changed when the player moves or presses undo
  • improve the sound effects (needs an implementation of BiquadFilter in NodeJS)
  • support the RIGID keyword
  • output a simple BEL (ASCII character 7) when the speaker package is not installed
  • output sound effects when any of the following occur:
    • a sprite is CREATE, DESTROY, CANTMOVE
    • a sprite is moved
    • RESTART, UNDO, TITLESCREEN, STARTGAME, STARTLEVEL, ENDLEVEL, ENDGAME, SHOWMESSAGE, CLOSEMESSAGE
  • use HTML Tables to render in the browser (see ./test/browser/html-table.xhtml)
  • Cache Improvements
    • cache the SimpleNeighbor.matchesCell() function so we do not have to recompute if a cell matches a Neighbor
    • de-duplicate SimpleNeighbor that have a direction but none of the tiles depend on the direction (causes fewer caches to be updated)
    • improve getMatches(level) by storing a cache of all the sprites in each row/column so we can skip the row/column entirely if the necessary sprites are not available