SSG10.txt

What's new in SSG10 (in comparison to version SSG9)?
- new editable source definition files "units.pre", "mapsize.pre"
- some helpfull awk scripts for "objects.pre", "scripts.pre"
- other visible/invisible changes

Sudden.Strike.Generator.10 by FH [2000.06.28-22:26:24]
for the 'Sudden Strike' demos by CDV Software Entertainment AG
NO warranties. NOT fully tested. Use at your OWN risk.
*********************************************

All mentioned trademarks and copyrights belong to their respective owners.
**************************************************************

Copyright (c) 2000, Fana Holesinsky

If you use SSG (or any part of this distrubution) for your mission/map files creating/modifications - it would be nice to mention this fact in your readme file...


Co-operation: Rumblefish - THANKS!
The authorized distribution site: the Sudden Strike Network [SSN] - http://www.suddenstrikenet.de


The Sudden.Strike.Generator.10:
- is free
- only non-profit distribution is allowed
- can be used with both the Sudden Strike "pre-alpha self runnig" & "playable" demos by CDV
- can export from the mission file or from the map file source definition files (only some are editable with the NotePad)
- can import modified source definition files and create new mission file "compiled.mis" or new map file "compiled.map"


What is NOT the Sudden.Strike.Generator.10:
- editor (it creates "compiled.mis/map", not modifies...)
- fool-proof


Warning:
Don't run the SSG10 in the "import" mode - if you don't know, how to check the mission/map file design/structure!


Working directory:
It is better to use any temporary directory for all SSG's jobs - don't use any directory in the "Sudden Strike demo" dir-structure....


Files:
The mission file "compiled.mis" or map file "compiled.map" from any demo ...

!!! It is necessary to copy the "compiled.mis" or "compiled.map" into "compiled.org" !!!

No other files are needed, because SSG will create during "EXPORT" mode all source definition files - some of them you can edit - and the same files are used during "IMPORT" mode to generate "compiled.mis" or "compiled.map"...
Only, if you are using the "ROF MAP export" mode, file "rof.ini" has to be present (can be empty = 0 filesize)...
For description of the "rof.ini" look at the SSTSxx.txt file...

Demo version (if "pre-alpha self running" or "playable") is autodetected:
- during export - from the "compiled.org" file,
- during import  - from the "version" file (created during export!).

MISSION or MAP mode is autodetected:
- during export from the "compiled.org" file,
- during import from the "header" file (created during export!).

Map size (if 128*128, 256*256 or other) is autodetected:
- during export from the "compiled.org" file,
- during import from the "mapsize.pre" file (created during export!).

--------------------------------------------------------
ALL FILES with a postfix (extension) "pre" are "EDITABLE TEXT FILES" !
--------------------------------------------------------
Mission "playable demo" mode - export:
In: 
"compiled.org"
......................
Out: 
"header"
"version"
"mapsize.pre"
"units.pre"
"groups.pre"
"mapunits.pre"
"players.pre"
"sounds.pre"
"locations.pre"
"scripts.pre"
"mines.pre"
"support.pre"
"phrases.pre"
"obj"
-------------------------------------------------------
Mission "playable demo" mode - import:
In:
"header"
"version"
"mapsize.pre"
"units.pre"
"groups.pre"
"mapunits.pre"
"players.pre"
"sounds.pre"
"locations.pre"
"scripts.pre"
"mines.pre"
"support.pre"
"phrases.pre"
"obj"
.......................
Out:
"compiled.mis"
--------------------------------------------------------------
Mission "pre-alpha self running demo" mode - export & import are basically similar to the "playable demo" modes,
but following 4 source definition files are missing (they are not included in the mission file):
"sounds.pre"
"support.pre"
"phrases.pre"
"obj"
=========================================
Map mode - export:
In:
"compiled.org"
.......................
Out:
"header"
"version"
"scheme"
"mapsize.pre"
"landnames"
"rhombs.pre"
"flags.pre"
"mini1.pre"
"mini2.pre"
"objects.pre"
---------------------------------------------------------------
Map mode - import:
In:
"header"
"version"
"scheme"
"mapsize.pre"
"landnames"
"rhombs.pre"
"flags.pre"
"mini1.pre"
"mini2.pre"
"objects.pre"
............................................
Out:
"compiled.map"
------------------------------------------------------------------
Combined ROF (rhombs, objects, flags) exporting/importing mode with filtering capabilities:
- check various log files for a list of all participating files !!!
------------------------------------------------------------------

