core-network/docs/wiki/Home.md

Core Network Wiki

core-network is the Hytale plugin-side runtime for Kweebec Network control-plane access.

It provides:

• a shared ControlPlaneClient
• handwritten convenience clients for common server/player operations
• generated API endpoint descriptors from core-control-plane
• batched HTTP calls through /api/v1/batch
• API response storage policies for runtime, player, and asset-store-backed data
• reactive player cache hooks for ECS/event-driven invalidation and prewarming

Pages

• Getting Started
• Control Plane Client
• Batched API Calls
• API Response Storage
• Generated SDK
• Troubleshooting

Package Map

net.kewwbec.network
  ControlPlaneClient.java       shared client entry point
  NetworkPlugin.java            Hytale plugin entry point and scheduler hook
  client/                       handwritten domain clients
  http/                         low-level JSON HTTP transport
  batch/                        one-off and looped batched calls
  cache/                        cached API data and storage policies
  generated/api/v1/             generated endpoint descriptors
  models/                       handwritten response/request models

Design Rules

• Do not edit net.kewwbec.network.generated manually.
• Add handwritten runtime behavior outside generated.
• Treat core-control-plane as the API owner.
• Use batching for repeated or concurrent calls that can tolerate async completion.
• Use cache policies when plugin code needs shared ownership of API freshness or push timing.
• Use reactivePlayerCache() from ECS/event handlers when player cache state must react immediately to permission, sanction, notification, or join events.