Skip to content
Version 2.32.0
↓ Get the launcher

IPluginServices interface

The single object passed to every plugin’s constructor. Plugins obtain all framework capabilities by reading sub-services from here.

public interface IPluginServices
name description
BossVitals { get; } Native boss-HP tap — reads the same merged entity store the game’s own boss bar reads, immune to the combat wire mirror’s AOI-eviction (see GetVitals for the wire-derived fallback).
CameraOverride { get; } Exclusive free-camera takeover of the game camera (60 m hard cap, framework-ended on zone change, cutscene, the game’s camera mode, disconnect or unload). See ICameraOverride.
Chat { get; } Chat message stream and send API.
ClientState { get; } Player session state (logged-in, current scene, login/logout events).
CombatEvents { get; } Real-time combat event stream (damage, buffs, skill casts).
CombatLookup { get; } Lookup service for static combat data (skill tables, buff tables).
CombatSnapshot { get; } Snapshot of the most-recent combat state for all tracked entities.
CombatSpec { get; } Per-entity active sub-profession (spec), resolved from observed combat casts.
CombatState { get; } Whether the local player is in combat (event-driven). See ICombatState.
Config { get; } Plugin-scoped persistent configuration (JSON-backed key-value store).
Data { get; } Per-plugin binary file storage for data too large/opaque for Config (e.g. re-upload payloads).
DeepSlumber { get; } Live Deep-Slumber Psychoscope (season cultivate) state — level, lines, socketed cards, node levels. Read live per call; never sourced from a saved profile.
Downloads { get; } Downloads a plugin-requested file or zip into this plugin’s own data folder. See IPluginDownloads.
Dungeon { get; } Current dungeon run: per-run unique id (level_uuid) and clear-time/score once the run settles.
Emotes { get; } The local player’s unlocked emotes and playing one through the game’s own emote action. See IEmotes.
EntityContextMenu { get; } Row context-menu extension point (register entity-scoped menu items).
EntityDetail { get; } Per-entity detail (full attribute map + equipment) for the inspector.
EntityPicker { get; } The character drawn under a screen point. See IEntityPicker.
EntityPortrait { get; } Live 3D portrait of the local player (Entity Inspector). Self-only in v1.
EntityTransforms { get; } Reads live world transforms (position + facing) of entities by id — for replay/position capture.
Exchange { get; } The inter-plugin communication channel — a plugin offers a contract via Provide<T> and another consumes it via Consume<T>, without referencing each other. The ONE generic extension point for plugin-to-plugin cooperation; specific contracts live in a shared contracts assembly.
Framework { get; } Framework lifecycle events and the per-tick Update callback.
Friends { get; } Friend list + private-chat (whisper) conversations from the game’s own data, and the game’s private-chat actions (open history, mark read, create, close). See IFriends.
GameAssets { get; } Game asset loader — profession/class icons and other atlased UI sprites.
GameData { get; } Read-only lookup over the game’s static table data (skills, buffs, items, etc.).
GameEnvironment { get; } Region + version identity of the running game install (SEA / JP), detected once at boot.
GameEvents { get; } Game lifecycle events (scene load / unload, hot-update ready).
Harmony { get; } Per-plugin Harmony host — create id-namespaced Harmony instances that are auto-unpatched when the plugin is disposed.
Hotkeys { get; } Bindable keyboard-action registration.
InputShield { get; } Blocks the game’s movement/camera/combat input and every game key while held, and exposes raw key/mouse reads. See IInputShield.
Inventory { get; } Player inventory — item stacks and currency.
Launcher { get; } Register a tile in the Stellar launcher menu (Phase B).
Lights { get; } Photo lights — lamps in the world, how strongly characters take them, and a key light and rim per person; all ended and restored exactly when the scene ends. See ILights.
Loadout { get; } Read and apply the player’s saved in-game loadouts (class + gear + spec + modules).
LoadoutSave { get; } Save the worn setup into another saved loadout (the game’s own loadout Save). See ILoadoutSave.
Localization { get; } Localizes this plugin’s own UI text into the active UI language (English fallback).
Log { get; } Plugin-scoped log sink; output is routed to the BepInEx log with the plugin name as prefix.
Lua { get; } Bridge to the game’s live tolua# Lua state (run chunks, read simple globals back). Main-thread only.
Market { get; } The in-game player exchange/marketplace: query listings/care-list/notice items and buy through the game’s own trade system. (Named Market because Exchange is the inter-plugin channel.)
ModuleEquip { get; } Module equip actions (install / uninstall equipment modules).
NamedTheme { get; } Theme preset selector and global font scale.
NativeUi { get; } Inject declarative mod uGUI into game-UI anchors (Phase 9d).
NoticeTips { get; } Trigger the game’s noticetip system (dungeon bars, win/fail banners, pop-up tips) with full control over content and audio.
Notifications { get; } Show short transient on-screen toasts (plugin-side feedback the game does not surface itself).
PartyControl { get; } Party control — switch the party between 5- and 20-player via the game’s own dispatcher.
PartyEvents { get; } Party lifecycle events (member join/leave, leader change).
PartyRoster { get; } Party roster — member list and group/slot information.
PartySnapshot { get; } Snapshot of the current party roster and member vitals.
PhotoMode { get; } The game’s own photo / selfie mode and cutscene state. See IPhotoModeState.
PlayerProfile { get; } Resolve a player’s profile avatar image URL by char/role id (via the game’s GetSocialData RPC) — for chat / nameplate avatars. See IPlayerProfile.
PlayerState { get; } Local player’s real-time state: name, level, HP, stamina, position.
PlayerStats { get; } Live character attribute snapshot (ATK, DEF, crit rate, etc.).
Posing { get; } Pose people in the world, with or without the free camera — you live, other players as a local copy, NPCs as a stand-in model; everyone reset when the scene ends (zone change, cutscene, disconnect). See IPosing.
ProfileCardActions { get; } Contribute buttons to the game’s native profile card action bar (the framework injects + styles them).
RenderLook { get; } Apply a camera look (depth of field, colour, LUT, bloom, vignette, grain) through the game’s own renderer effects; one active look framework-wide. See IRenderLook.
RenderQuality { get; } Raise render quality (supersampling + TAA, high shadows) while a token is held; reference-counted across plugins, the game’s values restored when the last token goes. See IRenderQuality.
ReShade { get; } ReShade bridge — effects on/off, technique toggles and preset switching. See IReShade.
ReShadeUniforms { get; } ReShade uniform overrides — hold an effect setting at a value in every ReShade runtime (bridge 1.1.0+). See IReShadeUniforms.
Resonance { get; } Local player’s equipped Battle Imagines (Resonance Skills), in slot order.
ResonanceData { get; } Static game-data lookups for Battle Imagines (Resonance Skills): display + cooldown/charge info, and cast-skill → resonance reverse mapping.
RunTimer { get; } Run-timer identity anchor (value + latch epoch) for the current dungeon run — the upgrade-proof companion of Dungeon’s RunTimerStartMs. See IRunTimer for why run identity must compare the EPOCH, not the value.
SceneFreeze { get; } Freezes the animation, effects and drawn positions of every entity on screen, including ones that appear while frozen (visual and local only). See ISceneFreeze.
SceneVisibility { get; } Reference-counted hiding of the game HUD, the Stellar overlay, nameplates and other players. Tokens a plugin still holds are released when it unloads. See ISceneVisibility.
ScreenCapture { get; } Capture the rendered scene to a PNG/JPG file at 1×, 2× or 4× (clean: no game UI or overlay). See IScreenCapture.
Theme { get; } Active theme palette, text helpers, and colour registry.
TimeOfDay { get; } Pin the in-world time of day to an hour, then hand it back to the server. See ITimeOfDay.
Voice { get; } Play audio into the game’s OUTGOING team-voice stream (mixed with the live mic) via a shared multi-source mixer; sources this plugin creates are auto-disposed on unload. See IVoiceInjection.
Wardrobe { get; } Save and switch the local player’s worn cosmetic outfits (wardrobe).
WardrobePreview { get; } Live 3D preview of the local player wearing an arbitrary saved outfit (wardrobe preview).
Windows { get; } uGUI interactive window toolkit (SP1 window shell).