Guía de mods

Cube Unbound está hecho para modificarse: casi todo el contenido son archivos JSON legibles y modelos de MagicaVoxel dentro de la carpeta mods/. No hace falta programar ni recompilar.

La carpeta mods/

Modelos .vox

• Se hacen con MagicaVoxel y se guardan en mods/models/…. En los JSON se nombran sin extensión: "model": "animals/wolf_body".
• En MagicaVoxel el eje Z es arriba y el frente del modelo mira hacia −Y. El juego lo convierte a sus ejes: +X derecha, +Y arriba, +Z adelante.
• El tamaño de cada vóxel lo fija voxelSize (en metros; 0,1 en personajes y objetos). Los muebles y estaciones usan 16 vóxeles por bloque.
• Las variantes de color cambian índices de la paleta: {"1": "E8742A"} pinta el color 1 de naranja. Así un mismo modelo da varios pelajes.

Tu primera criatura

Copia un archivo de mods/mobs/, cámbiale el id y ajusta lo que quieras. Este es el conejo real del juego:

{
  "id": "bunny",
  "name": "Conejo",
  "description": "Avanza a saltitos y se para a olfatear con las orejas tiesas.",
  "style": "hopper",
  "voxelSize": 0.06,
  "behavior": "wander",
  "tame": {
    "food": "berries",
    "bites": 2
  },
  "temper": "passive",
  "stats": {
    "health": 12,
    "armor": 0,
    "damage": 2,
    "regen": 0.5,
    "level": 1
  },
  "movement": {
    "type": "ground",
    "speed": 2.6,
    "width": 0.4,
    "height": 0.5
  },
  "spawn": {
    "count": 3,
    "group": 1,
    "biomes": [
      "plains",
      "forest",
      "snowy"
    ]
  },
  "variants": [
    {
      "1": "A07850",
      "2": "7E5C3C"
    },
    {
      "1": "9C9CA2",
      "2": "7A7A82"
    }
  ],
  "parts": [
    {
      "bone": "body",
      "model": "animals/bunny_body",
      "pivot": [
        3,
        0,
        3.5
      ],
      "at": [
        0,
        0,
        0
      ]
    },
    {
      "bone": "head",
      "parent": "body",
      "model": "animals/bunny_head",
      "pivot": [
        2.5,
        0,
        1
      ],
      "at": [
        0,
        3.5,
        2.5
      ]
    },
    {
      "bone": "tail",
      "parent": "body",
      "model": "animals/bunny_tail",
      "pivot": [
        1,
        1,
        2
      ],
      "at": [
        0,
        2.5,
        -3.5
      ]
    }
  ],
  "loot": [
    {
      "item": "raw_meat",
      "min": 1,
      "max": 1,
      "chance": 0.8
    }
  ]
}

Objetos

Cada archivo de mods/items/ es una lista de objetos. Tres ejemplos reales: un arma, una pieza de equipo y una comida.

[
  {
    "id": "short_sword_iron",
    "name": "Espada corta de hierro",
    "category": "weapon",
    "color": "iron_ore",
    "model": "items/short_sword_iron",
    "grip": [
      1.5,
      3.5,
      2.0
    ],
    "maxStack": 1,
    "weapon": {
      "type": "melee",
      "style": "slash",
      "damage": 10,
      "cooldown": 0.45,
      "reach": 2.7,
      "arc": 90
    }
  },
  {
    "id": "leather_helmet",
    "name": "Gorro de cuero",
    "model": "armor/leather_helmet",
    "category": "equipment",
    "color": "dirt",
    "equip": {
      "set": "leather",
      "slot": "helmet",
      "armor": 3,
      "health": 5
    }
  },
  {
    "id": "roasted_draconic_meat",
    "name": "Carne Dracónica Asada",
    "category": "material",
    "color": "terracotta_brown",
    "maxStack": 64,
    "food": {
      "heal": 60,
      "seconds": 600,
      "stats": {
        "damage": 0.08
      }
    }
  }
]

Recetas

Archivos de mods/recipes/: listas de recetas. Sin station se fabrica a mano.

{
  "id": "glass_flask",
  "result": "glass_flask",
  "count": 4,
  "station": "forge",
  "ingredients": [
    {
      "item": "sand",
      "count": 2
    },
    {
      "item": "coal",
      "count": 1
    }
  ]
}

Estaciones válidas: workbench (Banco de trabajo), forge (Fragua), anvil (Yunque), loom (Telar), alchemy_cauldron (Caldero de alquimia), runic_forge (Forja Rúnica), elven_forge (Forja Élfica), titan_anvil (Yunque de Sangre de Titán), creation_altar (Altar de la Creación), campfire (Hoguera), cooking_pot (Olla), oven (Horno), barrel (Barril).

Packs de recursos

Un pack cambia cómo se ve o suena el juego sin tocar sus reglas. Es una carpeta en resourcepacks/ que imita la estructura de mods/ y sólo trae los archivos que sustituye: modelos .vox, sonidos .wav u .ogg e imágenes .png. Los datos .json no se pueden sustituir desde un pack.

resourcepacks/mi_pack/pack.json
resourcepacks/mi_pack/models/items/iron_sword.vox
resourcepacks/mi_pack/audio/sfx/step_grass.wav

{ "pack": { "pack_format": 1, "name": "Mi pack", "author": "Yo", "description": "Qué cambia", "version": "1.0.0" } }

Se activan y ordenan en el menú Packs de recursos; el de arriba gana. Son de cada jugador: en LAN cada uno lleva los suyos. El juego trae uno de ejemplo, resourcepacks/ejemplo_neon.

Plugins

Para quien programa: una DLL de 64 bits en mods/plugins/ que exporta GetModInterface() con la tabla de sdk/CubeModAPI.h (C puro). Ganchos: OnGameUpdate cada fotograma, OnDamageCalculate antes de aplicar un golpe y OnChunkGenerated al generar una columna de terreno (en varios hilos a la vez y tiene que ser determinista). Si un plugin falla, el juego lo apaga y sigue.

Un plugin es código con los permisos del jugador, así que sólo se cargan si el jugador lo permite en Opciones. Cuentan para la huella de mods de la LAN: anfitrión e invitados necesitan las mismas DLL.

Sonido y música

El juego sintetiza todos sus sonidos, así que no necesita ningún archivo. Para cambiar uno, deja un .wav (PCM de 16 bits, 44.100 Hz; mono para efectos, estéreo para música) con el nombre adecuado en mods/audio/sfx/ o mods/audio/music/. La lista completa está en mods/audio/LEEME.txt.

Buenas prácticas

• Usa identificadores propios (por ejemplo con un prefijo) para no chocar con los del juego ni con otros mods.
• Guarda los archivos en UTF-8.
• Prueba cada cambio abriendo el juego antes de seguir.
• Mira la referencia de datos para ver todos los valores que admite cada campo.