> This project is still **working in progress**.
\n>
\n> Some interfaces may not work \/ change in the future.
\n>
\n> Use it as your own risk.<\/p>\n
\u26cf\ufe0f (Probably) Full Kotlin support for Kyori Adventure.<\/p>\n
## \u2757 Notice
\nFor **Paper** platform, you have two plugins to download: `bundle` and `spacefree`.
\n`bundle` ver. will shade kotlin stdlib into the plugin, and `spacefree` ver. will download kotlin stdlib with library loader provided by paper.<\/p>\n
For **Velocity** platform, only `bundle` ver. is provided because Velocity doesn’t provide any way to download dependency from maven repository.<\/p>\n
## \ud83e\udd14 Goal<\/p>\n
Since Kotlin brought us the ability to create Extensions, we can create DSLs.<\/p>\n
This project aimed to create many DSL utilities for adventure’s builder pattern API, which make your life easier.<\/p>\n
## \ud83d\udce6 Artifacts<\/p>\n
### Repository<\/p>\n
“`kotlin
\nrepositories {
\n maven(uri(“https:\/\/maven.nostal.ink\/repository\/maven-public\/”))
\n}
\n“`<\/p>\n
### Dependency<\/p>\n
“`kotlin
\ndependencies {
\n \/\/ Use shadowJar to shade the artifact into your jar
\n \/\/ or use standalone paper plugin provided on Modrinth (you are right here!)
\n api(“plutoproject.adventurekt:core:2.1.1”)
\n}<\/p>\n
\/\/ If you want to shade this project, we recommend that relocate package to yours.
\ntasks.shadowJar {
\n relocate(“plutoproject.adventurekt”, “com.example.libs.adventurekt”)
\n}
\n“`<\/p>\n
## \u2615 Usage<\/p>\n
### Creating a component ### Applying styles Also, you can use old styles from `v1` like directly connect all styles with just `with` or `without` keyword. \/\/ after 2.1.0, adventure kt added a simplier usage for color component { \/\/ or just ### Click & Hover events ### Modifying MiniMessage \/\/ you can also deliver a MiniMessage object to builder unparsedPlaceholder(“name”, “DeeChael”) “`kotlin ### Full usage example<\/p>\n #### Screenshot<\/p>\n <\/p>\n #### Code<\/p>\n “`kotlin actions {<\/p>\n newlineAction { }<\/p>\n replacements { text { “supplier style” } text(“this is a super looooooooooooooooooooooong text to test gradient”) with textGradient(red, green, yellow, darkPurple)<\/p>\n \/\/ use component default mini message \/\/ use default mini message with custom placeholder and other things Kotlin DSL support for Adventure library.<\/p>\n","protected":false},"featured_media":7681,"template":"","meta":{"_minecraft_slug":"adventurekt","_minecraft_project_id":"dh1lAaSy","_minecraft_author":"DeeChael","_minecraft_license":"MIT","_minecraft_downloads":150,"_minecraft_follows":0,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"adventurekt.zip","_minecraft_size_bytes":5785430,"_minecraft_version_count":3,"_minecraft_updated_at":"2026-05-16T13:29:48.813249Z","_minecraft_date_created":"2025-06-29T02:05:11.429191Z","_minecraft_date_modified":"2025-06-21T08:15:49.966638Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/adventurekt","_minecraft_icon_attachment_id":7681,"_minecraft_imported_at":"2026-05-31T14:51:59+00:00","_minecraft_import_hash":"0c8901df11a67e2d9367bc7555144409","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[873,127,92,985],"mod_loader":[132],"minecraft_version":[54,55,56,57,58,59,36,60,93,94,101,102,62,37,73,74,38,78,79],"class_list":["post-7680","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-library","mod_category-paper","mod_category-utility","mod_category-velocity","mod_loader-paper","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6"],"yoast_head":"\n
\nYou can create components with component function simply.
\n“`kotlin
\nval component: Component = component {
\n text(“This is a text component, nothing special.”) \/\/ simply create a component
\n text { “Text component here” } \/\/ lambda with return
\n translatable { “gui.ok” } \/\/ use locale related string
\n keybind { “key.inventory” } \/\/ use keybinds related string
\n raw { Component.text(“text”) } \/\/ use adventure component directly
\n mini(“
\n newline() \/\/ line break
\n space() \/\/ just a ” ”
\n empty() \/\/ nothing
\n}
\n“`
\nIf you want to use adventure-kt to build lore for Minecraft items, you can use `componentList` function.
\n“`kotlin
\nval components: List
\n text { “first line” }
\n text { “second line” }
\n}
\nItemLore.lore(components)
\n“`<\/p>\n
\nYou can use `with` keyword to add a style and `without` keyword to remove a style.
\nAll the styles connected with `and` after a `with` keyword will all be considered as `with` styles.
\nOtherwise, all the styles connected with `and` after `without` keyword will all be considered as `without` styles.<\/p>\n
\n“`kotlin
\ncomponent {
\n \/\/ due to shadow colors is customizable, color now split into text types and shadow types
\n \/\/ simply add text and shadow in front of colors to use color types in advkt v2
\n text(“text”) with textRed and shadowBlack without italic and color \/\/ nothing changed at result because “without color” is the latest step
\n text(“text”) with underlined with textAqua with runCommand(“\/say hello”) \/\/ with “underlined” decoration, “aqua” text color and “run command” click event<\/p>\n
\n text(“text”) with red.text
\n}
\n“`
\nIf you are afraid of causing ambiguity, you can use style name to add styles.
\n“`kotlin
\ncomponent {
\n text(“text”) color red.text deco underlind undeco italic \/\/ with red text color, underlined decoration and without italic decoration
\n text(“text”) color null shadow blue.shadow \/\/ use null to remove colors, use shadow to apply shadow colors
\n}
\n“`
\nIf you have used ArkUI or SwiftUI, you can use functions after component to add styles.
\n“`kotlin
\ncomponent {
\n text(“text”)
\n .color(red.text)
\n .decoration(italic, false)
\n}
\n“`
\nAfter 2.1.0, you can use `style` function to create a reusable style or to apply styles more obviously.
\n“`kotlin
\nval generalStyle = style {
\n textColor(“#66ccff”)
\n shadowColor(green)
\n decoration(underlined)
\n undecoration(italic)
\n}<\/p>\n
\n text(“text”) provide generalStyle<\/p>\n
\n text(“text”) provide style {
\n textColor(“#66ccff”)
\n shadowColor(green)
\n decoration(underlined)
\n undecoration(italic)
\n }
\n}
\n“`<\/p>\n
\nJust like styles, you can apply click events and hover events with keywords `with` and `without`.
\n“`kotlin
\ncomponent {
\n text(“text”) with \/* click event *\/ runCommand() with \/* hover event *\/ showText {
\n text(“hover text!”)
\n }
\n“`<\/p>\n
\nYou may have needs to change MiniMessage object when add MiniMessage strings, you can modify component mini message object.
\n“`kotlin
\ncomponent {
\n miniMessage {
\n strict()
\n tags {
\n tag(“aa”, Tag.inserting(Component.text(“aa”)))
\n }<\/p>\n
\n provide(MiniMessage.miniMessage())
\n }
\n}
\n“`
\nWhen add MiniMessage texts, you can modify when adding texts.
\n“`kotlin
\ncomponent {
\n mini(“
\n target(audience)<\/p>\n
\n componentPlaceholder(“events”) {
\n text(“No events here!”)
\n }
\n }
\n}
\n“`
\n### Overriding actions
\nYou can override some actions for better usage.
\n“`kotlin
\ncomponent {
\n actions {
\n newlineAction {
\n \/\/ do sth
\n it.container \/\/ ComponentKt object, which is the component builder of adventure-kt
\n it.value \/\/ Component? object, set it to null and builder will not append this component, or set to other component to add the component you want
\n }
\n spaceAction {
\n \/\/ do sth
\n }
\n emptyAction {
\n \/\/ do sth
\n }
\n }
\n}
\n“`
\nFor example, to make use of newline component to create a list of components instead of use linebreak
\n“`kotlin
\nfun lore(content: ComponentKt.() -> Unit): ItemLore {
\n val components = mutableListOf
\n val last = component {
\n actions {
\n newlineAction {
\n components.add(it.cleanBuild())
\n }
\n }
\n content()
\n }
\n components.add(last)
\n return ItemLore.lore(components)
\n}
\n“`
\nAfter 2.1.0, the example above can be replaced with `componentList` function.
\n“`kotlin
\nfun lore(content: ComponentKt.() -> Unit): ItemLore {
\n return ItemLore.lore(componentList(content))
\n}
\n“`
\n### Creating a title (WIP for v2)<\/p>\n
\ntitle {
\n mainTitle {
\n text(“This is a main title.”)
\n }
\n subTitle {
\n text(“This is a sub title.”)
\n }
\n \/\/ support both Kotlin duration and Java duration
\n times {
\n fadeIn(1.seconds)
\n stay(1.seconds)
\n fadeOut(1.seconds)
\n }
\n}
\n“`<\/p>\n
\ncomponent {
\n miniMessage {
\n strict()
\n tags {
\n tag(“aa”, Tag.inserting(Component.text(“aa”)))
\n }
\n provide(MiniMessage.miniMessage()) \/\/ highest priority
\n }<\/p>\n
\n it.value = null \/\/ clear the original component
\n }<\/p>\n
\n override()
\n replacement {
\n once()
\n matchLiteral(“fuck”)
\n replace {
\n space()
\n text(“****”) with textRed and underlined
\n space()
\n }
\n }
\n }<\/p>\n
\n text { true }
\n text(“aaa”) with “#66ccff” and bold and strikethrough without italic and strikethrough
\n text(“color showcase”) with textRed with shadowDarkBlue
\n text(“bedrock colors”) with textMaterialGold<\/p>\n
\n mini(“
\n mini(“
\n unparsedPlaceholder(“name”, “DeeChael”)
\n componentPlaceholder(“events”) {
\n text(“No events here!”)
\n }
\n }
\n }
\n“`<\/p>\n","protected":false},"excerpt":{"rendered":"