English
Spellcross - MOD builder/launcher

   Spellcross MOD builder vznikl za účelem usnadnění modifikací hry protože postupovat stylem dearchivece-editace-archivace každého jednotlivého archivu hry je poněkud nepoholdné. Tato utilitka je schopná, podle zadání v definičním souboru modu, "namixovat" nové herní datové archivy *.FS a *.FSU a případně je automaticky prohodit s původními archivy nainstalované hry i s těmi na CD (pokud je CD emulováno ze složky, namísto z ISO). Následně je zase vrátí zpět, aby bylo možné spustit původní hru nebo jiný mod.
   Protože předpokládám, že ne každému vyhovuje spouštět mody pomocí dávkových souborů *.bat, které je nejprve potřeba správně nastavit, vytvořil jsem navíc prográmek Spellcross mod launcher, který umožňuje provést potřebná nastavení přes grafické rozhraní namísto přímé editace "launcher.ini", "config.ini" a *.bat souborů. Dále automaticky vygeneruje spouštěcí *.bat soubory, pomocí kterých lze hru spustit přímo ve Windows nebo přes DOSbox a taky je umí sám spouštět.
   Prográmek byl, jako obvykle, vyvinut v BDS2006 Turbo C++ ve win XP, takže netuším, co to udělá na novějších, ale mělo by to chodit bez problému - nic XP specifického jsem nepoužil.


1 - Nastavení

   Oba prográmky mají samostatné konfigurační soubory *.ini. Vlastní utilitka Spellcross mod builder používá pouze soubor "config.ini", kde musí být správně zadány cesty k nainstalované hře a složce se skopírovaným obsahem CD, pokud je použito. Zbytek tohoto souboru je generován automaticky a obsahuje informace o tom, které archivy hry jsou právě modifikované a do této části nedoporučuji zasahovat, jinak nedojde k úspěšnému obnovení původních archivů hry. ;-)
   Prográmek Spellcross mod launcher používá jednak soubor "config.ini" a déle navíc vlastní "launcher.ini". V tom je možné zadat cestu k DOSboxu, pokud ho ke spouštění hry používáte a písmeno CD, které bude použito pro virtuální CD jednotku (pokud tedy nehodláte použít fyzické CD nebo ISO). Délze lze zadat některá nastavení DOSboxu. V tomto konfigu lze také zadat název procesu, který bude před spuštěním hry ukončen a po ukončení případně znovu spuštěn. Toto slouží čistě k mým účelům, protože jsem měl poněkud problém s utilitkou Nero Drive Speed, která z nějakého důvodu způsobuje, že Spellcross nedetekuje CD, byť se používá virtuální, nicméně lze takto ukončit libovolný proces, pokud by vám nějaký způsoboval problémy se hrou.
   Všechna potřebná nastavení lze provést i přes prográmek Spellcross mod launcher, takže není nezbytně nutné vrtat do *.ini souborů, pokud se na to necítíte.

Takhle to vypadá


2 - Spellcross MOD builder

   Jak jsem se už zmínil, slouží tato utilitka k namixování nových herních archivů a jejich prohazování s originály ze Spellcrossu. Použití této konzolové utilitky je zhruba následující:

spell_mod_builder.exe ?
spell_mod_builder.exe -?
spell_mod_builder.exe /?

   Vypíše použití.

spell_mod_builder.exe

   Bez parametrů utilitka pouze obnoví původní herní archivy ze složky "backup" ve složce programu. Do té se před přesunem archivů modu do složky hry ukládá záloha původních. Stejnou operaci také provede dávkový soubor "restore.bat". Pokud se obnovení opakovaně nepovede (bude zobrazeno varování), bude potřeba provést ruční obnovení všech herních archivů z vlastní zálohy a navíc bude třeba provést operaci "cleanup", viz dále.

spell_mod_builder.exe -cleanup

   Provede operaci "cleanup", tj. vymaže záznam o modifikacích herních archivů z "config.ini", což je nutné pouze v případě, že se opakovaně nedaří obnovení původních souborů. Po této operaci je třeba z vlastní zálohy obnovit všechny herní archivy hry (i ty na CD, pokud se jich mod také týkal). Identickou operaci provede dávkový soubor "cleanup.bat".

