Cultiva Runtime API
- By
Core runtime API powering execution and services across the Cultiva ecosystem.
Cultiva Runtime
Shared runtime systems, scheduling utilities, networking helpers, and optional compatibility features used throughout the Cultiva ecosystem.
This module provides the foundational runtime layer that powers higher-level Cultiva projects. It contains reusable APIs for task scheduling, feature management, cooldown handling, networking, and optional compatibility integrations.
While it can be used directly by addon developers, its primary purpose is to provide common infrastructure shared between Cultiva modules.
Overview
Cultiva Runtime is a lightweight runtime framework designed for modular NeoForge projects.
The package exposes utility systems that reduce boilerplate and provide consistent behavior across independent addons while remaining flexible enough for custom implementations.
Package Root
net.xsoras.cultiva_runtime
Main Module
cultiva-runtime
Supported Loader
NeoForge
Included Systems
Runtime API
Core runtime entry points and shared functionality.
Main classes:
CultivaApi
CultivaCore
These APIs provide a centralized access layer for runtime services used by Cultiva-based projects.
Tick Scheduler
Provides delayed and scheduled task execution.
Main classes:
CultivaTickScheduler
CultivaServerWorkQueue
Possible use cases:
- Delayed actions
- Timed gameplay effects
- Cooldown expiration handling
- Deferred world operations
- Scheduled server tasks
The scheduler helps avoid duplicated tick-management logic across projects.
Networking API
A lightweight abstraction layer for custom packet handling.
Main classes:
CultivaNetworkApi
CultivaPayloadRegistry
Features include:
- Payload registration
- Packet organization
- Modular networking support
- Runtime-safe communication
- Simplified addon integration
The networking layer is designed to make packet registration and synchronization more consistent between modules.
Cooldown System
Provides reusable cooldown management utilities.
Main class:
CultivaCooldowns
Possible applications:
- Ability cooldowns
- Tool recharge systems
- Skill timers
- Item restrictions
- Temporary action locks
The implementation is generic and can be adapted to a wide range of gameplay mechanics.
Feature Flag System
Provides runtime feature toggles.
Main class:
CultivaFeatureFlags
Feature flags can be used for:
- Experimental features
- Development builds
- Optional mechanics
- Compatibility-specific behavior
- Version-gated functionality
This allows systems to be enabled or disabled without tightly coupling logic throughout the project.
Curios Compatibility
Includes optional Curios support utilities.
Features include:
- Curios detection
- Runtime compatibility checks
- Safe integration helpers
- Optional Curios functionality
Projects remain functional even when Curios is not installed.
Project Structure
Example layout:
cultiva-runtime
├── api
│ ├── network
│ ├── runtime
│ └── scheduler
├── core
├── util
└── compat
The internal structure may evolve between releases.
Intended Use Cases
Shared Runtime Infrastructure
Projects that require common scheduling, networking, and runtime services.
Modular Addons
Independent addons that need a consistent backend framework.
Experimental Features
Systems that benefit from runtime feature flags and controlled rollout mechanisms.
Server-Side Utilities
Projects that need task queues, delayed execution, or centralized cooldown management.
Design Philosophy
Cultiva Runtime follows several principles:
- Lightweight by default
- Modular architecture
- Runtime-first design
- Minimal boilerplate
- Safe compatibility boundaries
- Reusable infrastructure
- Extensible APIs
The goal is to provide dependable backend systems without imposing gameplay design decisions on addon developers.
When Should You Use It?
Use Cultiva Runtime if you need:
✅ Task scheduling
✅ Server work queues
✅ Cooldown management
✅ Runtime feature flags
✅ Networking utilities
✅ Shared backend infrastructure
✅ Optional Curios compatibility
You may not need this module if your project only contains:
✅ Standalone content
✅ Pure data packs
✅ Simple client assets
✅ Independent gameplay systems with no shared runtime requirements
License & Customization
Cultiva Runtime is designed as reusable infrastructure.
Developers may:
- Extend runtime systems
- Create custom schedulers
- Register additional networking layers
- Build custom feature flag implementations
- Integrate external compatibility modules
The runtime layer is intended to serve as a foundation, not a restrictive framework.
Cultiva Runtime API Team
Owner
