You are viewing a potentially older version of this package. View all versions.
sighsorry-Clan-1.0.0 icon

Clan

Build your Valheim clan with Leader, Officer, Member, and Guest roles, clan chat, a movable health HUD, private map pings, shared positions, custom emblems, and animated GIF emoji. Apply, invite, manage members, and stay connected across Valheim.

Date uploaded 10 hours ago
Version 1.0.0
Download link sighsorry-Clan-1.0.0.zip
Downloads 10
Dependency string sighsorry-Clan-1.0.0

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2333 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.2333
ValheimModding-Jotunn-2.29.0 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.29.0

README

Clan

A server-authoritative clan system for Valheim, integrated into the vanilla chat UI.

Showcase

Clan panel and management

Open the Clan panel directly from gameplay, then browse clans and players, search the directory, apply or invite, and manage member roles.

Opening the Clan panel

Clan and player browser

Leaders can update the clan name and description and choose an emblem from the server's media catalog.

Clan profile and emblem editor

Clan chat and notifications

Clan chat is attached to the vanilla chat UI, while the movable HUD keeps the active clan and online members visible during play.

Clan chat and member HUD

The view filter switches between all, clan, local, and global messages without changing the selected sending channel. Pending invitations and applications are surfaced through the Clan control.

Chat view filter and sending channel

Clan notification

Emoji and animated GIFs

Open the five-column emoji picker from chat to insert server-synchronized PNG or GIF emoji. Animated GIFs play directly in supported chat messages.

Emoji picker and chat messages

Animated GIF emoji in chat

Features

  • Create, browse, search, and manage clans
  • Leader, Officer, Member, and Guest roles
  • Clan chat with All, Clan, Local, and Global view filters
  • Clan-only map pings and optional position sharing
  • Movable clan HUD with online player health
  • Server-synchronized PNG/GIF emoji and PNG emblems
  • English and Korean localization

Quick start

Action Default control
Open or close the Clan panel H
Open chat and the Emoji panel G
Send a clan-only map ping Hold Left Shift while using the vanilla map ping

Open the Clan panel to create a clan or apply to an existing one. Open vanilla chat to select a channel, insert emoji, filter visible messages, or open the Clan panel from the attached controls.

The Clan HUD is enabled by default and shows up to 10 online players. Drag its header to move it, or use the header control to collapse the player list.

Roles and Guest clans

A player may have:

  • One primary clan role: Leader, Officer, or Member
  • One persistent Guest connection to a different clan

While a Guest connection is active, the Guest clan is used for clan chat, HUD, pings, shared map positions, and friendly-fire checks. The primary membership remains stored and becomes active again after leaving or being removed from the Guest clan.

Accepted applications and invitations always start as Guest. Leaders and officers can manage eligible players from the roster; leadership transfer and clan profile management remain leader-only.

Custom emoji and emblems

The authoritative server loads media from:

BepInEx/config/Clan/emoji
BepInEx/config/Clan/emblems

For single-player and local hosting, place media in the local profile's folders. For a dedicated server, place media in that server installation's folders.

Clan does not embed a default media collection. Install an optional Clan media pack or copy your own files into these folders. This keeps the core mod small and lets server owners and modpack authors select their own catalog without replacing the Clan DLL.

Only the server or host's media catalog is published to connected clients. Remote clients first reuse valid files from the shared cache. When a cache entry is missing, Clan checks the same media-pack path and directly uses a byte-identical local file after verifying its length and SHA-256, without creating a cache copy. Any remaining files are downloaded automatically and added to the shared cache. Changes on the server or host are validated and reloaded automatically.

The legacy spritesheet.png format is not supported; use one image file per emoji.

Content Limit
Emoji catalog 100 PNG/GIF files total, including up to 50 GIFs
Emblem catalog 50 PNG files
PNG 512 KiB, up to 512 × 512, 8-bit and non-interlaced
GIF 2 MiB, up to 512 × 512; animated GIFs: up to 180 frames and 10 seconds, infinite loop

Basenames must be unique within each folder, contain 1–32 characters, use lowercase a-z, digits, _, or -, and start and end with a letter or digit. Windows reserved names are not allowed, and extensions must be lowercase .png or .gif. The basename becomes the chat token:

wave.png      -> :clan_wave:
pink_math.gif -> :clan_pink_math:

GIFs are also limited to 8,388,608 decoded pixels per file and 3,000 frames across the full catalog. Invalid files are skipped and reported in the server log. Large GIF catalogs can use substantial system and graphics memory.

