GithubHelp home page GithubHelp logo

evilurge / escaperoomgenerator Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 81 KB

Generate your own escape room, fun QR game for all ages (that can use a GPG key)

License: MIT License

JavaScript 55.47% HTML 44.53%

escaperoomgenerator's Introduction

  _____                          ____                        ____                           _             _
 | ____|___  ___ __ _ _ __   ___|  _ \ ___   ___  _ __ ___  / ___| ___ _ __   ___ _ __ __ _| |_ ___  _ __| |
 |  _| / __|/ __/ _` | '_ \ / _ \ |_) / _ \ / _ \| '_ ` _ \| |  _ / _ \ '_ \ / _ \ '__/ _` | __/ _ \| '__| |
 | |___\__ \ (_| (_| | |_) |  __/  _ < (_) | (_) | | | | | | |_| |  __/ | | |  __/ | | (_| | || (_) | |  |_|
 |_____|___/\___\__,_| .__/ \___|_| \_\___/ \___/|_| |_| |_|\____|\___|_| |_|\___|_|  \__,_|\__\___/|_|  (_)
                     |_|

NPM version License

The first indoor escape room generator!

Send your beloved partner\roomate\dog\bff to a COVID-19 style adventure around the house!

It all started with a friend's idea <3


The rules of the game are pretty simple, use the clues to find the stashed QR code around your house, Scan it, save aside the code you're getting from each clue.

At the end you'll be able to decode that with all the clues you found so far with a dedicated private GPG key that has been generated just for you!

Example

https://storage.googleapis.com/shell-gems.appspot.com/img/index.html

How to install

npm i -g esc-gnr

How to use

  1. Create and navigate to a dedicated work folder
  2. Execute the cmd to initiate a new escape room project
esc-gnr
  1. Fill the questionnaire.
  2. Once done, deploy the entire content of /public folder, and print the file manual.pdf.

    Currently, there's also a /keys folder that been created with the GPG keys, in the future the private key will be provided to download at the last stage of the game.

  3. Spread the QR codes around the house base on the hints you filled in the wizard.
  4. Send your loved one to a quest and reduce COVID boredom.

In the last stage of the quest, the user will receive his private key in order to decode the entire clue.

NEW Features

  • Add YouTube support
  • Include giphy and any other external source
  • Generate a PDF with all the QR codes

TODO:

  • Generate firebase project file.
  • Allow to download the private GPG key at the last stage of the game.

License

MIT

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.