Riferimento dell'SDK

Elenco da consultare di tutto ciò che una mod può dichiarare. Per imparare a farlo, guarda le guide collegate in ogni tabella.

I percorsi di questa pagina usano \. Il gioco non distingue maiuscole e minuscole.

1. Struttura di una mod

Una mod è una cartella di mods\. Le cartelle che iniziano con . o _ vengono ignorate. Senza mod.json, il gioco ne crea uno base (con autoGenerated).

"Gameplay" = tutti i giocatori devono avere la stessa mod (README).

• Estensioni vietate: .exe .dll .asi .bat .cmd .com .scr .ps1 .vbs .js .msi .sys .cpl .lnk .reg .jar .hta .wsf .pif. Con una di queste, la mod non si carica.
• Un'estensione che non è tra quelle note e non è vietata viene accettata e non viene mai eseguita.
• Se due mod hanno lo stesso file, un file sciolto vince su uno dentro un .pak; tra due file sciolti, o tra due dentro .pak, vince quella che viene prima nell'ordine di caricamento. Quell'ordine lo calcola il gioco, non si sceglie: prima conta ciò che chiedono le mod (una mod sta sopra a quelle di cui ha bisogno in requires e a quelle del suo loadAfter, e sotto a quelle del suo loadBefore); poi le estetiche stanno sopra ai contenuti (mappe, battaglie, conquista) e questi sopra alle mod che cambiano il gameplay; a parità, per id. Con le stesse mod esce lo stesso ordine su tutti i computer. Nella scheda di ogni mod, il gestore mostra i file che condivide con altre mod attive e di quale mod si usa ciascuno. Se due mod attive sostituiscono gli stessi file di gameplay e nessuna nomina l'altra in requires, loadAfter o loadBefore, appare come problema: bisogna usarne solo una, o una patch di compatibilità (una mod che porta i file uniti e ha entrambe nel suo loadAfter). Se tutti i file che condividono sono estetici (texture, suoni, interfaccia), il giocatore può scegliere di quale mod usarli; la scelta si salva nel profilo, vale solo per i file sciolti e non cambia né l'ordine di caricamento né ciò che conta online. Per cambiare pochi valori di un file che anche un'altra mod può toccare, è meglio una patch (sezione 6): le patch si sommano invece di sostituire il file.

Cartella di prova <gioco>\mod\ (senza creare una mod; vince su tutte le mod):

2. mod.json

Un testo per lingua sceglie quello del gioco; se manca, l'inglese; se manca, il primo.

Alias in inglese che il gioco legge comunque: name, description, license, redistributable, language (con code, name).

3. civs\<id>.json

Guida: Civiltà.

• race="<id>" in <properties> di una classe usa la civiltà tramite il suo id o il suo internalName.
• id o index ripetuti: vale quello della mod che viene prima; gli altri vengono ignorati con un avviso.
• Alias in inglese: index, name, letter, template, internalName, folder, random, biome, ai, ownAi.

4. specials\*.json

Guida: Specialità.

• id o bit ripetuti: vale quello della mod che viene prima.
• In unit_specials, i nomi sono separati da virgole; quelli delle mod non distinguono maiuscole e minuscole. Il gioco ignora quelli che non conosce.
• Alias in inglese: name, description, icon.

5. options\<id>.json

Guida: Opzioni di partita.

• Un values con meno di 2 o più di 16 elementi fa ignorare l'intera opzione.
• Bit: interruttore 1; lista di 2 valori 1; da 3-4, 2; da 5-8, 3; da 9-16, 4. Entrano in ordine alfabetico di id.
• Con id ripetuto vale quello della mod che viene prima.
• Alias in inglese: name, description, values, default.

6. Patch

Guida: Patch. Una patch va in patches\<percorso del file del gioco>. Solo .xml, .ini e .vs. Ordine: dall'ultima mod dell'ordine di caricamento alla prima, così la prima ha l'ultima parola; mod\patches per ultimo.

XML

Il primo tag della patch è la radice (di solito si chiama <patch>); i suoi figli sono le operazioni, che si applicano in ordine. I nomi di operazioni, tag e attributi non distinguono maiuscole e minuscole.

• select è obbligatorio. Con <set> non puoi impostare un attributo che si chiami select, optional o unset.
• optional: 1, yes, si, sí o true evitano l'errore se il selettore non trova nulla.
• <add> e <replace> senza contenuto danno errore.
• Un selettore senza risultati, o un'operazione sconosciuta, viene saltato con un errore; le altre proseguono. Se la patch non è ben formata, non viene applicata nessuna operazione.
• Il file con la patch mantiene commenti e virgolette; gli attributi passano su una sola riga.

Selettore

Si possono concatenare condizioni ([@a='v'][2]). Non esiste altro (and, contains, text(), ..). Inizia sempre con / o //.

INI

Ogni riga della patch, sotto una [Seccion] (obbligatoria prima di qualsiasi riga):

Le chiavi e le sezioni non distinguono maiuscole e minuscole. Un commento a fine riga di una riga della patch non viene tolto.

Script .vs

Le direttive iniziano con @ nella prima colonna; il codice sotto ogni direttiva è ciò che viene inserito.

• TEXTO è un pezzo letterale di una riga (distingue maiuscole e minuscole). Si usa la prima riga che lo contiene, e le direttive si applicano in ordine: vedono ciò che hanno inserito le precedenti.
• Errore (e la direttiva viene saltata): direttiva sconosciuta, @before/@after/@replace senza TEXTO, direttiva senza codice (tranne @replace), TEXTO non trovato.

7. Eventi di script

Guida: Script. File: events\<Evento>.vs. Gira su tutti i PC; con più mod vengono eseguiti tutti.

• Tranne OnGameStart, vengono eseguiti subito e non possono aspettare.
• Un evento che scatta dentro se stesso viene interrotto al 4º livello.
• Se lo script fallisce durante l'esecuzione, il log lo annota fino a 5 volte per script.
• Si leggono solo questi nomi di evento. I nomi dei parametri li scegli tu.

8. Funzioni Mod_*

Guida: Script. L'API attuale è la 6; entra nel controllo del multigiocatore.

Costanti di script: l'id di ogni civiltà di mod con la prima maiuscola (valore = il suo index) e l'id di ogni specialità di mod (valore = il suo bit).

9. imperivm-mod.ini

Si trova nella cartella del gioco. Si legge all'avvio.

10. Limiti

Le guide spiegano come si fa ogni cosa; questo è l'elenco completo. Torna al README.