Skip to content

Home

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

ScavLib — Scav Prototype Mod API Library

Current Version: 0.6.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

What's New in 0.6.1

  • uGUI control set expansion — UguiBuilder gains text input (AddInputField), a numeric stepper (AddNumberField), images (AddImage), a self-contained dropdown (AddDropdown), and a mutually exclusive selector (AddToggleGroup).
  • Layout containers — BeginHorizontal (UguiHorizontalRow) for side-by-side controls and BeginTabs (UguiTabView) for tabbed pages, both IDisposable for using-block layout.
  • Tooltips & overlay layer — a chainable WithTooltip extension backed by a shared, persistent overlay canvas that keeps tooltips and expanded dropdowns above open windows. ScavLib tooltips are isolated from the game's native tooltip system.
  • Window close button — windows now show a title-bar X by default, with size/padding exposed through UguiTheme.Metrics.

All additions are purely additive — existing 0.6.0 uGUI APIs are unchanged.

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