-
Notifications
You must be signed in to change notification settings - Fork 0
Home
TRCE is a Spigot-inspired plugin framework for s&box.
This wiki is the complete reference for developers who want to build plugins on top of TRCE.
Never used TRCE before?
→ Read Getting Started first.
Want to understand the architecture?
→ Read Plugin System and Event System.
Looking for a specific service?
→ Check Built-in Services.
Ready to write your first plugin?
→ Jump to Writing a Plugin.
Need to understand scene reloads or static state?
→ Read Scene Lifecycle.
| Page | Description |
|---|---|
| Getting Started | Install TRCE and write your first plugin in 5 minutes |
| Plugin System | TrcePlugin lifecycle, attributes, dependency ordering |
| Event System | GlobalEventBus, EntityEventBus, defining custom events |
| Service System | TrceServiceManager — register and consume services |
| Built-in Services | All interfaces TRCE provides out of the box |
| Writing a Plugin | Step-by-step guide with a complete working example |
| Scene Lifecycle | How systems initialize, reset, and shut down across scene reloads |
| Security System | HmacSigner, SnapshotSync, ServerHitValidator |
| Testing Guide | How to run the built-in tests and write your own |
| UI Components | Built-in HUD panels and how to set them up |
| Plugin Rules | What you must and must not do |
Plugin — A self-contained feature module. Inherits TrcePlugin. Has a lifecycle (enable/disable).
Service — A capability exposed through an interface (e.g. IEconomyService). Plugins register services so other plugins can use them without knowing who provides them.
Event — A readonly struct broadcast through GlobalEventBus. Any plugin can publish or subscribe. Zero memory allocation on publish.
SandboxBridge — The only place that calls s&box APIs directly. If s&box updates, only this file needs to change.
Games Layer → Your game modes
Plugins Layer → Feature plugins (Combat, Economy, Social...)
Kernel Layer → Framework core (interfaces + infrastructure)
SandboxBridge → s&box API wrapper
TRCE Framework — Built by the TRCE Team
Inspired by the Spigot plugin ecosystem