Git Product home page Git Product logo

planarally's Introduction

PlanarAlly logo

Downloads GitHub release (latest by date) Discord invite button Documentation site button Patreon donate button

PlanarAlly

This project is still in active development; multiple bugs or structure changes can and will happen

A companion tool for when you travel into the planes.

PlanarAlly is a web tool that adds virtual battlemaps with various extras to your D&D toolbox.

Some key features are:

Self hosting: You can run this software wherever you like without having to rely on an external service
Offline support: This tool can be used in a completely offline set-up for when you play D&D in a dark dungeon.

Simple layers: Organize your scenes in layers for easier management.
Infinite canvas: When a limited workspace is still not enough!
Dynamic lighting: Increase your immersion by working with light and shadows.
Player vision: Limit vision to what your token(s) can see. Is your companion in a different room, no light for you!
Initiative tracker: Simple initiative tracker

This tool is provided free to use and is open source.

Downloads

Typically only one person in your group should download and install PA, or even nobody if you use a publicly hosted version.

Releases of PlanarAlly can be found on the release page.

For more information on how to use/install PA, see the documentation.

Documentation

User documentation can be found here.

This is still a work in progress, so some elements may still be undocumented or outdated. If you wish to contribute to the docs, they are hosted in a different repository.

Contributing

If you want to contribute to this project, you can do so in a couple of ways.

If you simply have feedback, or found a bug, go to the issues tab above. First see if your feedback/bug/issue already exists and if not create a new issue!

If you want to contribute to the actual codebase, you can read more about how to setup a development environment in the CONTRIBUTING document.

If you want to contribute some gold pieces, feel free to checkout my Patreon

Example view of a player with a light source Credits to Gogots for the background map used source

planarally's People

Contributors

antisc2 avatar asmfreak avatar chisaipete avatar daniferrito avatar dependabot[bot] avatar dthv avatar edmael avatar franluque2 avatar hauvgaard avatar hmqgg avatar jirsat avatar kruptein avatar ldeejay1969 avatar schemen avatar w8bsd avatar zachmyers avatar zachmyers3 avatar zeteticl 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.