API

Interfaz

Formularios que el jugador rellena y elementos en pantalla: barras de jefe y un panel lateral. Todo funciona para cualquier cliente, tenga o no Crafting instalado.

Formularios

Un formulario tiene un título, un texto, campos y botones. Se declara en un archivo de ui/ y se muestra desde donde haga falta (un comando, un evento, al usar un ítem):

ui/shop.craftCraftScript
import { give_rubies } from "/lib/rewards"

const SHOP = form("Ruby shop", {
    body: "Rubies cost 10 emeralds each.",
    fields: [
        { slider: "amount", label: "Rubies", min: 1, max: 16, default: 1 },
        { toggle: "gift", label: "Wrap as a gift" },
        { choice: "pouch", label: "Pouch", options: ["leather", "silk"] },
        { text: "note", label: "Note" }
    ],
    buttons: [{ id: "buy", label: "Buy" }, "cancel"]
})

fun open_shop(p: Player) {
    p.show_form(SHOP, fun(r) {
        if r.button != "buy" { return }                  // closed with Esc or cancelled
        let n = int(r.number("amount") ?? 1)
        if p.inventory.count("minecraft:emerald") < n * 10 { p.send("&cNot enough emeralds"); return }
        give_rubies(p, n)
        if r.toggle("gift") { p.send("&dWrapped in {r.choice("pouch")}: {r.text("note")}") }
    })
}
commands/shop.craftCraftScript
import { open_shop } from "/ui/shop"

command shop describe "Buy rubies" {
    if player == null { return "Players only" }
    open_shop(player)
}
Campo Se escribe Se lee con
Texto { text: "note", label: "Nota", default: "" } r.text("note")
Interruptor { toggle: "gift", label: "Es un regalo", default: false } r.toggle("gift")
Deslizador { slider: "amount", label: "Cantidad", min: 1, max: 64, step: 1, default: 8 } r.number("amount")
Elección { choice: "color", label: "Color", options: ["rojo", "azul"], default: "rojo" } r.choice("color")
  • La clave de cada campo usa minúsculas, dígitos y _. label es lo que ve el jugador; si falta, se usa la clave.
  • buttons es una lista de { id, label } o solo del id. Un formulario sin botones recibe uno de “OK”.
  • En la respuesta, r.button es el id del botón pulsado, o null si el jugador cerró el formulario (Esc). r.values es un mapa con todos los campos.
  • La respuesta llega en la función que pasas a show_form; el resto del servidor sigue mientras el jugador decide.

En Kotlin

ui/ShopForm.ktKotlin
package com.example.rubies.ui

object ShopForm {
    private val form = Form("Ruby shop").apply {
        body = "Rubies cost 10 emeralds each."
        slider("amount", "Rubies", 1.0, 16.0, default = 1.0)
        toggle("gift", "Wrap as a gift")
        choice("pouch", "Pouch", listOf("leather", "silk"))
        text("note", "Note")
        button("buy", "Buy")
        button("cancel", "Cancel")
    }

    fun show(player: Player) = player.showForm(form) { r ->
        if (r.button != "buy") return@showForm                 // closed with Esc or cancelled
        val n = (r.number("amount") ?: 1.0).toInt()
        if (player.inventory.count(Identifier.parse("minecraft:emerald")) < n * 10) { player.send("&cNot enough emeralds"); return@showForm }
        player.give(ItemStack.of(Items.RUBY, n))
        if (r.toggle("gift") == true) player.send("&dWrapped in ${r.choice("pouch")}: ${r.text("note")}")
    }
}

Form(title) con body, text(key, label, default, maxLength), toggle(key, label, default), slider(key, label, min, max, step, default), choice(key, label, options, default) y button(id, label). player.showForm(form) { r -> … } recibe un FormResponse con button, values y text, toggle, number, choice.

Barras de jefe

Una barra en la parte alta de la pantalla, con título, color, progreso y estilo. Sirve para un temporizador, un evento del servidor o la vida de algo:

events/countdown.craftCraftScript
const TIMER = server.boss_bar("rubies:countdown", "&cRuby rush", "red", "segments_10")
let left = 60

on join { TIMER.show(player) }

every 1 second {
    left = max(0, left - 1)
    TIMER.progress = left / 60
    TIMER.title = "&cRuby rush: {left}s"
    if left == 0 { TIMER.remove() }
}
Miembro Qué hace
server.boss_bar(id, title?, color?, style?) Crea la barra o devuelve la que ya existe con ese id. Un id por barra: recargar el mod no la duplica.
bar.progress De 0 a 1.
bar.title El texto, con colores &.
bar.color pink, blue, red, green, yellow, purple, white.
bar.style solid, segments_6, segments_10, segments_12, segments_20.
bar.show(player), bar.hide(player) Quién la ve. bar.players los lista.
bar.remove() La quita a todos y libera el id.

En Kotlin: Crafting.server?.bossBar("rubies:countdown", "Tiempo", BarColor.RED, BarStyle.SEGMENTS_10), con las mismas propiedades en camelCase.

Panel lateral

Una lista de hasta 15 líneas en el lado derecho de la pantalla, distinta para cada jugador. Se vuelve a llamar para actualizarla:

events/welcome.craftCraftScript
import { visits } from "/lib/storage"

on join {
    player.set_sidebar("&6Rubies", [
        "&fVisits: &e{visits(player)}",
        "&fRubies: &c{player.inventory.count("rubies:ruby")}"
    ])
}
  • player.set_sidebar(title, lines) lo muestra o lo actualiza; solo ese jugador lo ve. Colores con &.
  • player.clear_sidebar() lo quita.
  • En Kotlin: player.setSidebar(title, lines) y player.clearSidebar().

Teclas de un mod

Un mod puede añadir teclas propias. Decláralas con key y reacciona con on key, que se ejecuta en el servidor para el jugador que la pulsó. e.key es el id con el espacio de nombres del mod (dashmod:dash).

content/keys.craftCraftScript
key "dash" { label: "Dash", default: "R" }
key "heal" { label: "Second wind", default: "G" }

on key(e) {
    let p = e.player
    if e.key == "dashmod:dash" && !p.has_cooldown("minecraft:feather") {
        let d = p.direction
        p.velocity = vector(d.x * 1.6, 0.35, d.z * 1.6)
        p.set_cooldown("minecraft:feather", 2)
    }
    if e.key == "dashmod:heal" { p.heal(6) }
}

Las teclas aparecen en Opciones > Controles > Asignar teclas, en una sección con el nombre del mod. Los jugadores pueden cambiarlas y su elección se conserva. default es el nombre de una tecla, como "R", "G", "F6" o "LEFT_ALT".

Los jugadores necesitan tener Crafting instalado en su juego para disponer de las teclas. En Kotlin: ContentBuilder.key("dash", label = "Dash", default = "R") y Crafting.events.on<PlayerKeyEvent> { e -> … }.

Lo que conviene saber

  • Los formularios, las barras y el panel los ve cualquier cliente de Minecraft Java 26.3, tenga o no Crafting. Un mod de servidor puede usarlos sin que nadie instale nada.
  • Los títulos, la barra de acción y los mensajes de chat siguen en El mundo y los jugadores.
  • Pantallas propias con tu propio diseño (menús, inventarios de máquinas) no existen todavía; ver la hoja de ruta.