PlanarAlly

A companion tool for when you travel into the planes.

Github stars Tracking Chart

Total Github Download Count

PlanarAlly

This project is still in early 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 nog 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.

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.

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

Main metrics

Overview
Name With OwnerKruptein/PlanarAlly
Primary LanguageTypeScript
Program languagePython (Language Count: 8)
Platform
License:MIT License
所有者活动
Created At2018-02-21 12:20:36
Pushed At2025-05-17 15:38:04
Last Commit At2025-02-08 12:19:01
Release Count81
Last Release Name2025.1.1 (Posted on )
First Release Name0.9 (Posted on )
用户参与
Stargazers Count429
Watchers Count20
Fork Count75
Commits Count4.5k
Has Issues Enabled
Issues Count539
Issue Open Count97
Pull Requests Count1015
Pull Requests Open Count3
Pull Requests Close Count39
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private