Cultiva Integration

Optional compatibility, client-side utilities, and shared resources for mods built on top of the Cultiva ecosystem.

This package is not required for using Cultiva APIs or developing addons. It exists as a convenience layer that provides compatibility helpers, reusable client features, and example resource implementations that can be adopted, modified, or replaced as needed.

Projects that only depend on backend systems, registries, networking, or gameplay APIs can safely omit this module.

Overview

Cultiva Integration contains a collection of optional integrations and client-facing utilities designed to simplify addon development and improve interoperability between independent mods.

The module acts as a lightweight bridge between Cultiva Core and external systems while also providing reusable assets and examples for common modding tasks.

Package Root

net.xsoras.cultiva_integration

Required Dependency

net.xsoras.cultiva_core

Main Module

cultiva-integration

Features

Curios Compatibility

Provides optional integration with the Curios API.

Features include:

• Curios presence detection
• Safe compatibility wrappers
• Equipment slot helper methods
• Optional Curios-only feature registration
• Runtime fallback when Curios is not installed

This allows addons to support Curios without introducing hard dependencies throughout the codebase.

Client Status Overlay

Includes a lightweight title screen and client overlay system.

Possible uses:

• Mod status indicators
• Version information
• Compatibility warnings
• Development builds and debug notices
• Addon branding or custom startup messages

The overlay is intentionally isolated from gameplay logic and can be disabled or replaced by addon developers.

Network Compatibility Utilities

Provides helper classes that simplify communication between modules.

Included utilities may be used for:

• Compatibility packet forwarding
• Version negotiation
• Optional feature synchronization
• Safe cross-mod communication
• Client/server compatibility checks

These wrappers reduce duplicated networking code in compatibility-focused projects.

Shared Resource Bundle

The package contains example resources that can be used directly or serve as templates for custom projects.

Included resource categories:

• Mod logo
• Metadata files
• Language translations
• GUI textures
• Icons
• Example asset layouts
• Pack structure examples

Developers are encouraged to replace these resources with their own branding and assets when creating independent addons.

Project Structure

Example layout:

cultiva-integration
├── client
│   ├── overlay
│   └── screens
├── compat
│   ├── curios
│   └── networking
├── resources
│   ├── textures
│   ├── lang
│   ├── icons
│   └── metadata
└── util

The exact structure may evolve between releases.

Intended Use Cases

This module is recommended for:

Compatibility Addons

Projects that need optional support for external mods such as Curios.

Client Enhancements

Mods that want lightweight overlays, indicators, or startup UI elements without implementing them from scratch.

Resource Templates

Developers looking for examples of asset organization, localization structure, and mod metadata configuration.

Modular Architectures

Projects that keep compatibility code separate from gameplay systems to maintain cleaner dependencies.

Design Philosophy

Cultiva Integration follows several principles:

• Optional by default
• No gameplay requirements
• Safe dependency boundaries
• Easy replacement of assets
• Minimal overhead
• Modular compatibility layers

The goal is to provide useful building blocks without forcing any branding, visual identity, or implementation details onto downstream projects.

When Should You Use It?

Use this package if you need:

✅ Curios compatibility helpers

✅ Shared networking compatibility utilities

✅ Lightweight client overlays

✅ Example resource layouts

✅ Modular compatibility code

You can skip this package entirely if your mod only requires:

✅ Cultiva Core APIs

✅ Registries

✅ Gameplay systems

✅ Backend functionality

✅ Data-driven integrations

License & Customization

All integration components are intended to be reusable and adaptable.

Addon developers may:

• Use only selected modules
• Replace included resources
• Extend compatibility helpers
• Create custom overlays
• Build independent branding on top of the provided examples

Cultiva Integration should be viewed as a toolkit rather than a mandatory framework component.