DrakeModsLibs

DrakeModsLibs — ⚠️ Moving to Hexium

> [!IMPORTANT] > DrakeMods is moving to Hexium. > > This is one of the last updates we'll post on Thunderstore. No new DrakeMods will be released here, and existing mods will get only limited support on Thunderstore from now on. > > For the latest updates, newest versions and future mods, follow us on Hexium: > 👉 DrakeMods on Hexium > > These Thunderstore listings will be deprecated after this.

> [!TIP] > ### 🎨 DrakesReskinIt is finally coming, on Hexium! > The next mod built on DrakeModsLibs: give any item a new inventory icon, a new equipped model and custom colors, with saveable presets. > It plugs into the same Shift + right-click tab menu that LockSmith and DrakesRenameIt already use. > 👉 DrakesReskinIt on Hexium

Shared library for DrakeMods Valheim mods. It owns the display Harmony patches, item custom-data helpers, tag gatekeeping, menu binding registry, and server config sync so feature mods stay smaller and stay compatible when the game updates.

DrakeModsLibs is published on its own so other DrakeMods (starting with DrakesRenameit) can depend on one common package. More customization-oriented mods may use it later; there is no full suite planned for release right now — priorities and a redesign pass come first. Reskin is something we still want to look into when time allows.

Valheim 1.0

This release targets Valheim 1.0 API changes (notably item-stand visual updates and related display paths). Install the matching DrakeModsLibs build with your feature mods so labels and hover text keep working after the 1.0 update.

Required for

• LockSmith (shared Lock|Rename tabs, wood UI, config sync)
• DrakesRenameit (and any future DrakeMods that share display / config sync)

Forge helpers (DrakeModsLibs.Forge)

ForgeTextures (images embedded in your DLL, flatten-proof), ForgeSprites (flat cut-out images) and ForgeLook (materials, icons, snap points, components, fire colours…): the API code generated by Drakes Asset Forge's plain C# export calls. Used by DrakesRenameit (paper). ForgeLook.Model (a .glb model from your DLL, like Forge's look.mesh.file) and ForgeLook.CollisionBox: used by DrakesItemShop (display case).

Server config sync (DrakeConfigSync)

Only DrakeModsLibs references and ILRepack-embeds ServerSync. Consumer mods must not add a ServerSync Thunderstore dependency or ILRepack step.

At startup, create sync via the API:

var sync = CustomizeLibsAPI.CreateConfigSync(modId, displayName, version);
var entry = sync.BindSynced(config, section, configurationManagerCategory, key, defaultValue, description);
sync.AddLockingConfigEntry(lockEntry);
sync.FinalizeBinding(log, expectedSyncedEntryCount, () => lockEntry.Value);

Use BindClientOnly for per-client settings (never registered with ServerSync). IsSourceOfTruth / SourceOfTruthChanged behave like the underlying ServerSync instance.

Soft-compat (CompatHost)

Optional foreign mods (WardIsLove, ProtectiveWards, Arcane Ward, DevCommands, …) are never hard dependencies. DrakeModsLibs provides per-plugin scaffolding:

• DrakeModsLibs.Compat.ICompatModule / CompatPriority
• CompatHost / CompatHosts.GetOrCreate(ownerGuid, log) — one host per Drake plugin GUID

Domain rules (ward access, paper take, item-stand names) stay in LockSmith / RenameIt. Built-in bridges there are a courtesy — not a promise to track every upstream ward change. Please report issues on those repos; pull requests and your own SoftDependency modules are welcome. LockSmith also exposes LockSmithCompatApi for third-party bridges.

Agent guidance: .cursor/skills/drakemods-compat-host/SKILL.md. WardIsLove RenameIt handover: docs/handover-wardislove-renameit.md.

Custom data API (other mods)

Read and dump ItemDrop.ItemData.m_customData through CustomizeLibsAPI:

• GetCustomDataValue(item, key) — display value (tags → true/null, text → stored string)
• GetCustomDataRaw(item, key) — raw dictionary value
• DumpItemCustomData(item, options) — all keys, one mod, one key, JSON or neat text
• DumpAllDrakeCustomData(item) / DumpItemCustomDataForMod(item, modId)
• RegisterModCustomDataFields(modId, fields) — register your mod’s keys at startup

Built-in mod ids: DrakesRenameIt, DrakeModsLibs, DrakesQuestItems, DrakesItemShop.

Subscribe to CustomizationEvents.OnItemNameChanged for rename logging; use DrakeCustomDataKeys.Rename with GetCustomDataValue.

Tag gates (RenameIt integration)

Other mods talk to Libs only; RenameIt calls CanPerform / IsRenameInventorySuppressed and never needs a new release for your tags.

| Built-in tag | Blocks | Inventory UI | Admin bypass | |--------------|--------|--------------|--------------| | Drake_NoRename | rename | suppress | soft (yes) | | Drake_NoDesc | description | — | soft (yes) | | Drake_NoCraftedByEdit | crafted-by | — | soft (yes) | | Drake_QuestItem | all edits | suppress | soft (yes) | | Drake_HardNoRename | rename | suppress | hard (no) | | Drake_HardNoDesc | description | suppress | hard (no) | | Drake_HardNoCraftedBy | crafted-by | suppress | hard (no) | | Drake_Immutable | all edits | suppress | hard (no) | | Deferred (DeferEditsTo) | chosen ops | optional | authority decides |

// Soft stamp (admin/VIP TagBypass may still allow)
CustomizeLibsAPI.BlockRename(item);

// Hard stamp (LockSmith-style safety — no admin bypass)
CustomizeLibsAPI.HardBlockRename(item);
// or
CustomizeLibsAPI.MarkImmutable(item);