You are viewing a potentially older version of this package. View all versions.
TheMann-ValheimChalkboard-0.4.1 icon

ValheimChalkboard

Draw on timber-framed chalkboards in three sizes, with native Valheim UI, chalk colors and automatic saving.

Date uploaded a month ago
Version 0.4.1
Download link TheMann-ValheimChalkboard-0.4.1.zip
Downloads 40
Dependency string TheMann-ValheimChalkboard-0.4.1

This mod requires the following mods to function

ValheimModding-Jotunn-2.30.2 icon
ValheimModding-Jotunn

Jötunn (/ˈjɔːtʊn/, 'giant'), the Valheim Library was created with the goal of making the lives of mod developers easier. It enables you to create mods for Valheim using an abstracted API so you can focus on the actual content creation.

Preferred version: 2.30.2
denikson-BepInExPack_Valheim-5.4.2351 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured with the correct entry point for mods and preferred defaults for the community.

Preferred version: 5.4.2351

README

Valheim Chalkboard

Timber-framed chalkboards for Valheim: draw with the mouse, choose chalk colors, undo strokes, and wipe the board. Changes save automatically after a stroke; Done or Escape waits for the final save. The editor fills most of the screen and follows Valheim's UI scale setting.

Pieces

Find these under Hammer > Furniture:

Piece Writing area Materials
Small 2 x 1.15 m 4 Wood, 1 Coal
Medium 3 x 1.725 m 8 Wood, 2 Coal
Large 4 x 2.3 m 16 Wood, 4 Coal

All sizes use a 128 x 72, eight-color canvas. Existing boards retain the piece_whiteboard identifier and their drawings. The plugin GUID and assembly name remain marcus.valheim.whiteboard and ValheimWhiteboard.dll for compatibility.

Install

Requires BepInExPack_Valheim and Jotunn. Copy the built DLL to BepInEx/plugins/ValheimWhiteboard/, or install the Thunderstore package through r2modman. Install the same version on every player client and dedicated server. Fully restart Valheim after updating. Remove an older manually installed copy before using a mod-manager package to avoid loading duplicate DLLs.

Build

Requires a .NET SDK and your own installed Valheim, BepInEx, and Jotunn DLLs:

dotnet build src/ValheimWhiteboard.csproj -c Release -p:ValheimDir="PATH_TO_VALHEIM" -p:BepInExDir="PROFILE/BepInEx" -p:JotunnPath="PROFILE/BepInEx/plugins/ValheimModding-Jotunn/Jotunn.dll"

The repository does not redistribute proprietary game assemblies.

Automated multiplayer regression tests

dotnet run --project tests/MultiplayerTests -c Release

Tests use .NET 8 by default. GitHub Actions runs this on each push and pull request. No game installation or test-framework package is needed.

The tests compile the actual production DrawingBoard.cs with minimal game and networking doubles. Sixteen regression cases cover two-peer saves, conflicts, merge/retry, spoofed identities and acknowledgements, range, death/disconnect, ward permissions, ownership handoff, replay, corrupt payloads, world-data readback, and the pixel codec. Exceptions fail the process and CI job.

These tests simulate Unity, ZDO storage, RPC delivery and wards. They do not verify actual transport, GUI input, shaders, disk saves or a dedicated server. The editor autosave state machine is not covered by these handler tests. See live multiplayer testing for acceptance steps.

Multiplayer behavior and limits

Saves replicate through world data after a stroke; strokes are not streamed. Revision checks prevent stale saves from replacing a newer drawing. Retrying merges changed draft pixels over the newest board; on same-pixel conflicts the retrying local change wins. Save failures keep the editor draft with a Retry button. Ownership changes or a lost response can time out even if a save landed. Wait for the written status before quitting. Death, leaving range, destruction or game exit can interrupt an unacknowledged stroke.

Ward checks use private game APIs and fail closed if unavailable. Mouse only. Placement inherits vanilla sign snap points; larger board colliders follow visual size. Back up worlds before removing mods with placed custom pieces.

Validation status

0.4.1 compiles against the locally installed game and Jotunn 2.30.2. All 16 simulated multiplayer regression cases pass locally. Live two-client and dedicated-server testing has not yet been completed. Do not interpret CI success as proof of in-game multiplayer compatibility.

MIT licensed. See LICENSE.

0.4.0 replaces the generic IMGUI editor with native Jotunn wood panels, Valheim fonts and buttons, a framed slate and chalk tools. It uses the game's GuiScaler component and an overlay above the HUD. In-game visual verification of this update is pending.

Client compatibility

All clients and servers must have the same mod patch version. Vanilla clients are not supported; Jotunn is configured to reject them before world entry. See compatibility policy and live test matrix. The matrix remains unverified in-game.

Run python scripts/test_compatibility.py for release and compatibility-policy guards. CI runs multiplayer tests on Windows and Linux and these guards on Linux.

CHANGELOG

0.6.1

  • Correct text encoding in the editor and README; add a UTF-8 release guard.

0.6.0

  • Stream individual pixel edits while drawing; different pixels combine and the last server arrival wins for each pixel.
  • Keep drawing while edits await acknowledgement; retry retains queued pixels.
  • Send compact pixel notifications only to negotiated modded peers; vanilla sign fallback remains supported.
  • Rename the wipe brush to Eraser; retain Wipe board for clearing the board.
  • Requires 0.6.x on the host and drawing clients because the wire protocol changed.

0.5.0

  • Store all boards as vanilla signs; decorate marked signs on modded clients.
  • Allow optional vanilla clients through the server-required Jotunn policy.
  • Route drawing requests to the host with capability negotiation and revision acknowledgements.
  • Preserve canonical drawing fields across late vanilla-owner updates.
  • Migrate loaded/unloaded legacy records after backup; commit before admitting peers.
  • Retain vanilla sign colliders, recipes and refunds for every visual size.
  • Add actual headless Unity, socket, world-save and restart tests alongside managed CI.
  • Real vanilla Steam join and visual/input acceptance remain release gates.

0.4.1

  • Require identical mod versions on all peers through Jotunn network compatibility checks.
  • Add Windows/Linux multiplayer CI and vanilla-client policy guards.
  • Document the live vanilla-client acceptance matrix; not yet run in-game.

0.4.0

  • Native Valheim wood-panel editor, Norse headings, serif labels and game buttons.
  • Chalk toolbar and framed slate; editor renders above the game HUD.
  • Native GuiScaler follows game UI scale.
  • Small, Medium and Large boards; automatic save retained.
  • 16 production RPC multiplayer simulation tests plus live testing checklist.
  • Live two-client/dedicated-server acceptance testing remains pending.