CLI Adventure Games

Text Based Adventure Games built with Node.js

"It runs on the world's most powerful graphic chip - Imagination" - Sheldon Cooper

This module is inspired by amazing text based adventure games like Zork.

The game engine is still in active development and supports only basic features.

Pull requests and Game Scripts welcome!

Installation

Run

$ [sudo] npm install -g cli-adventure-games

To play, execute

$ cli-adventure-games

For players

Pick a Game script to start off.

You will be shown help instructions before you start the game. At any point, you can type help to get help.

For developers

There is a Game Script, that is fed into the Game Engine. The script file is a JSON, that consists of how the game should work. The game engine describes the scenarios listed in the JSON to the player, takes his input and acts accordingly.

You can either contribute to the Game Script, by building one of your own games or you can contribute to the engine as well.

To create your own game script, please refer to the Maya.json in the Games folder.

PS : Please check with the me/contributors before updating the engine.

Todos :

Save & Restore Game
Player interaction with the objects (use swords or rocket launchers)
Implement Lexical processing of commands
Build game scripts for Zork I, Zork II and Zork III

Special thanks to Anurag Jain & Jayesh Choudhari for their advice and contributions.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.