Katton

English

简体中文

English

简体中文
On this page

Katton Introduction ​

Welcome to Katton. This wiki contains documentation and guides for using the Katton modding framework. Whether you're a beginner looking to get started or an experienced modder seeking advanced tips, you'll find valuable information here.

Download on ModrinthInstall Katton for your Minecraft loaderView Source on GitHubBrowse releases, issues, and source code

What is Katton? ​

Katton is a powerful modding framework for Minecraft that allows you to use Kotlin scripts to create and modify game content. With hot-reloadable scripts, you can see your changes in real-time without needing to restart the game.

Katton supports both Fabric and NeoForge, as well as Paper plugin servers. We are trying to keep the API as consistent as possible between the platforms, but there may be some differences in available events and features. Paper is server-only, so client-side features like rendering and the pack UI are not available there.

Why Katton? ​

  • Ease of Use: Katton's intuitive API and hot-reload feature make it easy for modders of all skill levels to create and test their mods quickly.
  • Flexibility: With Kotlin's powerful features, you can create complex mods that interact with Minecraft in unique ways.
  • Performance: Katton uses Kotlin Scripts to directly interact with Java objects during the runtime of Minecraft, ensuring high performance and seamless integration.
  • Powerful API: Katton provides a comprehensive API that allows you to access and modify many parts of the game: events, commands, registries, datapack calls, rendering, and runtime injection.
  • Modify Existing Content: Beyond adding new content, you can change vanilla blocks, items, recipes, loot tables, entity attributes, and villager trades — see the Modify Content guide.
  • In-Game Management: Manage your script packs through a built-in GUI (press K!), toggle packs on/off, and monitor registries with diagnostic commands — all without leaving the game.

Where to Go Next ​

Get StartedWrite your first packScript PacksLearn pack layout and manifest fieldsPlatformsCompare Fabric, NeoForge, and PaperArchitectureUnderstand reload and client sync internals

I don't know Kotlin ​

Don't worry! Kotlin is a modern programming language that is easy to learn, especially if you have experience with Java or other C-style languages. There are plenty of resources available online to help you get started with Kotlin, including the official Kotlin documentation and various tutorials on platforms like YouTube and Udemy.

In the following sections, you'll find guides on how to get started with Katton, as well as detailed API documentation and examples to help you create your own scripts.