/PlanarAlly

A companion tool for when you travel into the planes.

Primary LanguageTypeScriptMIT LicenseMIT

PlanarAlly logo

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

PlanarAlly

A companion tool for when you travel into the planes.

PlanarAlly is a web tool that adds virtual battlemaps with various extras to your TTRPG/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
Floors!: Look down upon lower floors when standing on a balcony!

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

Downloads

Typically only one person in your group should have to download and install PA, alternatively you can 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.

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