Comand-line options: (log follows)
...............................................................................................
SSG> Wed Jun 28 23:35:42 2000
SSG> [ssg10 -?]

Sudden.Strike.Generator.10 by FH [2000.06.28-22:26:24]
for the 'Sudden Strike' demos by CDV Software Entertainment AG
NO warranties. NOT fully tested. Use at your OWN risk.

SSG> Command-line options (case sensitive): "ssg10 -oPtioNs"
-e ... export ('compiled.org' >>> sources)
-i ... import (sources >>> 'compiled.mis/map')
-L ... show 'locations'
-M ... show 'mapunits'
-N ... show 'sounds'
-P ... show 'players'
-re .. ROF export mode (map)
-ri .. ROF import mode (map)
-R ... show 'phrases'
-S ... show 'support'
-X ... show 'mines'
-z ... zero 'scripts' ('mis' import)
-? ... help
Note . default option is '-e'
.........................................................................................................
Option "-z" is usefull, if you want to disable some automatic actions - NO scripts are included in "compiled.mis'!
But don't forget: "support" units will not be called (in "playable" demo) - therefore, you have to deploy them in "mapunits"...


OS:
SSG is the command line utility - how to use command line or DOS prompt, you can find in your operating system manual ...

Favorite "Swiss" tool:
Windows Commander (ver.4.03) - hex viewer, can visually compare files contents, can invoke the NotePad, ...


Preinstall step:
If you are using the "SuSt playable demo" copy the "units" file (with all defined units) delivered with the SSG10 into its place in SuSt dir-structure (units subdir): [SuddenStrike_path\Game\data\desc\units] (it is the same file as for previous versions of generator).

!!! Zero level test !!!
If you have no experince with the delivered SSG version, always start with exporting and look what has been changed with the source definition files!


First test:
0. Warning: NO warranties! NOT fully tested! Use at your OWN risk!
1. Backup all your important files...
2. Create any temporary directory - for example "C:\SSG"...
3. Copy the Sudden.Strike.Generator.10 executable "SSG10.EXE" and the renamed mission file (you are interested in) "compiled.org" into this empty temporary directory...
4. First try the export - open the command prompt and enter on the command line: "ssg10 -e"
5. Look at the exported files - don't modify them...
6. And try the import - on the command line enter: "ssg10 -i"
7. The resulting "compiled.mis" have to be the same filesize and content, but it is not necessary.

Second test:
8. Try to slightly modify only one source definition file - ! only the files which are noted in the above as an "editable text file" can be modified with the NotePad !
9. And again try the import - on the command line enter: "ssg10 -i" (every new run of the SSG copies old mission file into "compiled.bak" and creates new file "compiled.mis"!)
10. Check the run of SSG10 (descriptive infos on screen) and the resulting "compiled.mis" - the filesize have to be only slightly changed (maybe not at all) ... check the internal structure of "compiled.mis" ...
11. If you think the "compiled.mis" is OK and you are sure the computer cannot be damaged and your data lost - copy "compiled.mis" from your temporary directory back into its original position in the "Sudden Strike demo" directory structure (overwrite the old mission file)...
12. Run "Sudden Strike demo" and don't forget - you are doing all these things at your own risk!


Crash/problems:
If SSG has crashed during export/import - do not use any created source definition files, the mission "compiled.mis" or the map "compiled.map" file!!!


Source definition files format description:
Maybe, the file "SSTSxx.txt" ("Sudden Strike Technical Specifications") can be helpfull for you ...


Liability:
I am trying to keep the SSG as bug-free as possible  ;-))
I cannot guarantee that SSG will run in every environment (developed/tested under Win2kRC2), on any computer, together with any other application, without producing errors.
Any liability for damage of any sort is hereby denied!


Have fun & enjoy - Fana Holesinsky, mailto:fholesinsky@hotmail.com


If you encounter any problems:
- you can use any of the special commad line options (to show more infos) to trace the export/import process ...
- you can log the process with standard redirection mechanism - for example, you can capture all messages into text file "error.log" if you enter on the cmd-line: "ssg10 -i > error.log"; this log file can be zipped and e-mailed to me...
- or you can send all your source definition files (ZIPped) to me - and I'll try to solve the problem or make "compiled.mis" for you...

Please!
No self-extracting EXE files - only ZIP files!
No M$ format (doc,xls) files - only plain text (txt) files, if you want to describe your problems!
THNX!