Release 2024.3

For more details on what's new checkout https://www.planarally.io/blog/release-2024.3/

[2024-11-12] A hotfix has been released that addresses a db corruption when removing Characters. See #1512 for details. The assets in this download section have been updated.

planarally-bin provides a prebuilt client, with a python server that you'll need to run yourself.
planarally-windows provides a compiled executable that can simply be run by double clicking the exe in the planarally-windows-2022.3 folder.

Check the documentation over at https://www.planarally.io for more info

The changelog for this release:

Added

• Optional simple chat system
  • This is not stored serverside, so messages will be lost on refresh or later re-opening of the session
  • Chat is basic markdown aware, but does not allow direct HTML
  • (image) urls can be pasted without special markdown syntax
  • Can be collapsed by clicking on the chat title
• Collapse Selection: Temporarily move all shapes in the selection under the cursor for easier navigation through corridors
• [DM] new DM settings section: Features
  • Can be used to enable/disable certain features campaign wide
  • Currently limited to chat & dice

Changed

• Select tool:
  • now integrates all the ruler toggles in its UI as well
  • these toggles are synced with the ones in the ruler
• Spell tool:
  • now renders hexes instead of squares in Hex grid mode
  • step size changed to 1 in Hex grid mode
  • shape bar is no longer visible, only hex is available in hex grid mode for now
• Ruler tool:
  • now defaults to sharing with other users
• Dice
  • non-3D mode
  • option to use a click interface to build dice strings
  • extra operators and selectors (e.g. keep highest 2)
  • 3D code & assets are only loaded when settin "use 3D" to true in the tool config for the first time
  • 3D physics now uses havok engine instead of ammo (babylonjs upgraded from 4 to 7)
  • history & result UI slightly changed
  • Option to share result with nobody
  • clicking on the notification of another player's roll shows the details
  • clicking on a history entry shows the details
• Toolbar UI
  • All extended tool UI is now right aligned fully, no longer hovering over the related tool
  • This was preventing tools to the left to be limited in screen estate they could occupy

Fixed

• Draw tool:
  • Clicking on the "blocks movement" label in the draw tool's vision setting now properly toggles the related checkbox
• Ruler tool:
  • Gridmode spacebar did not synchronize snapped end correctly to other players

2024.2

For more details on what's new checkout https://www.planarally.io/blog/release-2024.2/

planarally-bin provides a prebuilt client, with a python server that you'll need to run yourself.
planarally-windows provides a compiled executable that can simply be run by double clicking the exe in the planarally-windows-2022.3 folder.

Check the documentation over at https://www.planarally.io for more info

The changelog for this release:

Added

• New grid section in Edit Shape dialog
  • Configure manual size for shape
    • Used for finetuning snapping behaviour
  • Show grid cells the shape occupies
  • Configure hex orientation
    • This is used to determine which orientation even-sized shapes should use in hex grids
• Client Setting "Grid Mode Label Format" to decide what the ruler should show in grid mode
  • This can be set to either '#cells only', 'distance only' or 'both'
• Import: option to specify the name for the imported campaign

Changed

• Export/Import:
  • Error toasts no longer have a timeout
  • (Shape)Labels are no longer exported/imported
• Ruler tool: allows Unit Size less than 1.0
• Context menus have been restyled

Fixed

• Draw Tool:
  • snapping mode was also snapping to the point being moved
  • now also snaps to hex vertices
  • the first mouse press now also properly snaps to the grid
  • fix small point changes when flipping the rectangle axis while drawing
• Select Tool:
  • resizing in snapping mode was also snapping to the point being resized
  • polygon edit UI had a small visual glitch on appearance causing a circle to appear around (0, 0)
  • Snap to Grid:
    • This now has an implementation for hex grids
    • This should now more properly snap shapes that are larger than 1x1
• Ruler Tool:
  • Snap now properly works for hex grids
• Map Tool:
  • Now better supports hex grids
• Spell tool:
  • selecting another tool would swap to the Select tool instead
  • Change 'Size' input box to allow entering numbers less than 1 easily
