htk6-PeakAdminBook icon

PeakAdminBook

Gives every player an admin guidebook. Open it to browse every item in the game alphabetically and click one to spawn it straight into your hands.

By htk6
Last updated 2 months ago
Total downloads 2858
Total rating 0 
Categories Mods
Dependency string htk6-PeakAdminBook-0.1.0
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_PEAK-5.4.75301 icon
BepInEx-BepInExPack_PEAK

BepInEx pack for PEAK. Preconfigured and ready to use.

Preferred version: 5.4.75301

README

Peak Admin Book

An admin/debug mod for PEAK. Every player starts with a guidebook. Open it and instead of the usual pages you get a searchable, alphabetical list of every item in the game — click one and it spawns straight into your hands.

Features

  • The host hands the guidebook to every player when their character spawns. Players without the mod still receive it; they just get the normal book.
  • Interacting with a full guidebook opens the spawner window.
  • Every spawnable item, sorted alphabetically, with icons and a search box.
  • F1 (configurable) opens the window without needing the book.
  • Guidebook pages found in the world are untouched.

Configuration

BepInEx/config/htk6.PeakAdminBook.cfg

Key Default Description
GrantBookOnSpawn true Host only. Give every player the book on spawn.
ReplaceAllGuidebooks true Full guidebooks open the spawner instead of the book.
ToggleKey F1 Fallback key. Set to None to disable.
ShowIcons true Show item icons in the list.
DumpItemListOnLoad false Log every catalog entry.

Notes

  • Item spawning goes through SpawnItemInHand, which RPCs the master client, so it works for every player and not just the host.
  • Items whose prefab lives in a 0_Items/ subfolder (unused/, base/) are hidden: the game cannot network-instantiate them and would throw on the host.

Building

See Config.Build.user.props.template for local setup, then:

dotnet build                       # debug, deploys to BepInEx/plugins
dotnet build -c Release -v d       # Thunderstore package in ./artifacts/thunderstore/

License

MIT — see LICENSE.