Referencia del SDK

Lista consultable de todo lo que un mod puede declarar. Para aprender a hacerlo, mira las guías enlazadas en cada tabla.

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

1. Estructura de un mod

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

"Jugabilidad" = todos los jugadores deben llevar 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, el mod no se carga.
• Una extensión que no es de las conocidas, y no está prohibida, se permite y nunca se ejecuta.
• Si dos mods traen el mismo archivo, un archivo suelto gana a uno que va dentro de un .pak; entre dos sueltos, o entre dos dentro de .pak, gana el que va primero en el orden de carga. Ese orden lo calcula el juego, no se elige: primero cuenta 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 estéticos van por encima del contenido (mapas, batallas, conquista) y este por encima de los que cambian la jugabilidad; a igualdad, por id. Con los mismos mods sale el mismo orden en todos los ordenadores. En la ficha de cada mod, el gestor muestra los archivos que comparte con otros mods activos y de cuál se usa cada uno. Si dos mods activos reemplazan los mismos archivos de jugabilidad y ninguno nombra al otro en requires, loadAfter o loadBefore, sale como problema: hay que usar solo uno, o un parche de compatibilidad (un mod que trae los archivos combinados y tiene a los dos en su loadAfter). Si todos los archivos que comparten son estéticos (texturas, sonidos, interfaz), el jugador puede elegir de qué mod se usan; la elección se guarda en el perfil, solo vale para archivos sueltos y no cambia el orden de carga ni lo que cuenta en el online. Para cambiar unos pocos valores de un archivo que otro mod también puede tocar, mejor un parche (sección 6): los parches se suman en vez de reemplazar el archivo.

Carpeta de pruebas <juego>\mod\ (sin crear un mod; gana a todos los mods):

2. mod.json

Un texto por idioma elige el del juego; si no está, el inglés; si no, el primero.

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

3. civs\<id>.json

Guía: Civilizaciones.

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

4. specials\*.json

Guía: Especialidades.

• id o bit repetidos: vale el del mod que va primero.
• En unit_specials, los nombres van separados por comas; los de mod no distinguen mayú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 ignora la opción entera.
• Bits: interruptor 1; lista de 2 valores 1; de 3-4, 2; de 5-8, 3; de 9-16, 4. Entran por orden alfabético de id.
• Con id repetido vale el del mod que va primero.
• Alias en inglés: name, description, values, default.

6. Parches

Guía: Parches. Un parche va en patches\<ruta del archivo del juego>. Solo .xml, .ini y .vs. Orden: del último al primero del orden de carga, así que el primero tiene la última palabra; mod\patches el último.

XML

La primera etiqueta del parche es la raíz (se suele llamar <patch>); sus hijos son las operaciones, que se aplican en orden. Los nombres de operación, etiquetas y atributos no distinguen mayúsculas.

• select es obligatorio. No puedes poner con <set> un atributo llamado 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 salta con error; las demás siguen. Si el parche no está bien formado, no se aplica ninguna operación.
• El archivo parcheado conserva comentarios y comillas; los atributos pasan a una línea.

Selector

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

INI

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

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

Scripts .vs

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

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

7. Eventos de script

Guía: Scripts. Archivo: events\<Evento>.vs. Corre en todos los PCs; con varios mods se ejecutan todos.

• Salvo OnGameStart, se ejecutan al momento y no pueden esperar.
• Un evento que se dispara dentro de sí mismo se corta a los 4 niveles.
• Si el script falla al ejecutarse, el log lo apunta 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; entra en la comprobación de multijugador.

Constantes de script: el id de cada civilización de mod con la primera en mayúscula (valor = su index) y el id de cada especialidad 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 se hace cada cosa; esto es la lista completa. Vuelve al README.