forked from Kweebec_Network/core-vitals
NetworkCore Docs
NetworkCore is the foundational plugin every other KweebecNet plugin depends on. It owns metrics, cross-server messaging, and the server-discovery layer.
If you're building a plugin that needs to talk to other servers, record stats, or know who else is online, you depend on this.
Reading order
- 01_Overview.md - what NetworkCore actually does and why it exists
- 02_Plugin_Integration.md - how another plugin depends on it and gets a reference
- 03_Configuration.md - config.json + env vars
- 04_Metrics.md - MetricsService API and the Prometheus endpoint
- 05_MessageBus.md - Redis pub/sub for cross-server events
- 06_ServerRegistry.md - discovery and presence events
- 07_RPC.md - request/response between servers
- 08_Commands.md - the /networkcore admin command
- 09_Operations_And_Security.md - auth token, what's not secured, ops checks
Quick reference
| Thing | Class |
|---|---|
| Plugin entry | NetworkCore |
| Singleton | NetworkCore.getInstance() |
| Manifest dependency string | kewwbec:NetworkCore |
| Default Redis | 127.0.0.1:6379 |
| Default Prometheus endpoint | http://127.0.0.1:9100/metrics |
| Auth env var | NETWORK_AUTH_TOKEN |
| Redis password env var | REDIS_PASSWORD |