kettle

Kotlin utilities for Quilt mod development

---

Project maintained by Cypher121 Hosted on GitHub Pages — Theme by mattgraham

Kettle User Guide

In this guide you will find an overview of features provided by Kettle, as well as how to start using Kettle for your own mod.

Note on compatibility

This library is intended for use with Quilt mods. It will likely not be compatible with Fabric.

Table of Contents

• Getting started
• API Reference
• Extensions
• Schedulers

Getting started

1) Include Kettle as a dependency for your project.

repositories {
    mavenCentral()
}

dependencies {
    modImplementation("coffee.cypher.kettle:kettle:<latest_version>")
}

2) Declare the dependency in your quilt.mod.json

{
  "depends": {
    "kettle": ">=<latest_version>"
  }
}

API Reference

To view the full API documentation, follow this link.

Extensions

Kettle includes a variety of extension functions and properties, such as:

• Accessing inventories with operators and iterables
• Vector and box utilities
• World access shorthands
• and more!

See the API reference for the full list.

Note: more extensions are available in the Quilt Kotlin Libraries, which is highly recommended for Kotlin development on Quilt!

Schedulers

Tick-based schedulers allow the user to control several concurrent tasks at once. TickingScheduler can be manually controlled, while TaskTicker can be used directly as the BlockEntity ticker.

Read more on schedulers, in the Scheduling API Guide.