Documentación de la API de mods

Documentación de referencia de todo lo que puede hacer un mod. Espejo de la documentación interna mod-api del editor, publicada aquí para que los autores puedan navegarla sin necesitar el código fuente del editor.

Documentos

Documento	Qué aprenderás
getting-started	Escribe tu primer mod en cinco minutos
publishing	Recorrido práctico (construye, publica y envía tu primer mod, ~25 min) + referencia completa de publicación
api-reference	Cada método, tipo y superficie de ctx disponible para los mods
events-reference	Cada evento que emite el editor, con las formas de payload
quick-reference	Chuleta de una página para las llamadas comunes de la API
api-changelog	Qué cambió en cada versión de la API
troubleshooting	Problemas comunes y cómo arreglarlos
mod-api.d.ts	Definiciones de tipo TypeScript — colócalas en tu proyecto para autocompletado en el IDE
app-strings.json	Todas las cadenas traducibles del editor, con valores vacíos — la plantilla para un mod de traducción

¿Publicas tu mod a través del Marketplace? Consulta publishing.md —empieza con un tutorial práctico y luego la referencia completa.

Usar mod-api.d.ts en tu proyecto de mod

Si escribes tu mod en TypeScript (o usas VS Code con comprobación de tipos JS), descarga mod-api.d.ts y referéncialo para autocompletado completo sobre ctx:

index.js

/** @param {import("./mod-api").ModContext} ctx */
export function activate(ctx) {
  ctx.ui.showToast({ message: "typed!" });  // ← el autocompletado funciona
}

O para TypeScript:

index.ts

import type { ModContext } from "./mod-api";

export function activate(ctx: ModContext): void {
  ctx.ui.showToast({ message: "typed!" });
}

El archivo es un único .d.ts autocontenido sin dependencias. Cópialo junto a tu index.js / index.ts.

Versionado de la API

manifest.json#apiVersion es la Mod API mínima que tu mod necesita — la versión que introdujo el método, evento o campo más nuevo que usa. Cada cambio de la API recibe una versión nueva (patch incluido), y un editor que no ofrece la versión que pides rechaza el mod por adelantado: bloqueado en el Marketplace, error en el Mod Manager. Así tu mod nunca se carga a medias contra un editor al que le falta lo que llama, y apuntar a una versión antigua sigue siendo seguro para siempre. Consulta api-changelog para ver qué añadió cada versión.

Reportar errores de documentación

Abre un issue en este repositorio si una doc es incorrecta, está desactualizada o le falta algo. Las correcciones de docs son bienvenidas vía PR.