Giter Site home page Giter Site logo

sjmiller / dungeon-revealer Goto Github PK

View Code? Open in Web Editor NEW

This project forked from tkfu/dungeon-revealer

0.0 0.0 0.0 6.88 MB

A web app for tabletop gaming to allow the game master to reveal areas of the game map to players

Dockerfile 0.44% JavaScript 59.00% CSS 35.84% HTML 4.72%

dungeon-revealer's Introduction

dungeon-revealer

Deploy to Heroku

About

A web app for tabletop gaming to allow the game master to reveal areas of the game map to players.

Forked from https://github.com/apclary/dungeon-revealer, with Heroku deployment and basic auth for the DM added.

What the DM Sees

alt text

What the players see

alt text

Installation

Heroku

Heroku is a platform-as-a-service that supports one-click deployments and has a free tier. You can sign up for an account, then click the button below to automatically deploy the app. It’s the easiest way to get started.

Deploy to Heroku

Docker

If you have Docker installed, you can launch this app like this:

docker run --rm -it -p 3000:3000 -e PASSWORD=dmpassword jonoster/dungeon-revealer

This is also a good way to serve it on a personal web server; either serve directly from the docker container, or put it behind a reverse proxy. An example Caddyfile for use with Caddy:

dndmaps.your-hostname.com {
    proxy / 127.0.0.1:3000
}

In this case, you’d probably want to launch the docker image in daemon mode and only expose the port locally:

docker run -d -p 127.0.0.1:3000:3000 -e PASSWORD=dmpassword jonoster/dungeon-revealer

You can also build the docker image yourself from the Dockerfile in this repo.

Use

Once you’ve deployed the app, visit http://your-app-url.hostname.com/dm. Authenticate with username dm and the password you set up (pass by default), and then you’ll be prompted to upload an image file. Once you do, you can start drawing on it.

To clear areas of the map, click and draw on the map. If you clear too much, you can switch the brush to the "shroud brush" and restore some of the fog. Whenever you clear some of the map area and are ready to share it with the players, click "Send".

Now, you can send your players to http://your-app-url.hostname.com, and they’ll see only the part of the map you’ve revealed. What appears as a shadow to the DM will appear as pure blackness to players.

To replace the existing map with a new image file, click "New Map". Note that you can only have one map open at a time, and shrouded areas are reset when you change maps.

dungeon-revealer's People

Contributors

apclary avatar jojo080889 avatar

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.