Skip to content

Home

Jump to bottom
Kanisuko edited this page Jun 1, 2026 · 13 revisions

ScavLib — Scav Prototype Mod API Library

Current Version: 0.6.0

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

What's New in 0.6.0

  • uGUI window framework (new) — a player-facing UI stack under ScavLib.gui.ugui: UguiWindowBase (themeable, draggable, click-blocking), the UguiBuilder control set, and the immutable, chainable UguiTheme.
  • IMGUI (renamed) — the old ScavLib.gui IMGUI types (MenuWindow / MenuBuilder / MenuManager) moved into ScavLib.gui.imgui and were renamed to ImguiWindow / ImguiMenuBuilder / ImguiMenuManager. IMGUI is now positioned as a debug-only facility; uGUI is the primary UI.

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