Fix v2026.1.2

This is a small patch to fix an issue with the new note filters not showing details as advertised.

Fix v2026.1.1

This is a small patch to fix an issue with templates dropping not applying their dimensions properly.

v2026.1

For more details on what's new checkout https://www.planarally.io/blog/release-2026.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-2026.1 folder.

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

The changelog for this release:

Added

• Custom shape data
  • A new tab in the Shape settings UI
  • Can be used to freely add custom data and create a rudimentary character sheet
  • Currently supported data types are text, number, toggle and dice expressions
  • Dice expressions can reference other data entries and open the dice tool with the evaluated expression
  • Dice tool has a quick access sidebar to selected shapes with dice expressions
  • Dice tool shows auto completion on expression references
• Shape order inconsistency check
  • Runs when moving a shape to the back
  • Fixes the order of all shapes on the layer and requests a page refresh
• Asset manager icon when a shape has template info
• Notes:
  • Campaigns tab (see more general note changes below)
  • Create can be confirmed with the enter key
  • Tag add now shows a pre-populated list with known tags
• Logging:
  • Enabling configuration of the logger via a new logging section
  • Allows for multiple logging file streams at different levels

Changed

• Initiative
  • UI rework
    • Asset images appear in initiative list
    • Prevent large initiative list growing excessively tall
    • Allow resizing of initiative list view
    • Replace popup modal with less intrusive verification check
    • New UI to add effects to entries
    • Add group badges for shapes with badges enabled
    • [DM] Add button to clear initiative list
    • [DM] Add previous/next round buttons
  • Add effects with infinite timespan
  • Fix names in initiative list not being reactive
• Templates
  • Are now stored as proper shapes in the DB
  • Will migrate along with other shapes on DB upgrades (old templates could become broken)
  • Can be linked with other systems (e.g. custom-data, notes, ...)
• Notes
  • No longer hard-linked to 1 particular location
    • Can be linked to multiple locations or no location (global/local concept is removed)
  • List filters have been redesigned to be mure useful
    • Many preferences have been removed as a result
  • Pagination is now in the bottom left and clearly notes the amount of pages
  • Tags in the note edit panel now have a "search" and "remove" action instead of always removing on click
  • [tech] Searching/Filtering/Pagination is now done on the server
  • [tech] tags are now stored in their own tables instead of being a json array on notes
• Campaign creator can no longer change their own role or kick themselves
• [tech] refactor of intermediate shape handling on client side (see transformations.ts)
• [tech] upgraded pydantic from 1.x to 2.x
• Square grids now have distinct x and y size values
• Keyboard movement now also snaps to the closest grid cell when snapping is relevant
• Variants
  • Players may now add variants to shapes they have edit access to
  • Players may now swap between variants of shapes they have edit access to
  • [tech] Variants' access permissions are now based on the permissions of the parent shape only

Fixed

• Images in the Token Direction indicator were overflowing
• Prevent shortcut handling when targetting an html select element
• Ampersand in campaign name preventing game load
• Duplicating (copy/paste) or undoing a removal of shapes would lose some info (e.g. notes)
• Undoing a shape removal related to a character did not work
• Undoing a shape removal causing the related group to be removed (i.e. last shape of the group)
• Cutting a rotated polygon would be wrong on refresh
• Resizing a rotated polygon did not correctly recalculate center, causing sudden shifts on move
• Note creation not going straight to edit mode in some cases
• Account settings text overlapping on smaller viewport widths
• Moving special hide/reveal shapes from the fow layer could lead to a niche bug
• Rotation slider not showing current value in text input on component load
• Shapes snapping to square grid sometimes offset from grid
• Shapes attempting to snap to a grid square now collide with walls
• DDraft files no longer being uploadable to the asset manager
• Moving shapes with keyboard keys while ruler was enabled on select tool would move shapes twice as far
• Hovering on an initiative entry that is part of a group but not marked as a group entry would highlight all group members
• Error log about viewports on the server
• Toggling initiative off vision lock interactions
• Initiative cog wheel not opening initiative tab in the client settings
• Initiative entries would remain blurred if the focused entry was removed by another player.
• Group system not properly cleaning up on location changes
• Group badges were not sorted numerically in a shape's group settings when set to the numbers character set.
• Tracker input resets to last value if left empty

v2025.3.0

For more details on what's new checkout https://www.planarally.io/blog/release-2025.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. (note an issue with the windows build occurred, which I'll rectify with a separate v2025.2.1 release later this has been resolved)

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

The changelog for this release:

Added

• Admin panel that can be accessed from the dashboard
  • Currently limited to the main admin_user as configured in the server's config
  • Shows roughly same content as the original separate admin client
  • Also shows total number of users/campaigns and a quick user create button
  • Last login day for users
