From 39f19aae48328ee1eb4fd6a39d72d83e44bb026d Mon Sep 17 00:00:00 2001 From: Darragh Van Tichelen Date: Tue, 18 Jun 2019 22:37:23 +0200 Subject: [PATCH 001/130] Update readme slightly to make downloads more obvious. --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bc7debff5..063db3ff4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![Total Github Download Count](https://img.shields.io/github/downloads/kruptein/planarally/total.svg)](https://github.com/Kruptein/PlanarAlly/releases) + # PlanarAlly _This project is still in early development; multiple bugs or structure changes can and will happen_ @@ -19,12 +21,20 @@ Some key features are: 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](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.readthedocs.io/en/dev/). -This is still a work in progress, so some elements may still be undocumented. -Installation instructions for DM's can also be found in the link above. As a player you won't have to install anything. +This is still a work in progress, so some elements may still be undocumented or outdated. + # Contributing From a0af705a00d0bec1f18b8b160a903853a9a9a772 Mon Sep 17 00:00:00 2001 From: Darragh Van Tichelen Date: Fri, 21 Jun 2019 09:51:16 +0200 Subject: [PATCH 002/130] Small doc changes --- docs/conf.py | 2 +- docs/getting_started.rst | 26 ++++++++++++++++++-------- docs/installation.rst | 34 ++++++++++++++++++++++++++++------ docs/lighting.rst | 4 ++-- 4 files changed, 49 insertions(+), 17 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index d1af3995f..fe1238f2b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,7 @@ # -- Project information ----------------------------------------------------- -project = 'Planar Ally' +project = 'PlanarAlly' copyright = '2018, Kruptein (Darragh Van Tichelen)' author = 'Kruptein (Darragh Van Tichelen)' diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 9904e5850..0ffeed706 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -3,11 +3,11 @@ Getting Started ================= -This document will show you how to get started using Planar Ally. +This document will show you how to get started using PlanarAlly. If you are a player you can immediately continue to :ref:`login`, if you're a DM, -you'll first need to decide where/how you want to run PlanarAlly. +you'll first need to decide whether you want to host PlanarAlly yourself or use an existing service. See :ref:`installation ` for more info . @@ -62,9 +62,7 @@ Joining a new session To join a specific session, you need the invite link. Your DM should provide this to you. -When visiting this link, -you'll automatically join the session and in a future visit -to the session hub it should be listed as well. +When visiting this link, you'll automatically join the session. The game --------- @@ -95,7 +93,8 @@ We'll give a brief overview of these UI elements soon, there is however another When you select a token that you own, a red border will be drawn around the token to visually give a reminder of what you have selected and on top of that -a box appears at the right side of the screen, with the name of the selected token as well as any tracker or aura active on the token (more on that later). +a box appears at the right side of the screen, with the name of the selected token +as well as any tracker or aura active on the token (more on that later). .. image:: images/player-selection.png @@ -134,6 +133,8 @@ Pressing `Delete` will delete the current selected token. Pressing `d` will deselect your current selection. +Pressing `Ctrl+U` will toggle the UI. + Mouse ^^^^^^ @@ -230,7 +231,7 @@ When in select modus, your right mouse button will show a context menu. When you right click a selection, you'll have the option to move it to the front or back and -add or show its initiative. +add or show its initiative. Additionally you can also get the detailed properties of the selected object. When nothing is selected, you'll have the option to show the initiative tracker or create a new basic token. Pan @@ -249,7 +250,7 @@ Draw The draw tool allows you to draw some simple shapes! -You can choose between a rectangle, a circle, or a freehand brush. +You can choose between a rectangle, a circle, a polygon or a freehand brush. You also have the option to select two colours. The left colour is used as the fill colour, @@ -291,6 +292,15 @@ While holding the button it will show you the distance in ft between your initia Your DM can configure the size of one grid cell, which is used to calculate the distance the ruler shows. +Vision +^^^^^^^ + +*This tool is only visible if you own multiple tokens.* + +When you control multiple tokens, you typically see the vision of all your owned tokens combined. +In some cases however you would like to get the perspective of just one of these tokens. +With the vision tool you can choose which tokens should contribute to your current vision. + Map ^^^^ diff --git a/docs/installation.rst b/docs/installation.rst index 7df9131af..e9e28dd2d 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -5,11 +5,12 @@ Installation As the DM you'll have to decide where you want to host your game. You can either use some service that hosts PlanarAlly for you, -or you can host PA yourself, which requires a bit more setup. +or you can host PA yourself. .. note:: This only has to be done by the DM and is not relevant for normal players. + Using existing services ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -20,6 +21,9 @@ Using existing services The easiest setup is to use some existing online service. At the moment of writing the only active service I'm aware of is `dndbox `_. +Using this method, gives you an instantly available service that requires no installation on your behalf. +The downside of this method is that you completely rely on the service and you cannot use it to play offline. + Self-hosting ~~~~~~~~~~~~~ @@ -33,23 +37,26 @@ Self-hosting involves 2 steps: * Installing/running the software, * Configuring your network correctly so that other players can join. +.. warning:: + If you ever want to upgrade PA to a newer version, be sure to read the remarks in :ref:`upgrading`. + Installation ************* For installation you again have two options: * Precompiled binary -* Manual installtion +* Manual installation -The first option is easier, but is only available on Windows currently, -and I do forget to create it from time to time. Feel free to ping me if I do. +The precompiled binary is the go-to method if you're not super techsavy and if you use Windows. +In all other circumstances, you'll have to manually install PlanarAlly. Precompiled binary ^^^^^^^^^^^^^^^^^^^^ -These are typically only provided for major releases and can be found `here `_. +The binaries are created for each release, which can be found `here `_. -1. Download the latest planarserver.zip +1. Download the latest planarally-windows.zip 2. Extract it to a folder on your server. 3. Run the server by executing `PlanarAllyServer.exe`. 4. Optionally you can configure the server in the `server_config.cfg` file. @@ -101,3 +108,18 @@ Download and install the latest python 3 version from `the python site