All notable changes to this project will be documented in this file.
[DM] denotes changes only useful for the dungeon master [tech] denotes technical changes
- Aura not displaying when token is outside the visible canvas
- Dialog background was cut on the right side in some browsers because max-width was set to unreasonably low value
- Entire page some times became scrollable in some browsers because body overflow was not set to hidden
- Shape invisible toggle
- Only players with vision access can see and interact with the shape
- Public auras are still visible to all players (e.g. invisible creature with a torch would still shed light)
- Build/Play mode
- Show different set of tools dependening on the active mode
- Movement access permission
- Changelog modal if a new version comes out
- Spawn locations
- Define where shapes you move to other locations are spawned
- Public toggle to ruler tool
- Shape locked toggle
- When locked, a shape cannot be moved/resized
- Locked shapes can only be selected if no non-locked shapes are included in the selection area
- Ctrl+l is a keybinding to toggle lock state of a selection group
- Internationalization base
- English as default and fallback locale
- Chinese localization
- German localization (some terminology like "Asset" or "Tracker" still english, until appropriate German term found)
- Russian localization
- A dropdown selection component to switch languages in both login page and the Client Options of main menu
- During shape drag/move use a smaller version to do hitbox tests
- This improves behaviour when going through a very tight hallway or a door
- Delayed initiative updating during edit
- In Play mode (see #added) the select tool will no longer allow resizing
- Creating a new floor will no longer automatically move everyone to that floor
- The version shown in the topleft area in-game will now be limited to the latest release version
- Basic tokens will now have their default name set to their label instead of 'Unknown shape'
- Mobile device users are now unable to trigger overscroll refresh by simply moving around
- Polygon points now also respect grid snapping as all other shapes do during draw
- Polygon server creation with initial vertices list breaks session
- Player floor location not being remembered
- Ruler not showing decimal points
- DM settings/grid unit size showing invalid input on firefox for floating point numbers
- Server showing JSON decode errors
- Players not being able to update initiative effects
- Active layer sometimes resetting on reload
- DMs no longer being able to kick themselves
- Some UI components not properly updating on shape reset
- Area right of layer selector preventing draw/select
- Keyboard center throwing error when no tokens are defined
- Multiple bugs with initiative syncing
- Three bugs with location specific options not properly loading/saving
- Scrollbar on bottom of page in firefox when location bar does not fit the screen
- Players can no longer remove or add floors
- Players can no longer move their shape to other layers/floors/locations themselves
- Bug where a light source with 0/0 radii would block all lights of that shape
- Schema differences between new saves and older saves
- Location removal failing on the server
- configuration option to specify allowed CORS origins
- alt modifier can be used to disable draw/resize snapping
- Client option to invert the ALT behaviour (i.e. invert snapping behaviour)
- Logo, version info and some urls to the topleft section which is only visible if both locations bar and menu are opened
- Search bar to asset menu
- Some basic tooltips to icons
- Tiered configuration. Configuration file in the data directory takes precedence over one in the folder with server files. Useful for docker deployments to keep the configuration in a volume
- Use spacebar to cycle between your owned tokens
- Aspect ratio lock with ctrl modifier
- Progressbar to the asset manager
- Location rename
- Location removal
- Upon floor change all players with edit access will auto move to the same floor
- Set any shape as marker and jump to that position from the sidebar [LDeeJay1969]
- Initiative token images now have their name shown on hover
- Shape access
- Now uses a dropdown prefilled with players so you no longer need to manually type it
- Option to choose full edit access or only vision access
- Default access to specify behaviour for non selected players
- Map tool UX
- Now gives a bit more information on how to use it
- After making a selection you can adjust it to better fit your needs
- Choose the X/Y numbers after selecting the shape
- The center of the drawn resize rectangle now will remain in the exact same place after resize. This prevents sudden map jump.
- Shape resizing
- Now only snaps the point you're resizing instead of an awkward complete shape resize
- Location bar reworked
- Move around as a DM without bringing your players along
- shows which players are in which location
- now has UI to move groups of players as a whole or individually to other locations
- Location settings
- DM options is now used to configure the default settings
- Locations have their own setting menu to override the defaults
- Default brush size is now 1/10th of the grid size instead of the full grid size
- Polygon width now properly taken into account when trying to select it
- Floor/Layer bar now moves along with the side menu when opened
- Side menu and locations menu no longer overlap
- Window resizing messing with the lighting borders
- Previous prompt values are now cleared before showing a new prompt
- Asset manager not showing uploaded files until refreshed
- Asset manager contextmenu not rendering correctly when scrolling down
- Grid layers of al lower floors being visible
- DM being able to invite themselves to the room as a player
- Removing a file in the asset manager now deletes the file on the server
- Draw tool no longer delays rendering brush helper after layer/floor change
- Active floor is remembered upon rejoining the session
- Clientside access violations
- shape keyboard movement
- shape delete
- shape copy
- All of the above were only visible on the client issuing the 'illegal' inputs, they were always rejected by the server and thus not synced to other players
- Favicon
- Only show snap points visually for the DM
- This could otherwise expose hidden things to players.
- Use grid toggle not working properly
- Show badge toggle not always synchronizing
- Moving shape to a different layer no longer leaves the old selection box around
- Keyboard movement not synchronizing
- Account Settings
- Set email address
- Change password
- Delete account
- Snap to nearby existing points while drawing and while resizing points
- CTRL-0 (zero) now resets the viewport to origin (0,0) [LDeeJay1969]
- Floors
- Create/Delete floors that are rendered on top of eachother to increase immersion
- Use Page Up/Down as a quick keybinding to move between floors
- Use Ctrl + Page Up/Down to move shapes across floors (combine with Shift to immediately move the camera as well)
- Touch Gestures [ZachMyers3]
- Easier client traversing by removing _load route [ZachMyers3]
- Display current version on client [ZachMyers3]
- Shape badges
- Toggleable badge display showing the shape's group number
- Logo to the planarserver.exe
- New experimental vision mode
- Recalculates vision based on small changes instead of recalculing the entire scene.
- When resizing on mouse up, a different method will be used to resize/snap the shape to the grid
- Annotations stop working when changing location
- Cursor resize icon not correct in multiselect
- Movement of shapes not working 100% correctly
- In particular, moving a group of tokens now behaves correctly and doesn't suddenly jump around
- Resize of rectangle shapes (and assets) working in all directions
- Bug where shapes moved by players would remove auras/trackers from shapes for the DM
- [tech] Client build artifacts are no longer available in the server folder
- Legacy bvh vision mode
- JS build files being out of date.
- Shapes not syncing on mouse move.
- Option to set custom units of length (defaults to ft)
- Ping tool
- Option to change the location of tokens/shapes
- Option to edit shapes in groups (move to other layer, move to other location, move to top/bottom, add initiative)
- Option to Ctrl-select tokens/shapes
- Default right click menu to all tools that didnt have it
- Colour in the location bar to show current location
- Polygon tool options
- brush size (defaults to 1 grid cell in width)
- closed/open polygon toggle, when enable automatically connects first and last point.
- Escape cancels draw tool actions
-
Pasted shapes are now pasted relative to the screen position
-
Login page now autofocusses on the username input field.
-
All shapes on the FOW layer are now invisible while not on the FOW layer.
-
Circle borders (including basic tokens) are now inset, so that they fit within their squares.
-
Basic token text scaling has been changed slightly to have more uniformly sized characters.
-
[tech] Mousemove events are now throttled, so that they don't fire a gazillion events.
-
[tech] tslint swapped out for eslint
-
[tech] Refactor Layer.draw to use Shape.drawSelection
-
[tech] Refactor most uses of forEach to for..of
-
[DM] Session lock state not being shown correctly upon joining.
-
Sessions with a slash in their name do not work
-
Ruler width not being the same at all zoom levels.
-
Brushhelper sticking around on layer change.
-
Temporary shapes not being properly cleared on player disconnect.
-
Private shape auras, trackers, labels and name being revealed during movement.
-
Fix light auras clipping over walls.
-
Fix bug with circle draws using negative radii.
-
Polygon preview segment always showing up as black.
-
[tech] Improved docker image creation script
- Faster compilation and smaller final size
- Now the frontend is also compiled inside a container
- Issue with MIME-types of .js files being wrongly reported as text/plain.
- The DM options menu is now a proper dialog.
- Options are sorted by catecory.
- A list of players with access to the session is shown with an option to kick them.
- A url is shown for the invite url so you no longer have to figure this out yourself.
- A button to refresh the invite url is now present.
- A button to remove the session is added.
- A button to (un)lock the session is added.
- Shape updates often causing unnecessary lighting recalculations.
- Option to listen on a socket instead of HOST:PORT.
- Vision tool to change active tokens.
- Vision lock button to initiative to only show vision of current actor.
- This only applies to tokens the player owns for other tokens the normal vision is restored.
- This is purely client side and can thus be chosen by player/DM separately.
- Camera lock button to initiative to automatically center on current actor.
- It will center when an actor begins its turn and the client is owner of that actor.
- It does not prevent camera movement after the initial center action.
- Automatic build of windows executables on azure pipelines for all tags
- These will also create a github release automatically
- Fake player button to DM Settings to disable all DM functions except DM settings.
- You can control which player(s) you want to emulate with the vision tool.
- Filter tool is only visible if there are labels defined.
- Fix a bug causing labels without category to throw errors.
- CSS bug with menu.
- Bug making it impossible to remove trackers/auras.
- Windows build being completely broken.
- Upgrade from save format 12 to 13 failing in some cases.
- Keybinding to toggle UI (ctrl+u).
- Keybinding to copy selection to clipboard (ctrl+c).
- Keybinding to paste clipboard to board (ctrl+v).
- Labeling system.
- You can add labels to shapes.
- You can filter the gameboard on these labels.
- Asset preview now disappears when starting a drag asset action.
- A mouse down in general will now trigger layer or tool selection.
- In the past a 'click' was required, now any 'mousedown' will trigger.
- Zoom scale has been modified.
- Select tool can now also select shapes not owned by the player.
- The selection info box is shown with all info visible for the user.
- The tokens cannot be dragged or resized.
- Groupselect will only select your own tokens.
- Some minor style changes to the edit asset dialog
- Shape names can now be hidden from other users.
- Default vision mode changed to triangle mode. Legacy vision mode (bvh) can still be selected in the DM options.
- Bug causing rulers to stick on DM screen.
- Bug causing rulers to not appear on other screens.
- Drag and drop asset on firefox redirecting to random urls.
- Some eventlisteners not being removed properly.
- This caused zoom behaviour to mess up when leaving and joining a room multiple times.
- Bug causing players not being able to add or update initiative effects.
- Bug causing shown initiative effect to be one lower than it actually is on location load.
- Move layer to/from DM layer having broken results for players untill a refresh of the page.
- Bug causing some windows (e.g. initiatives) to no longer appear.
- Vision bugs at different zoom levels caused by the world boundary being too large.
- Reduced boundary location from 1e10 to 1e8.
- Bug causing the vision recalculation not happening in a lot of cases.
- Some old css files.
- Registered users had to logout and login again before being able to perform actions.
- [tech] Javascript files being wrongly served as plaintext in some obscure cases.
- A lot of things breaking due to a bug in shape ownership.
- Polygon shape in the draw tool.
- This is especially nice in combination with the new experimental vision mode!
- [DM] Options to set the minimal and maximal vision ranges when using LOS.
- A radial gradient is applied starting from the minimal range and stopping at the maximal range.
- This effectively allows you to play with how far tokens can see.
- Autocomplete hints to the login form.
- Edit shape dialog now has options to change the border and fill colour.
- Shape properties can now also be opened from the contextmenu (i.e. right click on a shape).
- Wait with recalculating vision until all shapes are added on startup.
- Vision mode toggle has been moved to the DM options and is now synced with the server.
- Fix visionmode menu toggle not remembering what is currently selected.
- SelectionHelper mistakenly geting send to the server.
- SelectionHelper sometimes getting moved to a different layer instead of the actual shape.
- Some small QOL changes to multiline.
- Logout routing.
- Active location not being remembered by server.
- Notes not getting cleared on location change.
- AssetManager shift selection causing double selections.
- AssetManager issues with (re)moving files.
- Player location not saving properly.
- Prevent duplicate owner entries for a shape.
- Multiple bugs with triangle vision
- Static images were accidently no longer checked into the repository.
- DM layer was not being sent by the server.
- A new vision system has been added based on triangulation.
- You can select this new system as a client option
- It is more precise (i.e. exact) than the previous vision system which was a good approximation.
- It can handle any polygon under any angle, so expect some new draw tools in the future!
- It is slightly more expensive to preprocess, but this should be relatively unnoticeable.
- Draw tool mouseUp behaviour had some strange quirks that are now ironed uit.
- In particular this prevented some shapes of being synced correctly.
- Added curl to docker container for proper health check
- Remember which layer was selected last time [Issue 109]
- [tech] Shape index unique constraint dropped to simplify some code
- [tech] Massive overhaul of the code organization
- [tech] Moved from manual webpack config to vue-cli
- [tech] Moved to a single page application with vue-router
- Backspace key added as delete action (Fixes Mac OS X delete behaviour) [Issue 69]
- Added host config option to docker config file
- Moving shapes to another layer would not always succeed at the server [Issue 108]
A collection of small improvements and fixes.
- host option in server_config.cfg [Issue 99]
- GridLayer.size from IntegerField to FloatField [Issue 105]
- Location.unit_size from IntegerField to FloatField [Issue 105]
- Tokens appear as black/red with all lighting settings disabled [Issues 90/91]
- Trackers and Auras were not saved server side. [Issue 106]
Hotfixes for 0.10.0
- Drag and Drop file uploading fixed
- New location creation fixed
More hotfixes for 0.10.0
- Asset uploading
Another hotfix for 0.10.0.
- Actually fix the user creation bug for once.
Another hotfix for 0.10.0.
- Made a woopsie while fixing the earlier user creation error.
This version contains hotfixes for the 0.10.0 release
- Save file was not generated at the right time causing errors when no save file exists during startup
- User creation was broken
IMPORTANT: READ THIS FIRST
This version is part 2 of a 2 part upgrade process of the save file. A completely new and different save format is going to be used in the future and this requires a drastic change once, (which is now)
If you are about to install/use this release you either have completed part 1 (release 0.10.0) or you are starting from a new save file. END IMPORTANT
- [tech] Save file format is changed to sqlite!
- Shape grid snapping not getting synced on draw
- Select tool no longer selected by default on load
- Add new location action messed up websocket rooms
- CircularTokens created by non-DM users now properly set owner
IMPORTANT: READ THIS FIRST
This version is part 1 of a 2 part upgrade process of the save file. A completely new and different save format is going to be used in the future and this requires a drastic change once, (which is now)
In this first part a script is added to convert an existing save file to the new format. Once this conversion is done, you should continue with part 2 which is the next release.
THIS RELEASE WILL ON PURPOSE NOT RUN CORRECTLY TO MAKE SURE THE UPGRADE PROCESS IS FOLLOWED AS EXPECTED.
You have a save that you wish to convert
Make sure you are in the "PlanarAlly" folder containing the "planarserver.py" file. (If you are in a PlanarAlly folder with another PlanarAlly subfolder, you need to open the subfolder).
Run the script python ../scripts/convert/database.py <save_file>.
(if save_file is ommited, the default save file location "planar.save" is used)
If all is well this should generate a planar.sqlite file.
You have no existing save or don't care about your save
You can completely skip this release and go straight ahead to the next release.
END IMPORTANT
Aside of the major save file changes, some other things are present in this release cycle.
- Option to choose save file location [contributed by Schemen]
- The server config now has an option to specify a different save file name and/or location.
- Dockerfile [contributed by Schemen]
- A dockerfile is now present to support deployment in docker containers
- VERSION file in the python folder
- This will be used in the future to detect software updates
- Unable to drag modal dialogs in Firefox
- Unable to drag assets in Asset Manager in Firefox
- Empty asset and note list was to small for icons
- Tools started with lowercase
- Radial menu buttons had border when clicking them
The save format has been changed from version 1 to 3, that's 2 increments in one release yes. This is due to the size of the release involving multiple new features that involved separate changes that were developed in parallel to eachother.
As always make sure to back up your old saves before converting!
To update run both python ../scripts/convert/1_to_2.py and python ../scripts/convert/2_to_3.py from within the same folder as your save files.
The way assets are stored on disk and managed in game has completely changed. You'll no longer be able to manage your assets from your file manager or command line, and will have to use the in-browser tools to work with them. This is a change that was required in order to provide extra features to the assets while preserving disk space. (e.g. personal assets / share assets / default templates / ... )
Assets are now stored in /static/assets/ instead of /static/img/assets/. In order to keep your current saves working (if they have assets that rely on the old image locations), the old folder is kept intact and will not be removed. You are free to do with this folder as you please as it is no longer used by PA itself.
- Added a note system
- Initiative tracker update
- Now shows the active actor and has a next turn button
- Shows the current round number
- Turn/Effect timers per actor that automatically count down
- Show a border around shapes on hover in the initiative list
- New Asset management panel
- Out of game way to organize assets
- Upload files via a dialog or by dropping them on the manager
- Rename/remove files/directories
- move files/folders to other folders
- Freestyle brush has been added as a draw shape
- FOW usage is limited
- Currently only works when global fog is applied.
- Works when used from the draw tool in reveal/hide mode
- Does not properly work in normal mode on the fow layer!
- In general: Use it to draw on non-fog layers or use it in reveal/hide mode
- FOW usage is limited
- [tech] tools onSelect and onDeselect for more finegrained tweaking and UI helpers
- Option for players to select the colour of their rulers.
- Renamed 'Tokens' to 'Assets' in the settings panel
- Redesigned the way assets are shown in the settings panel
- A tree view approach is used, showing preview images on hover
- Removed the cog wheel
- A button to open the asset manager is added to the in-game interface.
- Draw and fow tools have been combined in one singular draw tool
- Options between 'normal' mode and either 'hide' or 'reveal' mode if you want to draw fog
- Fog is now always drawn in the client's active fog colour
- Also shows a brush tip while moving the mouse
- Dim aura range should no longer include the normal range value
- e.g. an aura that used to be 20/60 should now be 20/40
- [tech] Most UI is now rendered using the reactive Vue.js framework instead of JQuery
- Draw order changed
- First all auras are drawn and then all shapes are drawn
- This prevents auras overlapping shapes
- Shape order is still respected
- Select box not working properly on the fow layer
- Ownership changes are now reflected in the initiative list
- Dim value aura's had the wrong radius
- Dim value aura's nog properly work with light sources.
- Instead of halving the opacity, the radial gradient is applied across the entire aura + dim aura radius.
- Deleting multiple shapes no longer sends the selectionhelper to the server
This release greatly increases performance of all lighting modes and also properly introduces Line of Sight based lighting system.
SAVE_FORMAT CHANGED FROM 0 to 1
BACKUP YOUR OLD SAVE BEFORE CONVERTING!
UPDATE YOUR SAVE BY EXECUTING python ../scripts/convert/0_to_1.py FROM WITHIN THE PlanarAlly FOLDER THAT CONTAINS YOUR SAVE FILE, THE SERVER CONFIG AND THE OTHER PYTHON FILES!!!
- Show initiative action is added to the general context menu
- [tech] A Bounding Volume Hierarchy ray tracing accelerator is used.
- This greatly! improves the performance of all lighting including the experimental LoS based lighting.
- [tech] multiple debugging flags under Settings.
- [tech] extra layer added that is used for fow. Now two layers are responsible for this.
- Right clicking will now only show a shape specific menu if it was done on a selection
- All other right clicks will show the general purpose context menu
- Light auras now properly follow the actual path formed by vision obstruction objects
- FOW layer drawn shapes now retain their proper colour used during drawing.
- Movement that is normally grid-snapping will go out off grid if it stops against a movement blocker
- [tech] Cleaned up the Vector class, splitting it up in a Vector and a Ray class
- Vector: purely direction indication
- Ray: combination of an origin point and a vector
- [tech] A much more performant ray box intersection algorithm is used
- Shapes no longer get stuck in movementblockers on occassions
- Auras were ignored in the visibility check during layer shape draw
- assets dropped on canvas are no longer tagged as token
- Tokens should only be used for actual player representatives
- Rough background to the annotation field to make it more readable
- Annotations correctly position centered on the screen
- Annotations correctly wrap words to the next line
- Delete key no longer removes shapes while in input fields.
- Scrolling only zooms when a canvas is targetted.
- Exit button now correctly positioned when token list is large
- shapes moved with arrow keys were not being synced to the server
- assets dropped on canvas are immediately tagged as token
- [DM] Using the shift key, shapes can move freely through movement blocking terrain.
- Pressing 'd' now deselects everything
- Arrow moves will move assets when they are selected instead of the canvas.
- The canvas will still be moved if no shape is selected
- [DM] Shift key can also be used to pass through terrain.
- Shape drawing now uses same behaviour in regards to grid snapping
- by default shapes will resize to fit the grid
- when alt is pressed on mouseUp during drawing or if the grid is disabled, the shape will not resize to grid.
- Only tokens will have a minimal vision aura
- Add DM settings option to enable Line of Sight based lighting
- Disable LoS based lighting by default
- Deleting a selection of assets should now behave correctly. (Sometimes not all assets would be deleted)
- Added an exit button in-game
- This will now bring you back to your sessions
- Also added a new logout button to the sessions menu
- Add token toggle to shape settings
- Line of sight based light for tokens
- Only see lights that fall in your line of sight
- Improved the visuals of the toolbar and layer manager
- Multiple large light/shadow related performance improvements for firefox
- Chromium based browsers had slight improvements but already were (ans still are) much more performant in regards to FOW calculation
- Shapes that do not have an associated image, now show their name or token tag in the initiative dialog
- The dim value attribute of auras was wrongly used as the normal aura value
- The grid is now redrawn at the same time as the other layers instead of immediately
- The light source toggle on shapes now immediately redraws the screen
- Map tool properly works in all directions again
- Sessions with spaces not working
- Assets with ' not appearing correctly in the token list
The great bugfix release
- Bring players here function in the rightclick menu when nothing is selected
- This will bring over all players to the exact same pan and zoom settings as the DM
- Only the DM can access this
- Grid size DM UI works again. It broke in 0.3
- Cutoff zoom at 0.01 instead of 0, as zoom factors of 1e-16 caused issues with pages crashing
- Adding a new location did not correctly send some options to the client
- The annotation field in the edit asset dialog now prevents key presses to propagate to the board (e.g. no longer deleting shapes because you pressed delete in the textfield)
- The selection box now is smaller for very small assets
- Slowdown on the opening of the edit asset dialog throughout gameplay has been fixed.
- Location options not synced immediately
- Quick tracker/aura edits now work again
- Shape selection option is added to the draw tool, currently giving the option between a rectangle and a circle.
- More camera options
- Use the arrow keys to move 1 grid unit in the pressed direction
- Use the scroll wheel to zoom in and out
- Press the middle mouse button to pan without using the dedicated pan tool
- Quickly create simple circular text tokens
- right click anywhere that is not an active selection and select the 'create basic token' option
- You can insert any text and choose the fill and border colours
- Although singular letters or numbers work great, any text will be scaled to fit inside the circle, so longer texts can also work.
- Line width of shape borders increased to 5
- Various initiative issues with locations
This update is firstmost an update in regards to the development process so little to no new feautures are added in this release. A couple of important bugfixes are included though.
- A save file version is added to the save to possibly convert older saves in the future.
- A barebones annotation system for shapes
- You can add text to any asset using the edit asset dialog
- Whenever you mouse-over a shape you own the text will appear at top of the screen
- This is mostly a DM tool but players can use it as well.
- Websocket protocol now correctly chosen at the client side, this caused players to just see a blank scene in some situations
- Players on a different IP as the dm now actually see images.
- Pan and zoom options are now remembered per user AND location instead of only per user.
- MovementObstruction and visionObstruction were not immediately synced on toggle.
- Groupselect now behaves more predictable when one member collides with a movement blocker
- Move from 1 large javascript file to a proper multi file typescript system
- When dragging an asset against a movement blocker, it will smoothly slide across the blocker instead of completely locking up.
- Initiative tracker
- Right click on any asset and add it to the tracker.
- Options to hide initiative of certain assets
- The initiative of an asset will be removed on delete
- this can be disabled with the 'group' flag. This is very handy for minions with the same initiative.
- Every 5 minutes a save will be written to disk as an extra persistent layer.
- saves already happend on other occasions.
- The delete key no longer removes selected assets if used in an input field!