• Toggle to search through shared assets
  • This is heavier for the server and niche so not enabled by default

Changed

• Smoothed out the scroll zoom behaviour when zoomed in furthest
• [server] Config values that are not known will now error and stop the server from starting
• [tech] Add debounce to asset search

Removed

• [server] Legacy server configs
• [server] Admin server - this is replaced with a new in-client admin dashboard

Fixed

• Ensure stat export is chunked to prevent rejection from stat server
• Rapid (dis)connect sequences flooding the stats
• Don't re-open shape properties after a re-select
• Last grid-line in X or Y axis sometimes not rendering
• Deleting first initiative entry would enter invalid state
• Going to previous initiative would decrement effect timers
• Going to previous initiative could enter negative rounds
• Render bug in vision mode "behind" showing the entire shape under certain circumstances
• Asset search server query had a missing () causing assets from other users to show up
• Floor renaming the wrong entry

v2025.2.2

This is a small release that fixes three bugs reported on the latest release:

• Initiative effect rename losing focus after pressing 1 character
• Locked shapes not being selectable directly
• DM only auras where no longer rendered due to a bug in the new access logic

v2025.2.1

This contains some small fixes/additions to the new mail setup.

Added

• SSL email configuration
  • Choose between START TLS / TLS / SSL / LMTP for smtp connection

Fixed

• Mail not working in envs where username env is missing (e.g. docker)
  • This is a problem in the mail lib used, but circumvented in the Dockerfile
• Mail error showing a 500 error in the client
• Email setup reset when the config changes to make sure new email values are used

v2025.2.0

For more details on what's new checkout https://www.planarally.io/blog/release-2025.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. (note an issue with the windows build occurred, which I'll rectify with a separate v2025.2.1 release later this has been resolved)

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

The changelog for this release:

Server owners: The server config has changed location and format. Ensure you check the release notes for the necessary info.
The old config files are not yet removed from git to prevent losing modifications you made to these files.
They will be removed in a future release though.
The server is now also managed using uv, if you manually manage the server using python/pip directly instead of using docker, you need to install this as well. See the server's readme for details.

Added

• New quick toggle to disable LoS rendering for the DM only
• Forgot password flow if Mail is configured on the server
  • This only works if the user account actually has an email-address
• Success notification when changing email in the settings
• Mod improvements
  • Can now register shape context menu entries
  • Upload/Remove mods for a specific campaign
• Asset create folder/upload file/remove buttons to the in-game asset browser
• [server] Email configuration setup
• [server] Anonymous stat collection
  • Sends usage stats about number of campaigns and users to stats.planarally.io
  • Identifiers are anonymized, no personal info is included
  • Can be disabled

Changed

• Access levels are no longer additive
  • e.g. edit access used to automatically include movement & vision access, this is no longer the case
• Selection draw box now appears on top of the fog
• Selection rotate UI now appears on top fo the fog
• Moved zoom bar and selection info behind main modals when overlapping
  • the selection info can pop-over when hovered with the mouse
• [server] Server config setup has changed
  • The server config is now by default stored in the data directory and in toml format
  • It's no longer tracked in git, as the default values are now coded in python itself
  • An env variable can be used to change the location
  • Changes to the config are now checked and loaded by the server during runtime
• [tech] Server shutdown sequence has been modified
• [tech] Mod improvements
  • DataBlock API changes
    • Made most functions sync
    • Save method renamed to sync
    • API added to handle reactivity inside the datablock
    • Now listens to saved events from other clients to update local data
    • No longer runs the (de)serializer per key, but instead just on the entirety, alloweing root arrays
    • Added utility useDataBlock hook to reduce a lot of boilerplate in mod components
    • Serialize and Deserialize generic order are swapped
  • Now expects a root level events object with event functions instead of them being exported
  • Remove registerTrackerSettings event

Removed

• The isToken property has been removed from all shapes
  • This is now fully derived based on vision access of the shape

Fixed

• Draw tool polygon was not updating vision until shape completion
• Reduced some render overhead when token shapes that the player did not own were moved
• Shape context menu not closing when selecting an option
• Select tool build UI not appearing when mode toggling
• Datablocks for room and user categories had a bug in the server preventing creating them
• Asset context-menu remove not working
• Asset context-menu background colour being wrong in-game sometimes
• Asset upload bar missing in the dashboard asset manager
• Asset picker out of game now uses the newer UI
• Dropping assets you have shared-view permission for on the map was not working
• Movement only door toggle not immediately rerendering screen
• Select tool UI would sometimes stick around when there is no shape selected anymore