• Polygon:
  • selection/contains check went wrong if a polygon used the same point multiple times
  • selection/contains check was also hitting on the line between the first and last points when not closed
• Moving shapes to front/back not updating immediately
• Export:
  • Missing Character, DataBlock and new Note data
  • Fixed note data migration crashing due to new format
• Import:
  • Prevent a potential timing edgecase causing import to run twice
  • If an import fails, the newly created (faulty) room will be removed
• Notes:
  • The filter was not properly rerunning when opening shape notes, causing notes from the previous shape to still be visible sometimes
  • When shape filtering, the shape name in the UI would change if you clicked on another shape with the select tool.
  • Note icons drawn on a shape could be drawn behind the shape in some circumstances.
  • Fix 'add shape' and 'remove shape' events not being synced immediately if you only have view access
  • Note icon on shape was drawn in strange locations for shapes larger than 1x1
  • Fix shape removal not properly removing the shape from related notes client-side
  • Fix notes not being stored in shape templates
• Groups:
  • The 'edit shape' groups tab was completely broken, this has been resolved
  • Multiple things in the groups tab have become more responsive to changes
    • Everything badge related is now updating as it happens
    • Members will now appear/disappear immediately
• Initiative:
  • Fixed an issue where Initiative.Order.Change would fail when called with some Shape Ids.
• Annotations:
  • Fixed rendering of markdown which included raw HTML elements.
• Changing client settings for the grid would not immediately update the screen

2024.1

For more details on what's new checkout https://www.planarally.io/blog/release-2024.1/

planarally-bin provides a prebuilt client, with a python server that you'll need to run yourself.
planarally-windows provides a compiled executable that can simply be run by double clicking the exe in the planarally-windows-2022.3 folder.

Check the documentation over at https://www.planarally.io for more info

The changelog for this release:

Added

• New location grid setting: drop ratio
  • This is used to indicate how shapes with size info dropped on the map should be resized
  • (e.g. a goblin_2x2 will take op 2x2 cells in any setup with dropRatio 1, with dropRatio 0.5 however it would only take up 1x1)
  • This addresses an issue where this was not properly working with non ft setups
• Selection Box UI now offers a 'clear' and 'select all' option if it's a multi-select popup

Changed

• Vision blocking shapes will now ignore themselves if they are closed
  • e.g. a tree trunk will be visible, but what's behind the tree trunk will remain hidden
  • Open polygons will behave as they have in the past
• Note system is overhauled
  • notes can now either be global or local (i.e. campaign specific)
  • notes can now be shared with other players
  • notes are now accessed through a special note manager
    • this provides filtering / creation / editing / ...
  • multiple notes can be popped out at once
  • popout notes can be collapsed and freely resized
  • popout notes are now markdown aware
  • If the text area of a note is still in focus after 5 seconds and an edit was made, a server save is done
  • see the release notes for all the changes
• Dice history now contains user and details
• Selection Info: auras are now toggle and rotation sliders instead of range modifiers
• [tech] ModalStack now supports dynamically inserted modals

Fixed

• Polygon edit UI: was not taking rotation of shape into account
• Teleport: shapes would not be removed on the old location until a refresh
• Dice tool: would not send zero results when dice list is empty
• Character: a collection of bugs with variants have been fixed
• Trackers: add max-height and scrolling
• RotationSlider: fix sync issues
• RotationSlider: fix slider anchor not sticking to the rail under certain angles
• [server] log spam of "unknown" shape when temporary shapes are moved

2023.3.0

For more details on what's new checkout https://www.planarally.io/blog/release-2023.3/

planarally-bin provides a prebuilt client, with a python server that you'll need to run yourself.
planarally-windows provides a compiled executable that can simply be run by double clicking the exe in the planarally-windows-2022.3 folder.

Check the documentation over at https://www.planarally.io for more info

The changelog for this release:

Added

