Referencia del SDK

Una lista de consulta con todo lo que puede declarar un mod. Para aprender a hacerlo, mira las guías enlazadas en cada tabla.

Las rutas de esta página usan \. El juego no distingue mayúsculas de minúsculas.

1. Estructura del mod

Un mod es una carpeta en mods\. Las carpetas que empiezan por . o _ se ignoran. Sin mod.json, el juego crea uno básico (con autoGenerated).

"Jugabilidad" = todos los jugadores deben tener el mismo mod (README).

• Extensiones prohibidas: .exe .dll .asi .bat .cmd .com .scr .ps1 .vbs .js .msi .sys .cpl .lnk .reg .jar .hta .wsf .pif. Con una de ellas, el mod no se carga.
• Una extensión que no es de las conocidas y tampoco está prohibida se permite y nunca se ejecuta.
• Si dos mods incluyen el mismo archivo, uno suelto gana a uno dentro de un .pak; entre dos sueltos, o entre dos dentro de .pak, gana el que va antes en el orden de carga. El juego calcula ese orden, nadie lo elige: primero lo que piden los mods (un mod va por encima de los que necesita en requires y de los de su loadAfter, y por debajo de los de su loadBefore); después los mods cosméticos van por encima del contenido (mapas, batallas, conquista), y el contenido por encima de los mods que cambian la jugabilidad; en caso de empate, por id. Los mismos mods dan el mismo orden en todos los ordenadores. En la ficha de cada mod, el gestor de contenido lista los archivos que comparte con otros mods activos y de cuál se usa la copia de cada uno. Si dos mods activos reemplazan los mismos archivos de jugabilidad y ninguno nombra al otro en requires, loadAfter o loadBefore, se muestra como un problema: usa solo uno, o un parche de compatibilidad (un mod que incluye los archivos combinados y tiene a ambos en su loadAfter). Cuando todos los archivos que comparten son cosméticos (texturas, sonidos, interfaz), el jugador puede elegir de quién se usan los archivos; la elección se guarda en el perfil, solo se aplica a archivos sueltos y no cambia ni el orden de carga ni lo que cuenta online. Para cambiar unos pocos valores de un archivo que otro mod también puede cambiar, es mejor un parche (sección 6): los parches se suman en lugar de reemplazar el archivo.

Carpeta de pruebas <game>\mod\ (no hace falta ningún mod; gana a todos los mods):

2. mod.json

Un texto por idioma toma el del idioma del juego; si falta, el inglés; si tampoco está, el primero.

Alias en inglés que el juego también lee: name, description, license, redistributable, language (con code, name).

3. civs\<id>.json

Guía: Civilizaciones.

• race="<id>" en las <properties> de una clase usa la civilización por su id o por su internalName.
• id o index repetidos: gana el del mod que va antes; los demás se ignoran con una advertencia.
• Alias en inglés: index, name, letter, template, internalName, folder, random, biome, ai, ownAi.

4. specials\*.json

Guía: Especialidades de unidad.

• id o bit repetidos: gana el del mod que va antes.
• En unit_specials, los nombres van separados por comas; los de mod no distinguen mayúsculas de minúsculas. El juego ignora los que no conoce.
• Alias en inglés: name, description, icon.

5. options\<id>.json

Guía: Opciones de partida.

• Un values con menos de 2 o más de 16 elementos hace que se ignore la opción entera.
• Bits: interruptor 1; lista de 2 valores 1; de 3-4, 2; de 5-8, 3; de 9-16, 4. Se asignan en orden alfabético de id.
• Con un id repetido, gana el del mod que va antes.
• Alias en inglés: name, description, values, default.

6. Parches

Guía: Parches. Un parche va en patches\<path of the game file>. Solo .xml, .ini y .vs. Orden: del último mod del orden de carga al primero, de modo que el primero tiene la última palabra; mod\patches va el último.

XML

La primera etiqueta del parche es la raíz (normalmente se llama <patch>); sus hijas son las operaciones, que se aplican en orden. Los nombres de operaciones, etiquetas y atributos no distinguen mayúsculas de minúsculas.

• select es obligatorio. Con <set> no puedes asignar un atributo que se llame select, optional o unset.
• optional: 1, yes, si, sí o true evitan el error si el selector no encuentra nada.
• <add> y <replace> sin contenido dan error.
• Un selector sin resultados, o una operación desconocida, se omite con un error; las demás siguen. Si el parche no está bien formado, no se aplica ninguna operación.
• El archivo parcheado conserva los comentarios y las comillas; los atributos se juntan en una sola línea.

Selector

Puedes encadenar condiciones ([@a='v'][2]). No existe nada más (and, contains, text(), ..). Empieza siempre con / o //.

INI

Cada línea del parche, bajo una [Seccion] (obligatoria antes de cualquier línea):

Las claves y las secciones no distinguen mayúsculas de minúsculas. Un comentario al final de una línea del parche no se elimina.

Scripts .vs

Las directivas empiezan con @ en la primera columna; el código que va debajo de cada una es lo que se inserta.

• TEXTO es un trozo literal de una línea (distingue mayúsculas de minúsculas). Se usa la primera línea que lo contiene, y las directivas se aplican en orden: ven lo que insertaron las anteriores.
• Error (y la directiva se omite): directiva desconocida, @before/@after/@replace sin TEXTO, una directiva sin código (salvo @replace), TEXTO no encontrado.

7. Eventos de script

Guía: Scripts. Archivo: events\<Event>.vs. Se ejecuta en todos los PC; con varios mods, se ejecutan todos.

• Salvo OnGameStart, se ejecutan de inmediato y no pueden esperar.
• Un evento que se dispara dentro de sí mismo se corta a los 4 niveles.
• Si el script falla en ejecución, el registro lo anota hasta 5 veces por script.
• Solo se leen estos nombres de evento. Los nombres de los parámetros los eliges tú.

8. Funciones Mod_*

Guía: Scripts. La API actual es la 6; forma parte de la comprobación de multijugador.

Constantes de script: el id de cada civilización de mod con la primera letra en mayúscula (valor = su index) y el id de cada especialidad de unidad de mod (valor = su bit).

9. imperivm-mod.ini

Está en la carpeta del juego. Se lee al arrancar.

10. Límites

Las guías explican cómo hacer cada cosa; esta es la lista completa. Vuelve al README.