SDK di Imperivm Resurrected

Imperivm Resurrected è una mod per Imperivm HD (Great Battles of Rome) che apre il gioco a mod prima impossibili: nuove civiltà, abilità, oggetti, modalità di vittoria, lingue, script che reagiscono a ciò che succede in partita e altro. Qui trovi le guide e gli strumenti per crearle. Ogni guida ha una mod di esempio in examples/.

Da dove iniziare

1. Installa Imperivm Resurrected: copia il suo contenuto nella cartella del gioco (...\steamapps\common\Imperivm - Great Battles of Rome HD) e avvia il gioco da Steam.
2. Copia una cartella di templates/ in mods\, dentro la cartella del gioco: ha la struttura esatta che il gioco si aspetta per quello che vuoi creare (vedi Modelli). Per vedere una mod finita, copiane una da examples/, per esempio patches-example.
3. Nel menu principale clicca Contenuti aggiuntivi e attiva la mod nel tuo profilo.
4. Riavvia il gioco se non si è riavviato da solo.
5. Apri Logs\imperivm\imperivm-mod.log, nella cartella del gioco. Elenca gli errori della tua mod e ciò che ha caricato.

Prima di avviare il gioco, passa la mod nel validatore.

Com'è fatta una mod

Una cartella dentro mods\ con un mod.json e i file che modifica o aggiunge, con gli stessi percorsi del gioco:

mods\
  my-mod\
    mod.json
    data\classes\MyUnit.sc.xml       <- new file, or one that replaces the game's
    loc\english.loc.xml              <- texts added to the game's

Modelli

Un modello è una mod vuota con le cartelle che il gioco legge, un mod.json valido e un README con i passaggi. Copia quello che corrisponde a ciò che crei, rinominalo, compila mod.json e metti i tuoi file dove indicano le note. Ogni cartella vuota contiene una nota PUT-YOUR-FILES-HERE.txt: eliminala quando aggiungi i tuoi file.

Non includere eseguibili né script di sistema (.exe .dll .asi .bat .cmd .com .scr .ps1 .vbs .js .msi .sys .cpl .lnk .reg .jar .hta .wsf .pif). Se ce n'è uno, la mod non viene caricata. Conta anche un .js dimenticato, per esempio un generatore tuo.

mod.json

{
  "id": "my-mod",
  "name": "My mod",
  "version": "1.0",
  "authors": ["Me"],
  "description": "What my mod does.",
  "category": "Gameplay & Balance",
  "redistributable": true
}

Fino alla 0.31.50 i nomi di questi campi erano in spagnolo (nombre, autores, descripcion, etiquetas, categoria, redistribuible, licencia, requiere, incompatibleCon, cargarDespuesDe, cargarAntesDe, fuentes, idioma, ordenes…). Quelli vecchi vengono ancora letti, ma scrivi quelli nuovi.

Guide