Each message may contain up to five recognized emoji tokens. Only the newest 15 GIF occurrences in the visible vanilla chat buffer animate; older GIFs remain visible on their first frame.

Clients download only missing media and keep a shared content cache under <Valheim save data>/Clan/cache. Downloads run in the background and do not block world entry.

Configuration and save data

Client and synchronized settings are stored in:

BepInEx/config/sighsorry.Clan.cfg

Main defaults are:

Setting Default Scope
Lock Configuration On Server-synchronized
Clan Friendly Fire On Server-synchronized
Share Clan Positions On Server-synchronized
Clan Ping Modifier Key Left Shift Client
Clan Chat Window Scale 2 (12) Client
Clan Panel Shortcut H Client
Emoji Panel Shortcut G Client
Chat After Send KeepOpen Client
Show Clan Member HUD On Client

Clan Friendly Fire = On allows clan-connected players to damage one another.

Clan data is stored under:

<Valheim save data>/Clan/

On Windows without -savedir, the default location is:

%USERPROFILE%\AppData\LocalLow\IronGate\Valheim\Clan
Path Purpose
clans.yml Clan registry
recent-players.yml Recent-player directory
cache/ Shared downloaded-media cache

Worlds and mod-manager profiles using the same Valheim save-data root share this persistent Clan data and downloaded-media cache. Their server media sources remain profile-specific under BepInEx/config/Clan. Use separate -savedir values for independent dedicated-server registries. Do not delete the save-data Clan folder unless you also intend to delete saved clan data.

Mod API

ClanApi.ApiVersion is 4. Server-side integrations can query authoritative primary and Guest memberships with ResolveMemberships, query ward access with ResolveWardAuthorization, and invalidate cached results through RegistryRevision and RegistryChanged.

Fail closed when either lookup returns Unavailable.

CHANGELOG

Version Update Notes
1.0.0 - First public release; declares Groups and Guilds incompatibility, adds Clan API v4, separates optional server media packs under BepInEx/config/Clan from persistent registry, recent-player, and shared-cache data, omits embedded PNG/GIF defaults, and directly reuses byte-identical client media-pack files before downloading missing content
0.6.1 - Replaces the hidden +/- height toggle with a persistent upper-left drag handle that uniformly scales the vanilla chat window, text, inline PNG/GIF emojis, and attached Clan controls while preserving the lower-right corner and screen bounds
0.6.0 - Makes local PNG/GIF emoji tokens available in Say, Shout, Whisper, and Clan; replaces the Chatter type-specific label patch with presentation-time TMP token rendering; and adds a session-local chat height expand/restore button outside the upper-left corner
0.5.2 - Silently skips the optional Chatter emoji integration when Chatter is not installed, removing harmless HarmonyX missing-type warnings without changing chat behavior
0.5.1 - Releases and shows the mouse cursor only while the Clan-attached chat input is actively focused, keeps Clan controls clickable without closing chat, and leaves cursor restoration to Valheim when chat closes; also recognizes Chatter's disabled input state so the dock cannot remain active after chat closes
0.5.0 - Breaking emoji update: replaces the server-transferred 5x5 sprite sheet with up to 25 individual PNG files and 10 individual GIF files preinstalled on the server and clients; only a canonical filename/length/SHA-256 manifest is synchronized, PNGs are packed into a client-local runtime atlas, and bounded GIFs render from composited frame atlases
0.4.0 - Adds validated server-distributed 5x5 Clan emoji atlases, a vanilla-chat emoji picker, safe namespaced chat tokens, bounded client hash caching, and client-local TMP sprite rendering
0.3.1 - Fixes gameplay input remaining blocked after closing chat with a Clan drawer open; drawers now follow vanilla chat lifetime and mouse suppression is limited to the Clan controls under the pointer
0.3.0 - Breaking release: replaces the 0.2.x save and RPC formats without migration; adds server-filtered invite candidates, live presence, application cancellation and moderator synchronization, clan colors and descriptions, a synchronized member limit, safer confirmations, server-side chat/ping rate limits, and read-only display of server-owned settings
0.2.0 - Breaking release: replaces the 0.1.x registry and RPC formats without migration; removes the standalone Clan panel in favor of the vanilla chat dock; targets players by stable ID; all servers and clients must upgrade together and clans must be recreated
0.1.0 - Clan foundation with Jotunn dependency, persistent server registry, Clan chat panel, channel buttons, feature dock, clan-only ping, and clan position sharing