https://github.com/lp1dev/mirage

TypeScript/JavaScript text-based game engine
https://github.com/lp1dev/mirage

engine javascript retrogaming text-game typescript

Last synced: 5 months ago
JSON representation

TypeScript/JavaScript text-based game engine

• Host: GitHub
• URL: https://github.com/lp1dev/mirage
• Owner: lp1dev
• Created: 2018-06-22T21:03:53.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-23T17:58:22.000Z (almost 6 years ago)
• Last Synced: 2025-03-29T15:42:07.995Z (10 months ago)
• Topics: engine, javascript, retrogaming, text-game, typescript
• Language: TypeScript
• Homepage:
• Size: 529 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# MIRAGE

## Modern Interactive Retro Adventure Game Engine

Mirage is a retro adventure game engine written in TypeScript/JavaScript.

The goal of this project is to build a quick and easy to use tool to build one's own text game.

It can be used with Node.JS, web applications and mostly anything running with TypeScript/JavaScript.

It requires a JSON game file, containing game configuration and logic. You can have a look at this [example file](./examples/node-cli/game.json)

For more information please read the [documentation](./doc/).

### Node.js Example

![node-screenshot](https://raw.githubusercontent.com/lp1dev/Mirage/master/examples/screens/screen_node.gif)

### Android (Ionic) Example

![android-screenshot](https://raw.githubusercontent.com/lp1dev/mirage-ionic-example/master/screens/android.gif)

## Use mirage in your npm project

> npm install --save https://github.com/lp1dev/Mirage.git

## Build the engine from its sources

To install the needed dependencies :

> npm i

To build the JavaScript files from the TypeScript

> tsc

The MIT License (MIT)

=====================

Copyright © 2018 Lp1.eu

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.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.