spell_mod_builder.exe cesta_k_modu [-mod]

   Parametr "cesta_k_modu" je název definičního souboru modu *.def, podle kterého budou "našlehány" nové herní archivy. Výstupní soubory budou uloženy do složky definované v *.def souboru. Identickou operaci provede skript "build.bat" popsaný dále. Formát definičního souboru modu je popsán v příloženém ukázkovém modu.
   Nepovinný parametr "-mod" navíc prohodí původní herní archivy s těmi nově vytvořenými, přičemž originály jsou uloženy do složky "backup" ve složce programu. Tuto variantu provede skript "mod.bat", viz dále.

2.1 - build.bat

   Vytvoří modifikované archivy *.FS a *.FSU. Použití:

build.bat cesta_k_modu

2.2 - mod.bat

   Vytvoření modifikované archivy a přesune je do složky hry, případně CD. Originály přesune do složky "backup". Použití:

mod.bat cesta_k_modu

2.3 - restore.bat

   Obnoví původní archivy hry, viz výše.

2.4 - cleanup.bat

   Provede operaci "cleanup", tj. vyčistí "config.ini" v případě předchozích problémů s "restore.bat", viz výše.

2.5 - exec.bat

   Tento skriptík vytvoří nové herní archivy, prohodí je s původními a spustí hru buďto přímo ve Windows nebo přes DOSbox. Následně zase obnoví původní herní archivy. Spustění ve Windows je provedeno voláním skriptu "run_XP.bat" ve složce SPELCROSu, spuštění přes DOSbox pak voláním skriptu "run_DOSbox.bat" v téže složce. Ty budou popsány dále. Použití skitpu:

exec.bat spelcros_slozka cesta_k_modu XP
exec.bat spelcros_slozka cesta_k_modu DOSbox



3 - Spellcross MOD launcher

   Je to pouze grafické rozhraní usnadňující použití Spellcross mod builderu podle výše uvedených bodů. Lze přes něj provést nezbytné konfigurace *.ini souborů a umožňuje spouštět původní a modifikovanou hru buďto přímo ve Windows nebo přes DOSbox. K tomu úšelu automaticky do složky hry generuje spouštěcí soubory *.bat, které budou popsány níže. Dále přes něj lze otevřít některé konfigurační soubory hry a DOSboxu.
   Při prvním spuštění je předně třeba vyplnit cestu k instalaci hry, ke složce s obsahem CD, pokud je použito a v případě spouštění přes DOSbox také k vaší instalaci DOSboxu. Dále je třeba zvolit písmeno jednotky, pod kterou bude emulováno CD (společné pro Windows i DOSbox). Pokud z nějakého důvodu chcete používat fyzické CD nebo ISO, pak je třeba zakázat "Allow CD mod", protože na CD změny pochopitelně provést nelze. Pokud použitý mod obsahuje i modifikace CD, tak budou v tomto případě vynechány (zpravidla hra chodí i bez toho).
   Pokud bylo vše nastaveno správně, mělo by jít spustit přinejmenším originální hru. V DOSboxu to musí fungovat v každém případě, ve Windows to bude hodně záviset na verzi a konfiguraci HW. Konkrétní způsob, jakým je hra spouštěna, je popsán dále.


4 - Instalace a použití

   Celá instalace by se dala shrnout asi takto:

  1. Nainstalovat Spellcross, např. do složky C:\HRY\SPELCROS.
  2. Nainstalovat patch V1.06 nebo V1.07 (pro ENG verzi je poslední tuším V1.04).
  3. Skopírovat celý obsah CD do nějaké složky, třeba C:\HRY\SPELLCD.
  4. Udělat si zálohu všech datových archivů hry i CD, tj. zálohy složek DATA v adresáři hry i CD.
  5. Stáhnout a někam vybalit složku programu Spellcross mod builder/launcher (ideálně na stejnou jednotku, jako je nainstalována hra).
  6. Nastavit potřebné parametry v souborech "config.ini" a "launcher.ini" buďto ručně nebo přes program Spellcross mod launcher.

   Bod 4) bych doporučil nepodceňovat, protože v případě nekorektního ukončení programu nebo hry by se eventuelně nemuselo povést automaticky obnovit původní archivy hry. V tom případě by měl prográmek vypsat chybu a bude potřeba provést ruční obnovu ze zmíněných záloh. Sice se mi to ještě nestalo, ale pokud ano, tak docela naštve, když nemáte po ruce originální data. ;-)
   K bodu 5) jen drobné vysvětlení. Důvod, proč by měl být můj program na stejném disku, jako hra je prostý - přesuny souborů v rámci jedné partition jsou neúměrně rychlejší a zbytečně nefragmentují disk.