• Character concept
  • A shape can be marked as a character
  • Characters can be dropped anywhere (by the DM), moving/teleporting the shape to the new location
  • This fills in a niche adjacent to the "Templates" concept
    • Templates allow configuration of common data before placement, allowing unique modification afterwards
      (e.g. useful for prefilling monster info)
    • Characters are a specific instance that remember their modifications (e.g. useful for (N)PCs)
• Sort campaign listing by recent play or alphabetically
  • Defaults to recent sort

Changed

• Assets removed in the asset manager will not remove the image on disk if there are still shapes depending on it
• Shape removal will now also remove the related image on disk if there are no other assets/shapes depending on it
• Circles used for shadows no longer use a square bounding box, but instead use a polygon approximating the circle.

Fixed

• Export: Campaigns with notes could fail to export
• Vision: Edgecase in triangulation build
• Kicking: The check to prevent the co-DM from kicking the main DM was incorrect
• Shapes: The angle of shapes while rotating was being rounded to whole integers, which is kinda awkard when dealing with radians
• Lighting: auras with both value and dim value set to 0 no longer light up the entire map

2023.2

For more details on what's new checkout https://www.planarally.io/blog/release-2023.2/

planarally-bin provides a prebuilt client, with a python server that you'll need to run yourself.
planarally-windows provides a compiled executable that can simply be run by double clicking the exe in the planarally-windows-2022.3 folder.

Check the documentation over at https://www.planarally.io for more info

The changelog for this release:

Added

• Drop new assets on the game directly
• Scroll-like touch gestures no longer attempt to scroll the gameboard out of bounds

Changed

• Templates no longer save certain settings
• Bring players no longer changes the zoom level of the players
• TpZone: When a player TP request arrives, the view area action will bring the DM to the trigger location and not to the target location

Fixed

• Group: No longer sending group info for each member (just once)
• Group: Shape group settings fixes
  • Create group button was not properly behaving
  • Remove group button was not immediately updating the UI until a reselection
• Group: Fix socket events no longer being listened to; Fixes multiple things that were resolved when you refreshed
• Auth: A logic error in the auth routing code - in some cases you had to manually go to the login page
• Templates: Missing some settings when saved
• Fake Player: Proper rework of access handling
  • Shapes and auras should now only be rendered if and only if some player in the game has vision access to that shape AND the shape is selected in the vision tool.
  • This also hides invisible shapes
  • This also hides all auras on the DM layer regardless of the vision tool
• Labels: Fix removal not working
• Toolbar: Fix vision and filter tools not immediately being available when relevant
• Access: Fix players with specific access rules, having edit access at all times
• Access: Changing access would not live update the edit shape UI if it was open by another client
• Access: Fix default access in UI not being up to date if shape has no access modifications until reload
• Access: Prevent DMs from having an explicit access rule
• Access: No longer gives full access for fake DM
• TpZone: Fix tp zone moving a player to a different floor not moving their view along (if 'move players' configured)
• TpZone: Fix non-immediate player initiated teleports not working correctly
• TpZone: Fix teleports initiated in build-mode not working correctly for players
• Logic: Request mode not working as intended and behaving as Enabled mode instead
• Token Directions: Fix shown tokens not taking filtered tokens into account
• Auras: Fix sometimes not being visible until a refresh or panning closer to the aura
• Rendering: Transparency of higher layers was no longer applied after a window resize
• Rendering: Some cases where vision access related changes would not rerender immediately
• Rendering: Grid not rendering horizontal lines when the width is smaller than the height of the screen
• Select: Rotation UI should stay consistent when zooming
• LocationBar: Fix width on drag handle for multiline locations
• Properties: Invisible toggle not applying until a refresh for players
• Initiative: Vision lock not properly checking active tokens
• Initiative: Removing the last entry while it's active could break initiative
• Vision: Edgecase that could cause an infinite loop when drawing vision lines
• Draw: Reduced number of points in brush mode significantly
• AssetManager: Fix progressbar missing
• Annotation: Markdown no longer rendering as bold
• [server] Subpath: 2 cases where subpath based setup was not properly loading images (initiative & change asset)

Release 2023.1

For more details on what's new checkout https://www.planarally.io/blog/release-2023.1/