Release 2025.1.1

This is a fix to the docker & windows builds, no other changes were made.

See https://github.com/Kruptein/PlanarAlly/releases/tag/2025.1 for the main release notes.

Release 2025.1

For more details on what's new checkout https://www.planarally.io/blog/release-2025.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

• Draw tool:
  • Added default colours for walls, windows, doors
  • These get automatically applied when the relevant vision/logic settings are enabled in the draw tool
  • Can be disabled by unchecking the 'prefer default colours' checkbox in the draw tool vision settings
  • The specific colours used can be configured in the user options Appearance section and will update shapes retroactively
• Notes:
  • Notes can now be popped out to a separate window
• NoteManager:
  • Added a button to clear the current search
• In-Game Assets UI:
  • Option to search through assets
  • Option to add folder shortcuts per campaign
    • These allow quicker navigation to frequently used folders
    • A "All assets" shortcut is always available
• [server] Assets:
  • limits:
    • Added limits to the total size of assets a user can upload and the size of a single asset
    • These limits can be configured in the server config
    • By default there are no limits, it's up to the server admin to configure them
    • These limits will only apply to new assets, existing assets are not affected
  • Thumbnails:
    • The server will now generate thumbnails for all assets

Changed

• Dashboard:
  • Changed some border colours in the create new game menu
• MenuBar:
  • Add Notes button for players
• [tech] Select tool:
  • Delayed syncing of selection state to the global state from mouse down to mouse move/up
  • This fixes some of the entries in the Fixed section
• AssetManager:
  • Changed UI of renaming assets, allowing inline editing rather than opening a popup
  • The images shown in the asset manager will now use the thumbnail of the asset if available
    • This should reduce load times and improve general performance
    • This also applies to the preview when hovering over assets in the in-game assets sidebar
  • Remove initiated from the context menu now removes the entire selection
  • Context menu retains selection unless an item not in the current selection is clicked
• In-game assets:
  • Sidebar is removed and replaced with a new Assets dialog similar to notes
  • The new UI has almost full compatibility with the assets in the dashboard
• Notes:
  • Add filtering option 'All' to note manager to show both global and local notes
  • Note popouts for clients without edit access now show 'view source' instead of 'edit'
• Dice tool:
  • Last result is now displayed in the dice tool rather than a popup window
  • Result breakdowns are shown in the last result display and history
  • Added a reroll button to quickly redo the previous roll
  • Added a reroll button to history entries
  • Add an option to roll 3D dice inside a dice box rather than over the playfield
  • Input field now scrolls to the end after populating via the on screen buttons
• @planarally/dice:
  • (this is the standalone dice library that handles most of the dice logic and rendering)
  • Upgraded to v0.7
  • Dice will now stop sliding smoother
  • Clear state can be configured
  • D100 dice now properly work in 3D for the full range (1-100 / 0-99)
    • Currently hardcoded to 1-100 in the client, but the library can be told otherwise
• I18n:
  • Added 95% i18n for zh (except diceTool)
• [server] Assets:
  • Assets are no longer stored in a flat folder structure, but instead use a subpath based structure
    • An asset with hash 35eaef2e9a116aa152f7f161f1281411cb1e1375 is now stored as assets/35/ea/35eaef2e9a116aa152f7f161f1281411cb1e1375
• [tech] Systems: Move system-core from game/ to core/ so that it can also be used by e.g. assets

Removed

• Labels:
  • As mentioned in the last 2 releases these were going to be removed
  • I wasn't happy with the current implementation and they were causing more confusion than they were useful
  • This also removes the Filter Tool
• .paa asset handling
  • This was no longer really maintained and the current frontend doesn't offer any support for it

Fixed

• Notes:
  • It was possible to open a 'view-only' note on a tab you weren't supposed to see
  • Note manager could be empty and unusable when changing locations or losing view access to an open note
  • Search filter not resetting page to 1 potentially causing a blank page if on an other page
  • Default edit access on notes was not correctly applied
  • Fix searchbar overlapping over other modals
  • Global notes no longer have a default access level
  • Notes can no longer be locally edited by clients without edit access through the note popouts
• Shape Properties:
  • Input changes could not persist or save on the wrong shape if selection focus was changed while editing (see selection changes)
• Modals
  • Dragging modals (e.g. notes) now also brings them to the foreground as if clicked
• Composites:
  • Moving composites to a different location could sometimes lead to errors on the client even though the moves were succesful serverside
• Select Tool:
  • Snapping an existing shape point to some other point could be overriden with a snap to the grid
• Game Listing:
  • Clicking on a session that shares a name with another session would foldout both

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