• Lingue e testi: modifica i testi del gioco o aggiungi una lingua senza sostituire l'intero file.
• Tasti delle mod: come compaiono gli ordini della tua mod in Controlli e come darne il nome.
• Patch: modifica una parte di un XML, INI o script del gioco senza sostituirlo; due mod possono toccare lo stesso file.
• Script: script .vs, eventi e funzioni Mod_....
• Civiltà: dichiara una nuova civiltà o clona una del gioco, con la sua IA, e giocala nella stanza.
• Modelli di città e villaggio: la città e il villaggio iniziali propri di una civiltà della mod (create-template.js).
• Nuove unità: classe, ordine di reclutamento, immagini e testi, riuso del modello di un'altra unità.
• Statistiche delle unità: quale attributo fa cosa, quali non fanno nulla e quali bloccano il gioco.
• Specialità delle unità: nuove specialità delle unità e il loro effetto tramite script.
• Abilità delle truppe: nuove abilità per unità o eroi (un ordine con pulsante e tasto, più un metodo di script).
• Nuovi oggetti: amuleti, erbe e gemme degli eroi.
• Nuove formazioni: formazioni degli eroi con i loro bonus e il pulsante.
• Avamposti ed edifici: nuovi avamposti neutrali nelle mappe casuali (create-outpost.js) e classi di torri, mura e porte.
• Modalità di vittoria: uno script in data\GameScripts aggiunge una modalità al menu a tendina "Mode" della stanza.
• Bonus iniziali: gli script in data\BonusScripts aggiungono scelte alla colonna "Bonus" della stanza.
• Opzioni di partita personalizzate: nuovi interruttori nelle regole della stanza, che gli script leggono con Mod_GetOption.
• Scenari, avventure e conquiste: i tre tipi di mappa, i file che servono a ciascuno e i filmati.
• Musica, suoni e voci: sostituisci o aggiungi audio.
• Tipi di mappa casuale: un disegno a quattro colori diventa un nuovo tipo di mappa (create-random-map.js).
• Immagini personalizzate: pulsanti degli ordini e icone delle unità a partire da un PNG.
• Grafica personalizzata: sprite personalizzati per unità ed edifici (convert-sprite.js, create-entity.js, read-rle.js).
• Validare una mod: controlla una mod senza aprire il gioco, con file e riga di ogni problema.
• Pubblicare su GameBanana: categorie, tag, caricamento e mod create prima dell'SDK.
• Riferimento: l'elenco completo di ciò che una mod può dichiarare (file, campi, patch, eventi, funzioni e limiti).

Strumenti

Si trovano in tools\ e richiedono Node.js. Apri un terminale in questa cartella ed eseguili da qui (node tools\validate-mod.js ...). Ognuno spiega come si usa se lo lanci senza argomenti, e la guida dell'argomento ha degli esempi.

Dati del gioco

Vari strumenti chiedono la cartella DATA del gioco. extract-data.js la estrae (serve Node.js):

node tools/extract-data.js "<game folder>" <output folder>

Lascia data.pak in <output folder>\DATA. È la cartella che chiedono clone-civilization.js, create-outpost.js e validate-mod.js --data.

Cosa conta come gameplay?

In multigiocatore tutti devono usare le stesse mod se queste cambiano ciò che succede in partita. Il gioco lo deduce dalle cartelle che la tua mod tocca: data/, scenarios/, adventures/, conquests/, civs/, specials/, events/, options/, rules/, modes/, randommap/, randommapsettlements/, i file .xml e .pass in units/, buildings/ e mapobjects/, i file .xml in visuals/, le mappe .bfhp in packs/ e le patch (a seconda del file che modificano).

Grafica, suoni, testi (loc/) e lingue non contano: ogni giocatore può usare i propri.

Se qualcosa non funziona

Gli errori della tua mod compaiono sulla sua scheda nel gestore dei contenuti e in Logs\imperivm\imperivm-mod.log. Ogni riga del log ha l'ora, un livello (I informazione, W avviso, E errore) e un tag che indica la parte della mod da cui proviene: patch, language, civilizations, specials, script, event. Guarda prima le righe W ed E dei tag della tua mod.

Il log conserva le ultime cinque sessioni (da imperivm-mod.1.log a imperivm-mod.4.log) e, se il gioco si è chiuso in modo anomalo, imperivm-mod.crashed.log. Per avere più dettagli su una parte, metti il suo tag e un livello sotto [Debug] in imperivm-mod.ini, per esempio LogChannels=patch:debug; LogLevel=debug lo fa per tutto.

Per chiedere aiuto, clicca il cuore in basso a sinistra nel menu principale e poi Crea report. Genera uno zip con i log e i dati del tuo sistema, senza il nome utente di Windows, gli ID di Steam né gli indirizzi IP, e non invia nulla: decidi tu se condividerlo.

Versione e licenza

La versione dell'SDK e le modifiche di ciascuna sono in Modifiche. La licenza è in Licenza.