planarally-bin provides a prebuilt client, with a python server that you'll need to run yourself.
planarally-windows provides a compiled executable that can simply be run by double clicking the exe in the planarally-windows-2022.3 folder.

Check the documentation over at https://www.planarally.io for more info

The changelog for this release:

Added

• Button to change the current asset for a shape to the shape property settings
• [DM] Quick access togglebar under the tool bar
  • Fake Player
  • Initiative active state (see below)
• Initiative now has a specific "active" state
  • This streamlines some things and allows some further future things without relying on the initiative window being open
  • The Initiative vision lock setting now only triggers when initiative is active
  • The above setting now also properly reverts to the original vision lock when initiative is no longer active as was always intended
  • The initiative UI is automatically opened for everybody once initiative is started. (and automatically closed as well)
  • The above behaviour can be disabled by a new user setting.
  • A new DM setting (under Varia) can be enabled to limit (non-DM) initiated movement only to the active initiative shape.
• Most modals will now move to the front when interacted with
• Most modals can be closed with escape

Changed

• Spell tool
  • range property is removed as it was confusing to people and a bit fiddly
  • a ruler is now automatically drawn between the spell shape and the selected shape
• Dice tool: Add min-height in dice tool UI where the dice to roll are being prepared
• [lang] The edit dialog for shapes now properly says "Edit shape" instead of "Edit asset"

Fixed

• Spell tool: spell on selection bugged
• Spell tool: fill colour behaving janky when border colour has <1 opacity
• Spell tool: right-click was opening the context-menu
• Spell tool: once used, the select tool was not being properly activated
• Spell tool: the 'is public' label was wrongly attached to the range input box
• Fake Player: showing DM layer
• DM settings: Fix last DM being able to demote themselves to a player
• DM settings: Fix invite URL not containing subpath if set
• Assets: default stroke colour wrongly set, causing badges to be transparent
• Trackers: Display on token not working for trackers that are shared across variants
• Some cases where a client could edit shape info without access
  • this was always rejected by the server and never synced
  • most tracker properties
  • defeated and locked state using keybinds
• Prompt modals sometimes still using a validation check from an earlier prompt
• Resizing the botright corner of a rectangle-based shape while rotated was moving the shape
• Token direction UI triggering when other UI is on top of it
• Floor detail UI not moving along if side menu is opened
• Unlocking shape could sometimes trigger the shape following your mouse
• Templates: only using the first character of the provided template name
• Asset Manager: close contextmenu when scrolling
• Asset Manager: contextmenu appearing in the wrong location when scrolled
• Adding multiple shapes to group always prompting group question even if no groups are present

Release 2022.3

For more details on what's new checkout https://www.planarally.io/blog/release-2022.3/

planarally-bin provides a prebuilt client, with a python server that you'll need to run yourself.
planarally-windows provides a compiled executable that can simply be run by double clicking the exe in the planarally-windows-2022.3 folder.

Check the documentation over at https://www.planarally.io for more info

The changelog for this release:

Added

• Pan with right-click drag
• User configuration option to limit rendering to only the active floor
• User setting to change toolbar between icons and words (defaults to icons)
• Out-of-bounds check with visual UI element to help people get back to their content
• Show off-screen token directions
• Import/Export
  • Export now redirects to a separate page
  • Both Import and Export now have a status prompt, giving more clarity that things are happening
  • New game now offers a selection between an empty campaign or importing a campaign
• Individual die results are now also shown
• [DM] Players section in the left in-game dm sidebar
  • Lists players connected to the session
  • Clicking on a name, centers your screen on their current view (if on the same location)
• [server] option to specify alternative location for static files

Changed

• Draw tool vision and logic tabs will now have a background colour if they are active as a reminder
• Dashboard UI has been updated (once again)
• Quick tracker/aura changes
  • Now supports more complex expressions (most mathematical expressions should work)
  • Now has a toggle between absolute and relative mode
  • A new Client Setting - Behaviour has been added to set the default update mode (absolute vs relative)
