Riferimento dell'SDK

Un elenco di consultazione di tutto ciò che una mod può dichiarare. Per imparare come farlo, vedi le guide collegate in ogni tabella.

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

1. Struttura della mod

Una mod è una cartella in mods\. Le cartelle che iniziano con . o _ vengono ignorate. Senza un mod.json, il gioco ne crea uno di 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 viene caricata.
• Un'estensione sconosciuta e non vietata è ammessa e non viene mai eseguita.
• Se due mod forniscono lo stesso file, un file sciolto batte uno dentro un .pak; tra due file sciolti, o due dentro file .pak, vince quello che viene prima nell'ordine di caricamento. L'ordine lo calcola il gioco, nessuno lo sceglie: prima ciò che chiedono le mod (una mod va sopra quelle che servono in requires e quelle in loadAfter, e sotto quelle in loadBefore); poi le mod estetiche vanno sopra i contenuti (mappe, battaglie, conquiste), e i contenuti sopra le mod che cambiano il gameplay; a parità, per id. Le stesse mod danno lo stesso ordine su ogni computer. Nella scheda di ogni mod, il gestore dei contenuti elenca i file che condivide con altre mod attive e quale copia di ciascuno viene usata. Se due mod attive sostituiscono gli stessi file di gameplay e nessuna nomina l'altra in requires, loadAfter o loadBefore, viene mostrato come problema: usane una sola, oppure una patch di compatibilità (una mod che fornisce i file uniti e ha entrambe in loadAfter). Quando tutti i file che condividono sono estetici (texture, suoni, interfaccia), il giocatore può scegliere i file di quale mod usare; 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 potrebbe modificare anche un'altra mod, è meglio una patch (sezione 6): le patch si sommano invece di sostituire il file.

Cartella di prova <game>\mod\ (non serve nessuna mod; batte tutte le mod):

2. mod.json

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

Alias inglesi che il gioco legge anche: name, description, license, redistributable, language (con code, name).

3. civs\<id>.json

Guida: Civiltà.

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

4. specials\*.json

Guida: Specialità delle unità.

• id o bit ripetuti: vince 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 inglesi: name, description, icon.

5. options\<id>.json

Guida: Opzioni di partita.

• Un values con meno di 2 o più di 16 voci fa ignorare l'intera opzione.
• Bit: interruttore 1; elenco di 2 valori 1; di 3-4, 2; di 5-8, 3; di 9-16, 4. Vengono assegnati in ordine alfabetico di id.
• Con un id ripetuto, vince quello della mod che viene prima.
• Alias inglesi: name, description, values, default.

6. Patch

Guida: Patch. Una patch va in patches\<path of the game file>. Solo .xml, .ini e .vs. Ordine: dall'ultima mod nell'ordine di caricamento alla prima, quindi la prima ha l'ultima parola; mod\patches per ultima.

XML

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

• select è obbligatorio. Non puoi usare <set> per impostare un attributo chiamato 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 un 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 applicata conserva commenti e virgolette; gli attributi vengono riportati su una sola riga.

Selettore

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

INI

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

Chiavi e sezioni non distinguono maiuscole e minuscole. Un commento alla fine di una riga della patch non viene eliminato.

Script .vs

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

• TEXTO è un frammento 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 degli script

Guida: Script. File: events\<Event>.vs. Viene eseguito su ogni PC; con più mod, vengono eseguite tutte.

• Tranne OnGameStart, vengono eseguiti subito e non possono attendere.
• Un evento che si attiva dentro se stesso viene interrotto al quarto livello.
• Se lo script fallisce durante l'esecuzione, il log lo registra fino a 5 volte per script.
• Vengono letti solo questi nomi di evento. I nomi dei parametri li scegli tu.

8. Funzioni Mod_*

Guida: Script. L'API attuale è la 6; fa parte del controllo del multigiocatore.

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

9. imperivm-mod.ini

Si trova nella cartella del gioco. Viene letto all'avvio.

10. Limiti

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