YappersHQ.Poop.Shared 1.0.1

<div align="center"> <h1>💩 <strong>Poop</strong></h1> <p>Spawn poops on dead players, climb the leaderboards, customize colors & sounds — a goofy showcase plugin for <a href="https://github.com/Kxnrl/modsharp-public">ModSharp</a>.</p> </div>

<p align="center"> <a href="https://github.com/Kxnrl/modsharp-public"><img src="https://img.shields.io/badge/framework-ModSharp-5865F2?logo=github" alt="ModSharp"></a> <img src="https://img.shields.io/badge/game-CS2-orange" alt="CS2"> <img src="https://img.shields.io/gitlab/license/cs2-server-plugins/cs2-poop?gitlab_url=https%3A%2F%2Fgitlab.com" alt="License"> <img src="https://img.shields.io/gitlab/stars/cs2-server-plugins/cs2-poop?gitlab_url=https%3A%2F%2Fgitlab.com" alt="Stars"> </p>

Poop drops a poop on the nearest dead player (or at your own feet), tracks who poops most and who gets pooped on most, and lets each player pick a color. It doubles as a reference for laying out a multi-project ModSharp plugin: a public IPoopShared API, a swappable database module (IDatabaseProvider), and an example consumer plugin.

🚀 Install

Copy the build output into your ModSharp install (<sharp> = your sharp directory):

Restart the server (or change map) to load. If the config files are missing on first load, Poop.Core and Poop.Database write the bundled defaults — but shipping them up front keeps your edits sticky.

Game assets (model, textures, sounds) live under .assets/assets/ and are referenced from poop.json as models/yappershq/fun/poop.vmdl + sound events. Compile those into your VPK / workshop addon separately.

⌨️ Commands

Aliases below are the defaults; all are configurable in poop.json under commands.*.

When the optional AdminPanel plugin is installed, Poop registers a Force poop per-player action (permission admin:slap). It degrades silently if AdminPanel is absent.

⚙️ Configuration

configs/poop.json — gameplay

Tunes spawning, size tiers, colors, sounds, commands, and the chat prefix. See Poop.Core/Config/PoopConfig.cs for the full schema; highlights:

configs/poop.database.json — persistence

🌍 Localization

locales/poop.json ships en-US and zh-CN. Format is key-first then per-culture (ModSharp LocalizerManager requirement). Color tokens are double-braced in JSON ({{green}}); culture codes must match Internationalization.SteamLanguageToI18N (en-US, zh-CN, …). Add a culture by adding its inner key to each string; unmatched Steam languages fall back to en-US.

🔧 How it works

Poop.Core drives the IModSharpModule lifecycle over a DI container of IModule services. The spawner picks a weighted size tier, resolves the player's color preference, spawns the prop, plays sound events, and records the placement to the database. Poop.Database publishes an IDatabaseProvider so the storage backend (LiteDB / MySQL / PostgreSQL via SqlSugar) is swappable behind one interface. Publishers register their shared interfaces in PostInit; consumers resolve in OnAllModulesLoaded (ModSharp guarantees all PostInits finish first).

🧩 Public API

Other plugins consume IPoopShared without referencing Poop.Core — resolve it in OnAllModulesLoaded:

var poop = sharedSystem.GetSharpModuleManager()
    .GetRequiredSharpModuleInterface<IPoopShared>(IPoopShared.Identity)?.Instance;

poop.ForcePlayerPoop(client, size: 2.5f);
var stats = await poop.GetPlayerStatsAsync(client.SteamId);

poop.OnPoopSpawned += e => Log($"{e.Player?.Name} dropped a {e.Size:F2} poop");
poop.OnPoopCommand += e => { if (!e.Player.IsAdmin) e.Cancel = true; }; // gate usage

See Poop.Example/PoopExample.cs for a complete consumer (force-spawn, stats lookup, command gating).

📦 Build

Requires the .NET 10 SDK and the ModSharp NuGet feed (configured in Directory.Build.props).

dotnet build -c Release

Outputs under .build/:

The CopyAssets target mirrors .assets/* into .build/ after each build, so default configs / locales ship alongside the DLLs.

🙏 Credits

• ModSharp — Kxnrl & co. — the framework this builds on.
• yappershq team — assets and ideas.

<div align="center"> <p>Made with ❤️ by <a href="https://gitlab.com/cs2-server-plugins">yappershq</a></p> <p>⭐ Star this repo if you find it useful!</p> </div>