• [DM] Asset Manager UI has been updated and is now integrated with the main dashboard
• [DM] Player viewport rectangles are now shown per client connected for that player instead of 1 rectangle following the latest move
• [DM] Hiding a token using the vision tool will now also hide their private light auras
• [server] moved all python imports to proper relative imports
  • this changes the way to manually run the server (again) (sorry)
• [tech] keep shape centers in memory instead of recalculating on the fly

Fixed

• Vision tool alert state was not always accurate
• Teleport zone not properly triggering when initiated as a player
• Teleport zone not properly landing in the center of the target
• Player door toggles not syncing to the server/persisting
• Shared trackers/auras not showing up in selection info
• Shared trackers/aruas removal not showing in client until refresh
• Errors in prompt modals were not visible
• Annotation visible info not syncing to other clients until refresh (UI only)
• Player state clearing on location change
• Zoom sensitivity on touchpad
• Typo in location menu
• Multiple Initiative bugs
  • Server should detect client errors in initiative listings better and reject wrong data
  • Modification of the initiative should retain the current active actor under more circumstances
  • Removal of shape caused some initiative inconsistencies
  • Changing between DM layer and player visible layer would trip up initiative sometimes
• In-game AssetPicker modal UI fixes
• Prompt modal not clearing error message properly
• Tool details not always being in the correct location (e.g. when changing mode)
• Trim down noisy whitespace in selection info
• Initiative camera-lock not changing floors
• Door/Tp area preview not changing floors
• Jump to marker not changing floors
• Moving composite/variant shape to other floor and following would show extra selection boxes
• Draw layer being rendered below the fog (e.g. rulers/ping etc)
• Vision not properly recalculating when removing blocking shapes on multifloor setups
• AssetPicker UI appearing too low
• Polygon edit UI being left behind when panning
• Moving polygon point when polyon is rotated
• Normal shapes sometimes wrongly being identified as spawn locations
• Dice sometimes going offscreen
• Keyboard movement not moving select-tool's rotation helper
• [DM] Assets not being able to moved up to parent folder
• [DM] Assets not being removable if a shape with a link to the asset exists
• [DM] Annotations still being visible until refresh after removing player access
• [DM] Resetting location specific settings was not immediately synchronizing to clients until a refresh
• [DM] Enabling fake-player mode would hide the DM entries from the left sidebar
• [DM|server] The asset manager was no longer useable when using a subpath setup
• [server] Diceroller not working on subpath server

Release 2022.2.3

This is a very small fix release for a bug in the Windows executable builds.
There is no need to upgrade if you do not use the Windows build.

Fixed

• [server] Windows executable builds not using the correct directory for certain files (e.g. config/assets)

Release 2022.2.2

In my haste to fix something with the import/export in 2022.2.1 I made a mistake which causes the server to no longer startup if a certain python dependency is not installed.

This release fixes that problem, as well as a problem with auras and initiative that came up during a play-session earlier in the week.

A technical change is that the database is now loaded in sqlite WAL mode with synchronous set to 0. This should make import functionality safe(r) to do in servers where multiple users could be doing things while someone imports. This should have no noticeable impact otherwise, but if you do notice issues, let me know asap!

Changed

• [tech] Use WAL mode for database

Fixed

• Auras giving light when light source is turned off
• Ghost initiative entries showing up as ? that cannot be removed
• Database lock errors while importing during load
• [server] Server not being able to start due to ModuleNotFoundError

Release 2022.2.1

This hides the export/import behind a server config option as I found an important underlying concurrency problem,
which is undesirable for a server with multiple active users.
In order to prevent these servers from running into issues due to upgrading to 2022.2, I'm already publishing these changes.

Depending on the complexity of the concurrency issues,
I may release a 2022.2.2 soon-ish or it will end up being part of a later 2022.3 release.

Added

• [server] server config option to enable import/export, defaulting to False
  • given the experimental nature, it's better to not enable this by default
  • it's strongly recommended to only enable this if you run a private server for the moment

Fixed

• Note export failing
• Markers not being exported