# PlanarAlly

**Repository Path**: kco_github/PlanarAlly

## Basic Information

- **Project Name**: PlanarAlly
- **Description**: No description available
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-20
- **Last Updated**: 2023-11-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center"><a href="https://planarally.io" target="_blank" rel="noopener noreferrer"><img width="200" src="https://www.planarally.io/logos/pa-logo-background.svg" alt="PlanarAlly logo"></a></p>

<p align="center">
    <a href="https://github.com/Kruptein/PlanarAlly/releases"><img src="https://img.shields.io/github/downloads/kruptein/planarally/total.svg" alt="Downloads"></a>
    <a href="https://github.com/Kruptein/PlanarAlly/releases/latest"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/kruptein/planarally"></a>
    <a href="https://discord.gg/mubGnTe" title="Join the discord server!"><img src="https://img.shields.io/discord/695640902135185449?logo=discord" alt="Discord invite button" /></a>
    <a href="https://planarally.io" title="Visit the planarally documentation"><img src="https://img.shields.io/badge/docs-read-lightblue.svg" alt="Documentation site button" /></a>
    <a href="https://patreon.com/planarally" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-red.svg" alt="Patreon donate button" /></a>
</p>

# 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](https://www.planarally.io/server/setup/external/)._

Releases of PlanarAlly can be found on [the release page](https://github.com/Kruptein/PlanarAlly/releases).

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

# Documentation

User documentation can be found [here](https://planarally.io/docs/).

If you wish to contribute to the docs, they are hosted in a different [repository](https://github.com/Kruptein/planarally-docs).

# 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](https://patreon.com/planarally)

![Example view of a player with a light source](https://github.com/Kruptein/PlanarAlly/blob/dev/extra/player_light_example.png?raw=true)
_Credits to Gogots for the background map used [source](https://gogots.deviantart.com/art/City-of-Moarkaliff-702295905)_