SpongeCore
Shared plumbing for Sponge's mods. Install it only if another mod asks for it.
About this mod Author’s original text
Sponge's Core
The shared plumbing behind Sponge's mods.
This mod does nothing on its own. It adds no features, changes no gameplay and
patches nothing. Install it only because another mod lists it as a dependency — your
mod manager will normally do that for you.
What it does
Several mods need the same three unglamorous things, and each is easy to get subtly
wrong:
- Their own messages between players. The game sends nothing of its own design
that a mod can attach to, so a mod that needs players to agree on something has to
bring its own channel — and attach it at the right moment, on both the host and
every client, and reattach it after a reconnect.
- A small file beside your save. For anything the game's own save has no room
for. The rule that has to hold everywhere is that a mod's own bookkeeping failing
must never disturb the game's file.
- Doing something occasionally instead of every frame. For writes to disk and
periodic sweeps.
Doing each once, in one place, means a fix reaches everything at once instead of
being applied to some copies and not others.
When you want it
Only when something else asks for it.
Keys
None.
Why it is separate from the UI library
A mod that needs to send a message but draws nothing on screen should not have to
ship a canvas, and one that draws but never talks to other players should not have to
ship networking. They are split so each mod carries only what it uses.
Compatibility
It patches nothing and touches no game behaviour, so it cannot conflict with
anything.
For mod authors
Declare the dependency so you are refused a load rather than failing later with a
missing-type error:
[BepInDependency(CorePlugin.Id, CorePlugin.Version)]
The version is a contract, bumped whenever the shared surface changes in a way a
dependent could notice.
License
See LICENSE in the package.
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.
Install these first, or the mod will not work: