Skip to content

Home

Jump to bottom
QinShenYu edited this page Jun 10, 2026 · 13 revisions

ScavLib — Scav Prototype Mod API Library

Current Version: 0.7.1

Authors: Kanisuko / QinShenYu

BepInEx GUID: com.kanisuko.scavlib

ScavLib is a foundational developer-focused API and utility library for Scav Prototype (a.k.a. Casualties Unknown). It provides safe, well-documented wrappers around the game's core systems so mod authors can focus on their features rather than boilerplate and null-checking.

Note for players: This is a dependency library. It adds no content on its own and is only needed if another mod requires it.

Requirements

  • BepInEx 5.x (64-bit recommended)
  • Scav Prototype (Steam)

Quick Navigation

Page Description
Getting Started Installation and your first mod
PlayerUtil Player vitals, state queries, drugs, last-stand, writes, and inventory
LimbUtil Per-limb health, bleeding, infection, and bone state
SkillUtil Skill levels, XP, global multiplier
ItemUtil World-space item scanning and manipulation
CustomItemRegistry Register custom ItemInfo definitions
EventBus Event-driven mod patterns + GetHandlerCount diagnostics
CommandRegistry Custom developer console commands + scavlib check
GUI uGUI + IMGUI menus
ConfigManager BepInEx config wrappers
ModRegistry Mod metadata, ModSession, and VersionedDependency
Lifecycle System IModLifecycle, world events, and mod callbacks
Changelog Version history
RecipeBuilder Register custom crafting recipes
CustomLiquidBuilder Register custom liquid types
LocaleRegistry Localize custom item, building, moodle, and misc strings

What's New in 0.7.1

  • Six new wearable templates — BikeHelmet / RiotHelmet / Scarf / ArmWarmers / FannyPack / MaterialPouch close the remaining gaps in the wearable slot coverage.
  • Convenience factories expanded — CustomItemBuilder now ships one-call factories for every wearable family, so CustomItemBuilder.Helmet("mymod_helmet", "MyMod").Wearable(...).Register() is the typical pattern. See the CustomItemRegistry page for the full list.

See the Changelog for the full list and migration notes.

Verifying Installation

After placing ScavLib.dll in BepInEx/plugins/ and launching the game, open the developer console and run:

scavlib status

You should see ScavLib's version, authors, and all registered mods. Mods registered with a lifecycle object are annotated with [F].

Clone this wiki locally