Spring - User contributions [en]

Lua CMDs

2008-05-27T01:57:53Z

FeminismIsCommunism: grammar "didn't already noticed"

== Options ==
'''CMD.OPT_ALT''' 
'''CMD.OPT_CTRL''' 
'''CMD.OPT_SHIFT''' 
'''CMD.OPT_RIGHT''' 
'''CMD.OPT_INTERNAL'''

== Waitcodes ==
'''CMD.WAITCODE_TIME''' 
'''CMD.WAITCODE_DEATH''' 
'''CMD.WAITCODE_SQUAD''' 
'''CMD.WAITCODE_GATHER'''

== Insert/Remove Commands ==
First, said "tags" are unique command identifiers, so each command that gets inserted into a unit's command
queue gets its unique "tag" number. (It is used to ''sync'' command queue operations, also it makes things much easier.) 
To receive those "tags" you can do the following:
local cmdQueue = Spring.GetUnitCommands(unitID);
if (#cmdQueue>0) then
local cmdTag = cmdQueue[1].tag
..
end

'''CMD.INSERT'''
options.ALT -> treat param0 as a position instead of a tag
options.CONTROL -> use the build queue for factories
params[0] = command tag or position (negative numbers to reference the back of the queue)
params[1] = insertCmd id
params[2] = insertCmd options (shift,alt,right click,etc.)
params[3 ... N+2] = insertCmd params[0 ... N-1]

example:
Spring.GiveOrderToUnit(unitID,
CMD.INSERT,
{-1,CMD.ATTACK,''CMD.OPT_SHIFT'',''unitID2''},
{"alt"}
);

Note: If you didn't already notice, the command params and
the command options are twisted in the array (compared to GiverOrder)!

Note2: The command options in the array/table is a number value!
You have to use CMD.OPT_* in this case.

'''CMD.REMOVE'''
options.ALT -> use the parameters as commandIDs
options.CONTROL -> use the build queue for factories
params[0 ... N-1] = tags or commandIDs to remove

== Commands ==
Note, the CMD[] table is bidirectional. That means: CMD[CMD.STOP] := "CMD_STOP"

'''CMD.STOP'''
type CMDTYPE.ICON
'''CMD.WAIT'''
type CMDTYPE.ICON
'''CMD.TIMEWAIT'''
type CMDTYPE.NUMBER
'''CMD.DEATHWAIT'''
type CMDTYPE.ICON_UNIT_OR_RECTANGLE
'''CMD.SQUADWAIT'''
type CMDTYPE.NUMBER
'''CMD.GATHERWAIT'''
type CMDTYPE.ICON
'''CMD.MOVE'''
type CMDTYPE.ICON_MAP
'''CMD.PATROL'''
type CMDTYPE.ICON_MAP
'''CMD.FIGHT'''
type CMDTYPE.ICON_MAP
'''CMD.ATTACK'''
type CMDTYPE.ICON_UNIT_OR_MAP
'''CMD.AREA_ATTACK'''
type CMDTYPE.ICON_AREA
'''CMD.GUARD'''
type CMDTYPE.ICON_UNIT
'''CMD.AISELECT'''
type CMDTYPE.COMBO_BOX
'''CMD.GROUPSELECT'''
type CMDTYPE.ICON
'''CMD.GROUPADD'''
type CMDTYPE.ICON
'''CMD.GROUPCLEAR'''
type CMDTYPE.ICON
'''CMD.REPAIR'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.FIRE_STATE'''
type CMDTYPE.ICON_MODE
'''CMD.MOVE_STATE'''
type CMDTYPE.ICON_MODE
'''CMD.SELFD'''
type CMDTYPE.ICON
'''CMD.LOAD_UNITS'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.LOAD_ONTO'''
type CMDTYPE.ICON_UNIT
'''CMD.UNLOAD_UNITS'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.UNLOAD_UNIT'''
type CMDTYPE.ICON_MAP
'''CMD.ONOFF'''
type CMDTYPE.ICON_MODE
'''CMD.RECLAIM'''
type CMDTYPE.ICON_UNIT_FEATURE_OR_AREA
'''CMD.CLOAK'''
type CMDTYPE.ICON_MODE
'''CMD.STOCKPILE'''
type CMDTYPE.ICON
'''CMD.DGUN'''
type CMDTYPE.ICON_MAP
'''CMD.RESTORE'''
type CMDTYPE.ICON_AREA
'''CMD.REPEAT'''
type CMDTYPE.ICON_MODE
'''CMD.TRAJECTORY'''
type CMDTYPE.ICON_MODE
'''CMD.RESURRECT'''
type CMDTYPE.ICON_UNIT_FEATURE_OR_AREA
'''CMD.CAPTURE'''
type CMDTYPE.ICON_UNIT_OR_AREA
'''CMD.AUTOREPAIRLEVEL'''
type CMDTYPE.ICON_MODE
'''CMD.LOOPBACKATTACK'''
type CMDTYPE.ICON_MODE
'''CMD.IDLEMODE'''
type CMDTYPE.ICON_MODE
'''CMD.SET_WANTED_MAX_SPEED'''
type CMDTYPE.NUMBER
'''CMD.SETBASE'''

'''CMD.INTERNAL'''
used in different ways

== CommandTypes ==
Note, the CMDTYPE[] table is bidirectional. That means: CMDTYPE[CMDTYPE.ICON] := "CMDTYPE_ICON"

'''CMDTYPE.ICON'''
expect 0 parameters in return
'''CMDTYPE.ICON_MODE'''
expect 1 parameter in return (number selected mode)
'''CMDTYPE.ICON_MAP'''
expect 3 parameters in return (mappos)
'''CMDTYPE.ICON_AREA'''
expect 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_UNIT'''
expect 1 parameters in return (unitid)
'''CMDTYPE.ICON_UNIT_OR_MAP'''
expect 1 parameters in return (unitid) or 3 parameters in return (mappos)
'''CMDTYPE.ICON_FRONT'''
expect 3 or 6 parameters in return (middle and right side of front if a front was defined)
'''CMDTYPE.COMBO_BOX'''
expect 1 parameter in return (number selected option)
'''CMDTYPE.ICON_UNIT_OR_AREA'''
expect 1 parameter in return (unitid) or 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_UNIT_FEATURE_OR_AREA'''
expect 1 parameter in return (unitid or featureid+MAX_UNITS (id>MAX_UNITS=feature))
or 4 parameters in return (mappos+radius)
'''CMDTYPE.ICON_BUILDING'''
expect 3 parameters in return (mappos)
'''CMDTYPE.ICON_UNIT_OR_RECTANGLE'''
expect 1 parameter in return (unitid)
or 3 parameters in return (mappos)
or 6 parameters in return (startpos+endpos)
'''CMDTYPE.NUMBER'''
expect 1 parameter in return (number)

'''CMDTYPE.CUSTOM'''
used with CMD_INTERNAL
'''CMDTYPE.NEXT''' next command page
used with CMD_INTERNAL
'''CMDTYPE.PREV''' previous command page
used with CMD_INTERNAL

Maps:Compiling

2008-05-11T00:29:19Z

FeminismIsCommunism: changed -x to -n for minimum height option

== Compiling Spring Maps ==

This is often the bit that scares alot of people off, but it is really not that dificult. There are two different ways to compile a map, so you can choose which option suits you best. You can:

*Compile through a DOS prompt, or
*Create and batch file.

=== Before you start ===

First off, download a map converter. These can be found on [http://www.FileUniverse.com FileUniverse.com]. There are two compiliers that most people use:
* [http://www.fileuniverse.com/?p=showitem&ID=1421 mother's MapConv with 'optimisation'] This version does not work for some people. If you are one of these people, try:
* [http://www.fileuniverse.com/?p=showitem&ID=1507 mother's mapconc, without optimisation] Use this if the other one does not work.

Place the compiler in to a directory on your computer somewhere. Because of a bug in the program, the path to the map converter can NOT contain ANY Spaces. A Path of '''C:\Maps\MapConv\''' is good, but a path of '''C:\Maps\Map Conv\''' is BAD.

A good practise is to save all your source Pictures into seperate folders when making a map. However, this gets very tedious when compiling. So it is a good idea to make a copy of your source BMP files and place these in the same folder as the map converter. This just makes things alot easier later on. You should have the following files in your MapConv folder:

* Texture.bmp
* Height.bmp
* Metal.bmp
* Feature.bmp

You should also put, if you are using them, your type map (Type.bmp) and your tile
map (Tile.bmp). Most maps do not use these, so you do not usually need to worry about them.

You need the 7-zip compression program to compress your map into a .sd7 map file.
* [http://www.7-zip.org 7-zip homepage]
* [http://prdownloads.sourceforge.net/sevenzip/7z431.exe?download Download Link]

A .smd file. These can be made with [http://taspring.clan-sy.com/phpbb/viewtopic.php?t=2420 Maelstroms SMD creator].
It is recommended to actually try to learn how the different SMD values works though by looking at other maps .smd files. The SMD creator is also not completly bugfree, so you should preferably look it through once with a text editor anyway.

You also need to know:

*The minimum and maximum heights of your map.
*The name of your map.
*How much you want to compress your map.

=== Command Line Options ===

As the compiler runs off information entered into it as '''Command Line Parameters''' , you need to know a bit about them first. Command Line Parameters are really not difficult to understand. They look a bit like this:

ProgramName -Setting1 Value -Setting2 Value

The first bit is how we launch the program. Windows will launch whatever program is specified by '''ProgramName'''. '''-Setting1 Value''' is also very simple. Windows basically says to the program "Setting1 is Value". A better example would be -height 10, which basicly means "Height is 10". These can be combined with as many settings as you want, as we can see with the '''Setting2 Value''' bit. In this way we can pass as much information to the compiler as we want. To compile a map, we need the following Command Line Parameters:

'''Map Compression'''
This takes the form of '''-c Compression''', where Compression is a value. Typing '''-c 0.5''' will give a compression of 0.5

'''Max Height'''
This specifies the maximum height of the map. This option looks like '''-x Height''', where Height is the maximum height of the map. Typing '''-x 300''' will give your map a maximum height of 300 map units.

'''Minimum Height'''
This specifies the minimum height of the map. This option looks like '''-n Height''', where Height is the minimum height of the map. Typing '''-n -50''' will give your map a minimum height of -50 map units.

'''Texture'''
This specifies the location of your texture picture. This option looks like '''-t Location''', where Location is the location of your texture image. Typing '''-t texture.bmp''' will make the compiler look in the same directory it is in for '''texture.bmp'''. Typing '''-t C:\Maps\HillMap\texture.bmp''' will make the compiler look in the '''C:\Maps\HillMap\''' for texture.bmp. This name cannot contain spaces.

'''Other Picture files'''
These work in basically the same way as the texture option works, with just a changed Setting name.
*'''-m metal.bmp''': Specifies the location of the metal map.
*'''-a height.bmp''': Specifies the location of the height map.
*'''-f feature.bmp''': Specifies the location of the feature map.
*'''-y typemap.bmp''': Specifies the location of the terain type map.
Please note that these names cannot contaion spaces.

'''Map Name'''
The Map Converter needs to know where to save your map, and what to call it. We use the '''-o Mapname.smf''' setting to do this. Of course, you replace Mapname with the name of your map, but you NEED to have the '.smf' bit on the end of it, otherwise the compiling wont work. An example would be '''-o HillMap.smf'''. This name cannot contain spaces.

'''Other Tags'''
Some of these tags are helpfull, some are annoying and some are just a mystery. This is basicly the mics tags settings.
*'''Low Pass''': If you map has very steep slopes or rough areas that look ugly, this will smooth them a bit. Is activated just by typing '''-l'''.
*'''Invert Height map''': As the logical way to make a height map is the same way up as all the other maps, but the way the map is actually used is the inverted version of this. To make things easier, they included this option to invert the height map. Is activated just by typing '-i'. Most maps will use this.

=== Compiling through a batch file ===

This is perhaps the easiest option. You just have to create a simple text file, rename it, and run.

First, open up Notepad. Notepad can be found in Start > Program Files > Accessories > Notepad. In notepad, type or copy the following:

'''mapconv -c 0.5 -x 500 -n 50 -o MapName.smf -t texture.bmp -m metal.bmp -a height.bmp -f feature.bmp -i '''

Replace the relevant values with the values you need, as the settings here will not work for all the maps. Then, in Notepad click File > Save As. In the file name box, type '''"Compile.bat"''', with the quotes. If you do not have the quotes, it will not work. Save the file in the same directory as your compiler.

Go to the MapConv folder on your hard drive, and you should see a new file. This file will be called Compile.bat. Double click this file, and a black Dos window should pop up. After a few minutes the window should close. There will now be 2 extra files in that directory. '''MapName.smt''' and '''MapName.smf'''.

=== Compiling through DOS ===

Use this option if you want to read the information that the MapConv outputs. If you are not familiar with how DOS works, then this way is not for you.

All you need to do is navigate your way through DOS to the location of your map converter program. Then, type in the following:

'''mapconv -c 0.5 -x 500 -n 50 -o MapName.smf -t texture.bmp -m metal.bmp -a height.bmp -f feature.bmp -i '''

Replace the relevant values with the values you need, as the settings here will not work for all the maps.

Once compiled, there will be 2 extra files in that directory. '''MapName.smt''' and '''MapName.smf'''.

=== Compressing your map ===

Your SMD file needs to have the same name as the .smt and .smf files. If your smt file is calles '''HillMap.smt''', your .smd file needs to be called '''HillMap.smd'''.

Place the '''MapName.smd''', '''MapName.smt''' and '''MapName.smf''' files into an empty folder called maps\. Eg: '''C:\maps\'''. Right click this folder, and a right click menu should appear. In that menu, there will be a 7-Zip'''>''' submenu. Open this menu, and click '''Add to Archive...'''. A 7-zip window will appear. Make sure the settings are identical to the following picture:
[[Image:7-zip_options.jpg]]

Change the '''Archive''' box at the top to the name of your map, with .sd7 on the end. Eg: '''HillMap.sd7'''. Click the '''OK''' button. After the compression has completed, there will be a file called '''HillMap.sd7''' in the same directory as the folder was. In this example, the '''HillMap.sd7''' would be straight on the C:\ drive. Copy '''HillMap.sd7''' to your TASpring\Maps\ directory.

NOiZE: The compresion can be set at ultra. but make sure you don't make it a solid archive!

If all of this was done correctly, the map should now appear your maps list in the lobby, and you can go play it.

[[Category:Map making]]