4.1 - Spouštění pod Windows

   Postupů, jak hru rozchodit přímo ve Windows je celá řada, nicméně vzhledem k tomu, že je občas potřeba upravovat také obsah CD, není možné používat fyzické CD nebo virtuální mechaniku. Přinejmenším s patchem V1.06 si ale naštěstí Spellcross nechá líbit místo CD nebo virtuální CD mechaniky obyčejnou virtuální jednotku vytvořenou pomocí příkazu SUBST. Tento příkaz (ve skutečnosti utilitka z windows\system32) nedělá nic jiného, než že namapuje zadanou složku jako novou, virtuální jednotku. Dělá tedy zhruba totéž, co příkaz "mount" v DOSboxu a obdobně se i používá.
   Protože psát pokaždé do příkazového řádku něco ve smyslu "subst T: C:\HRY\SPELLCD" je poněkud otravné, vygeneruje Spellcross mod launcher automaticky dávkový soubor "run_XP.bat", který už všechny potřebné příkazy nutné ke spuštění hry obsahuje. Měl by se vytvořit při prvním spuštění hry přes tento prográmek přímo ve složce hry. Lze na něj pak i vytvořit zástupce a spouštět ho místo SPELCROS.EXE.
   Uvedený postup vytvoření virtuálního CD mi fungoval na všech PC s Windows XP, ale zaručit to samozřejmě nelze. Občas je potřeba dost laborovat s písmenem jednotky (do SPELCROS.CD není třeba psát nic, prográmek Spellcross mod launcher tam zapíše vybrané písmeno sám).

4.2 - Spouštění přes DOSbox

   Pokud hra nejde spustit přímo, musí to jít přinejmenším přes DOSbox. Pokud už čirou náhodou máte v "dosbox.conf" souboru vyplněnou sekci [autoexec] tak, aby se hra spustila sama, tak ho budete muset vypnout zaškrtnutím "Disable autoexec". Spuštění se sice provede pomocí stejných příkazů, jak je na fórech doporučováno, ale zadaných jinou cestou. Opět jsem to pro své pohodlí vyřešil přes dávkový soubor "run_DOSbox.bat", který jednoduše spustí DOSbox spolu se souborem "box_exec.bat" jako parametr, který DOSbox automaticky vykoná. Oba soubory jsou opět automaticky vygenerovány programem Spellcross mod launcher a opět je lze použít i mimo něj, tj. vytvořit zástupce na "run_DOSbox.bat" místo SPELCROS.EXE.
   CD je i v tomto případě "namontováno" ze složky s kopií CD, nikoliv z ISO. V případě DOSboxu s tím, na rozdíl od Windows, nemůže být problém.
   Mimo "run_DOSbox.bat" je také vytvořen soubor "setup_DOSbox.bat", který spustí nastavení Spellcrossu voláním dalšího skriptu "box_set.bat". Je to totéž, jako originální SETUP.BAT, ale přes DOSbox.


5 - Historie verzí

V1.00 - 1.10.2011: První verze.
V1.10 - 10.10.2011: Pár dalších nastavení v *.ini suborech. Spellcross mod builder i launcher přepracován tak, aby vše korektně pracovalo i ve Windows 98 (upraveny i *.bat skripty).
V1.20 - 15.10.2011: Opraveno pár chybek v *.bat skriptech.
V1.30 - 2.6.2013: Opraveno pár chybek v *.bat skriptech (nějak to nebralo mezery v cestě k modu).


6 - Licence

   Je to freeware, takže může být libovolně používán a šířen, ale pouze se všemi přiloženými soubory (zejména tento help) a bez úprav!
   Autor nenese žádnou zodpovědnost za případné problémy nebo škody vzniklé použitím tohoto SW, ať už by byly jakékoliv.
   Pokud s uvedenými podmínkami nesouhlasíte, pak tento SW nepoužívejte.


7 - Kontakt

   V případě problémů s programem mě můžete kontaktovat na e-mailu s.maslan@seznam.cz. Nějaké ty informace k programu a případné další verze lze nalézt na mém webu: http://www.spellcross.kvalitne.cz/mod/spell_mod_builder.html.



(c) 2011-2013, Stanislav Mašláň - Všechna práva vyhrazena.