Spring - User contributions [en]

Lobby Development

2011-05-12T05:30:20Z

Aegis: /* TASServer */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Lobby client development=
There are currently three working public lobby clients available, and two in development.

==SpringLobby==
cross-platform,
C++,
by BrainDamage &
koshi

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

==Zero-K==
Windows,
C#,
by Licho & quantum

[https://code.google.com/p/zero-k/ Zero-K project page]

==Alphalobby==
Windows,
C,
by Axiomatic

Alphalobby is still very much work in progress. If you still wish to use it, source available from the [http://code.google.com/p/alphalobby/source/checkout mercurial repository], binary available on the [http://springfiles.com/spring/lobby-clients/alphalobby springfiles page].

==TASClient==
Windows,
Delphi,
by Satirik

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

==QtLobby==
cross-platform,
C++,
unmaintained

Qt lobby is currently the fastest lobby available and is very stable. It uses the Qt library. Use its [http://code.google.com/p/qtlobby/ project page] to post issues, download or browse the sources.

=Libraries and frameworks=

==Spring-PythonBotFramework==
cross-platform,
Python,
unmaintained

A bot framework written in python
[https://github.com/springlobby/spring_pythonbot_framework project page]

==Go SpringLobbyClient==
cross-platform,
Go

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=
==Protocol==
* [http://springrts.com/dl/tasclient/ProtocolDescription.xml HTML] (may be out of date)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

==TASServer==
cross-platform,
Java,
by Betalord &
hoijui

The longest-running lobby server, created by Betalord, using PHP for the admin interface. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/TASServer development site].

==UberServer==
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. All protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and TASServer. You can get more information and download uberserver at the [https://github.com/lunixbochs/uberserver github page]

[[Category: Lobbies]]

Lobby Development

2011-05-12T05:29:54Z

Aegis: /* UberServer */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Lobby client development=
There are currently three working public lobby clients available, and two in development.

==SpringLobby==
cross-platform,
C++,
by BrainDamage &
koshi

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

==Zero-K==
Windows,
C#,
by Licho & quantum

[https://code.google.com/p/zero-k/ Zero-K project page]

==Alphalobby==
Windows,
C,
by Axiomatic

Alphalobby is still very much work in progress. If you still wish to use it, source available from the [http://code.google.com/p/alphalobby/source/checkout mercurial repository], binary available on the [http://springfiles.com/spring/lobby-clients/alphalobby springfiles page].

==TASClient==
Windows,
Delphi,
by Satirik

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

==QtLobby==
cross-platform,
C++,
unmaintained

Qt lobby is currently the fastest lobby available and is very stable. It uses the Qt library. Use its [http://code.google.com/p/qtlobby/ project page] to post issues, download or browse the sources.

=Libraries and frameworks=

==Spring-PythonBotFramework==
cross-platform,
Python,
unmaintained

A bot framework written in python
[https://github.com/springlobby/spring_pythonbot_framework project page]

==Go SpringLobbyClient==
cross-platform,
Go

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=
==Protocol==
* [http://springrts.com/dl/tasclient/ProtocolDescription.xml HTML] (may be out of date)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

==TASServer==
cross-platform,
Java,
by Betalord &
hoijui

The previous lobby server, created by Betalord, using PHP for the admin interface. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/TASServer development site].

==UberServer==
cross-platform,
Python,
by aegis

The primary lobby server currently running on springrts.com. All protocol commands in the primary documentation should be fully-functional and compatible between both uberserver and TASServer. You can get more information and download uberserver at the [https://github.com/lunixbochs/uberserver github page]

[[Category: Lobbies]]

Lobby Development

2011-05-12T05:27:51Z

Aegis: /* TASServer */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Lobby client development=
There are currently three working public lobby clients available, and two in development.

==SpringLobby==
cross-platform,
C++,
by BrainDamage &
koshi

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

==Zero-K==
Windows,
C#,
by Licho & quantum

[https://code.google.com/p/zero-k/ Zero-K project page]

==Alphalobby==
Windows,
C,
by Axiomatic

Alphalobby is still very much work in progress. If you still wish to use it, source available from the [http://code.google.com/p/alphalobby/source/checkout mercurial repository], binary available on the [http://springfiles.com/spring/lobby-clients/alphalobby springfiles page].

==TASClient==
Windows,
Delphi,
by Satirik

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

==QtLobby==
cross-platform,
C++,
unmaintained

Qt lobby is currently the fastest lobby available and is very stable. It uses the Qt library. Use its [http://code.google.com/p/qtlobby/ project page] to post issues, download or browse the sources.

=Libraries and frameworks=

==Spring-PythonBotFramework==
cross-platform,
Python,
unmaintained

A bot framework written in python
[https://github.com/springlobby/spring_pythonbot_framework project page]

==Go SpringLobbyClient==
cross-platform,
Go

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=
==Protocol==
* [http://springrts.com/dl/tasclient/ProtocolDescription.xml HTML] (may be out of date)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

==TASServer==
cross-platform,
Java,
by Betalord &
hoijui

The previous lobby server, created by Betalord, using PHP for the admin interface. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/TASServer development site].

==UberServer==
cross-platform,
Python,
by aegis

You can get more information and download it at the [https://github.com/lunixbochs/uberserver github page]

[[Category: Lobbies]]

Lobby Development

2011-05-12T05:25:27Z

Aegis: /* UberServer */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Lobby client development=
There are currently three working public lobby clients available, and two in development.

==SpringLobby==
cross-platform,
C++,
by BrainDamage &
koshi

SpringLobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It uses the ''wxWidgets'' library. You can browse the sources and submit issues on its [http://springlobby.info/ website].

==Zero-K==
Windows,
C#,
by Licho & quantum

[https://code.google.com/p/zero-k/ Zero-K project page]

==Alphalobby==
Windows,
C,
by Axiomatic

Alphalobby is still very much work in progress. If you still wish to use it, source available from the [http://code.google.com/p/alphalobby/source/checkout mercurial repository], binary available on the [http://springfiles.com/spring/lobby-clients/alphalobby springfiles page].

==TASClient==
Windows,
Delphi,
by Satirik

You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here:
http://springrts.com/dl/tasclient/TASClientLatest.7z

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

==QtLobby==
cross-platform,
C++,
unmaintained

Qt lobby is currently the fastest lobby available and is very stable. It uses the Qt library. Use its [http://code.google.com/p/qtlobby/ project page] to post issues, download or browse the sources.

=Libraries and frameworks=

==Spring-PythonBotFramework==
cross-platform,
Python,
unmaintained

A bot framework written in python
[https://github.com/springlobby/spring_pythonbot_framework project page]

==Go SpringLobbyClient==
cross-platform,
Go

A simple client implementation of the lobby protocol in Go.
[https://github.com/Agon/go-slc/ project page]

=Lobby server development=
==Protocol==
* [http://springrts.com/dl/tasclient/ProtocolDescription.xml HTML] (may be out of date)
* [https://github.com/spring/LobbyProtocol/blob/master/ProtocolDescription.xml XML] (raw, always latest)

==Download Systems==
* [http://springrts.com/wiki/Dev:LobbyDownloadSystems Lobby Download Systems]

==TASServer==
cross-platform,
Java,
by Betalord &
hoijui

The official lobby server, created by Betalord, using PHP for the admin interface. You can fetch the sources through ''git''. Details can be found on the [http://github.com/spring/TASServer development site].

==UberServer==
cross-platform,
Python,
by aegis

You can get more information and download it at the [https://github.com/lunixbochs/uberserver github page]

[[Category: Lobbies]]

Lua UnsyncedRead

2011-01-05T23:23:08Z

Aegis: TraceScreenRay includeSky

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}
=Unsynced Read=

== Replay/Spectating ==
'''Spring.IsReplay'''
( ) -> nil | boolean
'''Spring.GetSpectatingState'''
( ) -> boolean spectating, boolean fullView, boolean fullSelect

== ModUI ==
'''Spring.GetModUICtrl'''
( ) -> boolean

== MyInfo ==
'''Spring.GetMyAllyTeamID'''
( ) -> number
'''Spring.GetMyTeamID'''
( ) -> number
'''Spring.GetMyPlayerID'''
( ) -> number

== Local Player,Team,Ally ==
Redundant same as the GetMyXYZ functions!

'''Spring.GetLocalPlayerID'''
( ) -> number playerID
'''Spring.GetLocalTeamID'''
( ) -> number teamID
'''Spring.GetLocalAllyTeamID'''
( ) -> number allyID

== Team/Player Info ==
'''Spring.GetPlayerRoster'''
( [number sortType] ) ->
nil | playerTable = {
[1] = {
string name,
number playerID,
number teamID,
number allyTeamID,
boolean spectator,
number cpuUsage,
number pingTime
},
etc...
}

 Sort codes:
1 = Sort by allies (the default)
2 = Sort by teamID
3 = Sort by playerName
4 = Sort by CPU usage
5 = Sort by ping time
'''Spring.GetTeamColor'''
( number teamID ) -> nil | number r, number g, number b, number a
'''Spring.GetTeamOrigColor'''
( number teamID ) -> nil | number r, number g, number b, number a
'''Spring.GetPlayerTraffic'''
( number playerID [, number packetID] ) -> number

== Sound ==
'''Spring.GetSoundStreamTime'''
( ) -> number playedTime, number totalTime

== Camera ==
'''Spring.GetCameraNames'''
( ) -> { [camName] = number camNum, ... }
'''Spring.GetCameraState'''
( ) -> { "name" = string, "mode" = number camIdx, state1 = number, state2 = number, ... }

See [[Lua_camState]] for details about Spring.GetCameraState output.

'''Spring.GetCameraPosition'''
( ) -> number x, number y, number z
'''Spring.GetCameraDirection'''
( ) -> number forward_x, number forward_y, number forward_z
'''Spring.GetCameraFOV'''
( ) -> number fov
'''Spring.GetCameraVectors'''
( ) -> vectorTable = {
forward = { [1] = number x, [2] = number y, [3] = number z },
up = { [1] = number x, [2] = number y, [3] = number z },
right = { [1] = number x, [2] = number y, [3] = number z },
top = { [1] = number x, [2] = number y, [3] = number z },
bottom = { [1] = number x, [2] = number y, [3] = number z },
leftside = { [1] = number x, [2] = number y, [3] = number z },
rightside = { [1] = number x, [2] = number y, [3] = number z }
}

=== Inview ===
'''Spring.GetVisibleUnits'''
( [number teamID = -1 [, number radius = 30 [, boolean Icons = true ]]] )
-> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetVisibleFeatures'''
( [number allyTeamID = -1 [, number radius = 30 [, boolean Icons = true [, boolean geos = true ]]]] )
-> nil | featureTable = { [1] = number featureID, ... }

'''Spring.IsAABBInView'''
( number minX, number minY, number minZ,
number maxX, number maxY, number maxZ ) -> nil | boolean
'''Spring.IsSphereInView'''
( number x, number y, number z [, number radius ] ) -> nil | boolean
'''Spring.IsUnitIcon'''
( number unitID ) -> nil | boolean
'''Spring.IsUnitInView'''
( number unitID ) -> nil | boolean
'''Spring.IsUnitVisible'''
( number unitID [, number radius [, boolean checkIcons] ] ) -> nil | boolean

=== Screen Trace ===
'''Spring.WorldToScreenCoords'''
( number x, number y, number z ) -> number x, number y, number z
'''Spring.TraceScreenRay'''
( number mouseX, number mouseY [, boolean onlyCoords [, boolean useMinimap, [boolean includeSky]] ] )
-> nil |
string "unit", number unitID |
string "feature", number featureID |
string "ground", { [1] = number x, [2] = number y, [3] = number z }

=== Screen & Window Geometry ===
'''Spring.GetViewGeometry'''
( ) -> number viewSizeX, number viewSizeY, number viewPosX, number viewPosY
'''Spring.GetWindowGeometry'''
( ) -> number winSizeX, number winSizeY, number winPosX, number winPosY
'''Spring.GetScreenGeometry''' (is missing multiscreen support!)
( ) -> number screenSizeX, number screenSizeY, number ZERO, number ZERO

== Unit ==
'''Spring.IsUnitAllied'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitViewPosition'''
( number unitID [, boolean extrapolated ] ) -> nil | boolean
'''Spring.GetUnitTransformMatrix'''
( number unitID [, boolean invert = false] ) -> nil | number a11, number a12 ..., number a44 (4x4 matrix)

=== Selected Units ===
'''Spring.GetSelectedUnits'''
( ) -> { [1] = unitID, ... }
'''Spring.GetSelectedUnitsSorted'''
( ) -> { [number unitDefID] = { [1] = [number unitID], etc...}, ... }
'''Spring.GetSelectedUnitsCounts'''
( ) -> { [number unitDefID] = number count, etc... }
'''Spring.GetSelectedUnitsCount'''
( ) -> number count
'''Spring.IsUnitSelected'''
( number unitID ) -> nil | boolean

=== Unit Groups ===
'''Spring.GetUnitGroup'''
( number unitID ) -> nil | number

'''Spring.GetGroupList'''
( ) -> nil | {
[number] = number unitCount,
...
}
'''Spring.GetSelectedGroup'''
( ) -> number
'''Spring.GetGroupAIName'''
( number groupID ) -> string aiName
'''Spring.GetGroupAIList'''
( ) -> {
[1] = string aiName, ...
}

'''Spring.GetGroupUnits'''
( number groupID ) -> nil | {
[1] = number unitID, ...
}
'''Spring.GetGroupUnitsSorted'''
( number groupID ) -> nil | {
[number unitDefID] = {number unitID, ...}, ...
}
'''Spring.GetGroupUnitsCounts'''
( number groupID ) -> nil | {
[number unitDefID] = number count, ...
}
'''Spring.GetGroupUnitsCount'''
( number groupID ) -> nil | number count

== UI ==

=== GUI Settings ===
'''Spring.IsGUIHidden'''
( ) -> nil | boolean
'''Spring.HaveShadows'''
( ) -> nil | boolean
'''Spring.HaveAdvShading'''
( ) -> nil | boolean
'''Spring.GetWaterMode'''
( ) -> nil | number mode, string "mode"

 mode numbers:
0 - basic
1 - reflective
2 - dynamic
3 - refractive
4 - bumpwater
default - unknown
'''Spring.GetMapDrawMode'''
( ) -> nil | "normal" | "height" | "metal" | "path" | "los"
'''Spring.GetDrawSelectionInfo''' Returns whether "Selected units" text is displayed.
( ) -> boolean

=== Unit GUI States ===
'''Spring.GetUnitLuaDraw'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitNoDraw'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitNoMinimap'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitNoSelect'''
( number unitID ) -> nil | boolean

=== Minimap ===
'''Spring.GetMiniMapGeometry'''
( ) -> number posX, number posY, number sizeX, number sizeY,
boolean minimized, boolean maximized
'''Spring.GetMiniMapDualScreen'''
( ) -> boolean false | string "left" | string "right"
'''Spring.IsAboveMiniMap'''
( number x, number y ) -> nil | boolean

=== (Build-)Menu ===
'''Spring.GetActiveCommand'''
( ) -> nil | number index (, number cmd_id, number cmd_type, string cmd_name)
'''Spring.GetDefaultCommand'''
( ) -> nil | number index (, number cmd_id, number cmd_type, string cmd_name)
'''Spring.GetActiveCmdDescs'''
( ) -> nil | {
[1] = {
id=number,
type=number,
name=string,
action=string,
tooltip=string,
texture=string,
cursor=string,
hidden=boolean,
disabled=boolean,
showUnique=boolean,
onlyTexture=boolean,
params = { [1] = string, .. }
}, ...
}
'''Spring.GetActiveCmdDesc'''
( number index ) -> nil | {
id=number,
type=number,
name=string,
action=string,
tooltip=string,
texture=string,
cursor=string,
hidden=boolean,
disabled=boolean,
showUnique=boolean,
onlyTexture=boolean,
params = { [1] = string, .. }
}
'''Spring.GetCmdDescIndex'''
( number cmdID ) -> nil | number index
'''Spring.GetActivePage'''
( ) -> nil | number pageNum, number maxPages

=== Build Facing ===
'''Spring.GetBuildFacing'''
( ) -> nil | number
'''Spring.GetBuildSpacing'''
( ) -> nil | number

=== GatherMode & InvertQueueKey ===
'''Spring.GetGatherMode'''
( ) -> nil | number
'''Spring.GetInvertQueueKey'''
( ) -> nil | boolean

=== Mouse States ===
'''Spring.GetMouseState'''
( ) -> number X, number Y,
boolean leftPressed, boolean middlePressed, boolean rightPressed
'''Spring.GetMouseCursor'''
( ) -> string name, number scale
'''Spring.GetMouseStartPosition'''
( number mouseButton ) -> nil | number pressedX, number pressedY,
number camPosX, number camPosY, number camPosZ,
number dirX, number dirY, number dirZ

=== (Hot-)Keys ===
'''Spring.GetKeyState'''
( number key ) -> nil | boolean
'''Spring.GetModKeyState'''
( ) -> boolean alt, boolean ctrl, boolean meta, boolean shift
'''Spring.GetPressedKeys'''
( ) -> {
[number] = boolean,
...
}
'''Spring.GetKeyCode'''
( string keysym ) -> number
'''Spring.GetKeySymbol'''
( number key ) -> string "keysym1", string "keysym2"
'''Spring.GetKeyBindings'''
( string keyset ) -> nil | { [1] = {[string actionCmd] = string actionExtra}, ... }
'''Spring.GetActionHotKeys'''
( string action ) -> nil | { [1] = string hotKey, ... }

=== Console ===
'''Spring.GetLastMessagePositions'''
( ) -> nil | {
[1] = { number X, number Y, number Z },
...
}
'''Spring.GetConsoleBuffer'''
( [number maxLines] ) -> nil | {
[1] = {
text = string,
priority = number
}, ...
}
'''Spring.GetCurrentTooltip'''
( ) -> string

== FPS & GetDrawFrame ==
'''Spring.GetFPS'''
( ) -> number
'''Spring.GetDrawFrame'''
( ) -> number low 16bit, number high 16bit

== Time ==
'''Spring.GetFrameTimeOffset'''
( ) -> nil | number
'''Spring.GetLastUpdateSeconds'''
( ) -> nil | number
'''Spring.GetHasLag'''
( ) -> boolean
'''Spring.GetTimer'''
( ) -> timer
'''Spring.DiffTimers'''
( timer cur, timer ago) -> number seconds

[[category: Lua]]

Lua SyncedRead

2010-12-25T08:13:15Z

Aegis: removed duplicate breadcrumbs

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== Game ==

=== Special TeamID Variables ===
(those special TeamIDs are not supported by all functions) 
'''Spring.ALL_UNITS''' 
'''Spring.MY_UNITS''' 
'''Spring.ALLY_UNITS''' 
'''Spring.ENEMY_UNITS'''

'''Spring.GetGaiaTeamID'''
( ) -> number teamID

=== GameStates ===
'''Spring.IsGodModeEnabled'''
( ) -> boolean
'''Spring.IsCheatingEnabled'''
( ) -> boolean
'''Spring.IsDevLuaEnabled'''
( ) -> boolean
'''Spring.IsEditDefsEnabled'''
( ) -> boolean
'''Spring.AreHelperAIsEnabled'''
( ) -> boolean
'''Spring.FixedAllies'''
( ) -> nil | boolean

'''Spring.IsGameOver'''
( ) -> boolean

=== Rules ===
Those functions allow to save data per Game,Team and Unit. The advantage of it is that it can be read from anywhere (even from LuaUI and AIs!) 
'''Spring.GetRulesInfoMap''' REMOVED in 0.82!
( ) -> { [key1] = string value1, [key2] = string value2, ... }
( string "key" ) -> string

'''Spring.GetGameRulesParam'''
( number ruleIndex | string ruleName ) -> number value
'''Spring.GetGameRulesParams'''
( ) -> nil | { [ruleIndex1] = {[ruleName1] = number value1}, [ruleIndex2] = {[ruleName2] = number value2}, ... }

'''Spring.GetTeamRulesParam'''
( number teamID, number index | string ruleName ) -> nil | number value
'''Spring.GetTeamRulesParams'''
( number teamID ) -> nil | { [ruleIndex1] = {[ruleName1] = number value1}, [ruleIndex2] = {[ruleName2] = number value2}, ... }

'''Spring.GetUnitRulesParam'''
( number unitID, number index | string ruleName ) -> nil | number value
'''Spring.GetUnitRulesParams'''
( number unitID ) -> nil | { [ruleIndex1] = {[ruleName1] = number value1}, [ruleIndex2] = {[ruleName2] = number value2}, ... }

=== Mod-/Map-Options ===
'''Spring.GetModOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }
'''Spring.GetMapOptions'''
( ) -> {} | { "keyName1" = string "value", "keyName2" = string "value", ... }

=== Speed/Time ===
'''Spring.GetGameSpeed'''
( ) -> number userSpeedFactor, number speedFactor, boolean paused
'''Spring.GetGameFrame'''
( ) -> number frameNum%dayFrames, number frameNum/dayFrames
'''Spring.GetGameSeconds'''
( ) -> number seconds

=== Vectors ===
'''Spring.GetWind'''
( ) -> number dirX, number dirY, number dirZ,
number strength, number normDirX, number normDirY, number normDirZ

'''Spring.GetHeadingFromVector'''
( number x, number z ) -> number heading
'''Spring.GetVectorFromHeading'''
( number heading ) -> number x, number z

== Sides/Factions ==
'''Spring.GetSideData'''
( string sideName ) -> nil | string startUnit, string caseSensitiveSideName
( number sideID ) -> nil | string sideName, string startUnit, string caseSensitiveSideName
( ) -> { [1] = { sideName=string,caseName=string,startUnit=string}, [2] = .., .. }

== Teams ==
=== StartBoxes/StartPositions ===
'''Spring.GetAllyTeamStartBox'''
( number allyID ) -> nil | number xmin, number zmin, number xmax, number zmax
'''Spring.GetTeamStartPosition'''
( number teamID ) -> nil | number x, number y, number z

=== Player,Team,Ally Lists/Info ===
'''Spring.GetPlayerList'''
( [number teamID = -1 | boolean onlyActive = false] [, number teamID | boolean onlyActive])
-> nil | { [1] = number playerID, etc... }
'''Spring.GetTeamList'''
( [number allyTeamID = -1] ) -> nil | { [1] = number teamID, etc... }
'''Spring.GetAllyTeamList'''
( ) -> { [1] = number allyTeamID, etc... }

'''Spring.GetPlayerInfo'''
( number playerID ) ->
nil | string "name", (in synced code this is "SYNCED_NONAME"!)
boolean active,
boolean spectator,
number teamID,
number allyTeamID,
number pingTime,
number cpuUsage,
string country,
number rank
table customPlayerKeys
'''Spring.GetPlayerControlledUnit'''
( number playerID ) -> nil | number unitID

'''Spring.GetAIInfo'''
( number teamID ) ->
number skirmishAIID,
string name,
number hostingPlayerID,
string shortName, (synced => "SYNCED_NOSHORTNAME"; non-local => "UNKNOWN")
string version, (synced => "SYNCED_NOVERSION"; non-local => "UNKNOWN")
table options (synced & non-local => empty-table)
Note: Before 0.82, the first argument was teamID, and then every other argument with a shifted position.

'''Spring.GetAllyTeamInfo'''
( number allyteamID ) -> nil | table customTeamKeys

'''Spring.GetTeamInfo'''
( number teamID ) ->
nil | number teamID,
number leader, (:= a player id)
boolean isDead,
boolean isAiTeam,
string "side",
number allyTeam,
table customTeamKeys,
number incomeMultiplier
'''Spring.GetTeamResources'''
( number teamID, string "metal" | "energy" ) ->
nil | number currentLevel,
number storage,
number pull,
number income,
number expense,
number share,
number sent,
number received
'''Spring.GetTeamUnitStats'''
( number teamID ) ->
nil | number killed,
number died,
number capturedBy,
number capturedFrom,
number received,
number sent
'''Spring.GetTeamResourceStats''' 0.82 and later
( number teamID, string "metal" | "energy" ) ->
nil | number used,
number produced,
number excessed,
number received,
number sent
'''Spring.GetTeamStatsHistory'''
( number teamID [, number startIndex [, number endIndex = startIndex ]]) ->
nil |
number cur_max_index |
{
[1] = {
"time" = number,
"frame" = number,
"metalUsed" = number,
"metalProduced" = number,
"metalExcess" = number,
"metalReceived" = number,
"metalSent" = number,
"energyUsed" = number,
"energyProduced" = number,
"energyExcess" = number,
"energyReceived" = number,
"energySent" = number,
"damageDealt" = number,
"damageReceived" = number,
"unitsProduced" = number,
"unitsDied" = number,
"unitsReceived" = number,
"unitsSent" = number,
"unitsCaptured" = number,
"unitsOutCaptured" = number,
"unitsKilled" = number
}, ...
}
if called with just teamID as argument it returns the current possible range for startIndex/endIndex :={1..cur_max_index}

'''Spring.GetTeamLuaAI'''
( number teamID ) -> string "luaAI"

=== Teams/PlayersAllied ===
'''Spring.AreTeamsAllied'''
( number teamID1, number teamID2 ) -> nil | boolean
'''Spring.ArePlayersAllied'''
( number playerID1, number playerID2 ) -> nil | boolean

== Units ==
=== GetUnits ===
'''Spring.GetAllUnits'''
( ) -> nil | unitTable = { [1] = number unitID, ... }
'''Spring.GetTeamUnits'''
( number teamID ) -> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitsSorted'''
( number teamID ) -> nil |
unitDefTable = {
[number unitDefID] = { [1] = [number unitID], etc... },
etc...
}
'''Spring.GetTeamUnitsCounts'''
( number teamID ) -> nil | countTable = { [number unitDefID] = count, etc... }
'''Spring.GetTeamUnitsByDefs'''
( number teamID, number unitDefID | { number unitDefID1, ... } )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetTeamUnitDefCount'''
( number teamID, number unitDefID ) -> nil | number count
'''Spring.GetTeamUnitCount'''
( number teamID ) -> nil | number count

'''Spring.GetUnitsInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInBox'''
( number xmin, number ymin, number zmin,
number xmax, number ymax, number zmax [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInSphere'''
( number x, number y, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInCylinder'''
( number x, number z, number radius [,number teamID] )
-> nil | unitTable = { [1] = number unitID, etc... }
'''Spring.GetUnitsInPlanes'''
( planes = { [1] = { number nx, number ny, number nz, number d }, etc... } )
-> nil | unitTable = { [1] = number unitID, etc... }

plane normals point towards accepted space,
so the acceptance criteria for each plane is:
radius = unit radius
px, py, pz = unit position
[(nx * px) + (ny * py) + (nz * pz) + (d - radius)] <= 0


'''Spring.GetUnitNearestAlly'''
( number unitID [, number range ] ) -> nil | number unitID
'''Spring.GetUnitNearestEnemy'''
( number unitID [, number range [, bool useLOS]] ) -> nil | number unitID

=== Unit Informations ===
'''Spring.ValidUnitID'''
( number unitID ) -> boolean
'''Spring.GetUnitIsDead'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitTooltip'''
( number unitID ) -> nil | string tooltip
'''Spring.GetUnitDefID'''
( number unitID ) -> nil | number unitDefID
'''Spring.GetUnitTeam'''
( number unitID ) -> nil | number teamID
'''Spring.GetUnitAllyTeam'''
( number unitID ) -> nil | number allyID
'''Spring.GetUnitLineage''' Removed from version 0.83.x 
( number unitID ) -> nil | number lineage | number lineage, boolean lineageIsRoot
'''Spring.GetUnitNeutral'''
( number unitID ) -> nil | boolean neutral
'''Spring.GetUnitHealth'''
( number unitID ) -> nil | number health, number maxHealth, number paralyzeDamage,
number captureProgress, number buildProgress
'''Spring.GetUnitArmored''' armorMultiple new in version 0.83.x
( number unitID ) -> nil | boolean armored, number armorMultiple
'''Spring.GetUnitIsStunned'''
( number unitID ) -> nil | boolean stunned_or_inbuild, boolean stunned, boolean inbuild
'''Spring.GetUnitResources'''
( number unitID ) -> nil | number metalMake, number metalUse,
number energyMake, number energyUse
'''Spring.GetUnitMetalExtraction''' 0.82+ and later
( number unitID ) -> nil | number
'''Spring.GetUnitExperience'''
( number unitID ) -> nil | number experience
'''Spring.GetUnitStates'''
( number unitID ) -> nil | {
"firestate" = number,
"movestate" = number,
"repeat" = boolean,
"cloak" = boolean,
"active" = boolean,
"trajectory" = boolean,
["autoland" = boolean,]
["autorepairlevel" = number,]
["loopbackattack" = boolean]
}
'''Spring.GetUnitIsActive'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitIsCloaked'''
( number unitID ) -> nil | boolean
'''Spring.GetUnitSelfDTime'''
( number unitID ) -> nil | number
'''Spring.GetUnitStockpile'''
( number unitID ) -> nil | number numStockpiled, number numStockpileQued,
number buildPercent
'''Spring.GetUnitHeight'''
( number unitID ) -> nil | number
'''Spring.GetUnitRadius'''
( number unitID ) -> nil | number
'''Spring.GetUnitPosition'''
( number unitID ) -> nil | number x, number y, number z
returns the center position of the unit (midpos).

'''Spring.GetUnitBasePosition'''
( number unitID ) -> nil | number x, number y, number z
returns the bottom of the unit.

'''Spring.GetUnitDirection'''
( number unitID ) -> nil | number dx, number dy, number dz
'''Spring.GetUnitHeading'''
( number unitID ) -> nil | number heading
'''Spring.GetUnitVelocity'''
( number unitID ) -> nil | number velx, number vely, number velz
'''Spring.GetUnitBuildFacing'''
( number unitID ) -> nil | number
'''Spring.GetUnitIsBuilding'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitTransporter'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitIsTransporting'''
( number unitID ) -> nil | { [1] = number unitID, etc... }
'''Spring.GetUnitShieldState'''
( number unitID [, number weaponID = -1] ) -> nil | number isEnabled, number curPower
'''Spring.GetUnitTravel'''
( number unitID ) -> nil | number travel, number travelPeriod
'''Spring.GetUnitFuel'''
( number unitID ) -> nil | number
'''Spring.GetUnitFlanking'''
( number unitID, string "dir" ) -> nil | number x, number y, number z
( number unitID, string "mode" | "moveFactor" | "minDamage" | "maxDamage" ) -> nil | number
( number unitID ) -> nil | number mode, number modilityAdd,
number minDamage, number maxDamage, number dirX, number dirY, number dirZ
'''Spring.GetUnitSensorRadius'''
( number unitID, string type ) -> nil | number radius
possible types are: airLos, radar, sonar, seismic, radarJammer & sonarJammer
'''Spring.GetUnitLosState''' raw is only available in gadgets
( number unitID [, number allyTeamID [, boolean raw] ] ) -> nil |
{ ["los" = true] [, "radar" = true] [, "typed" = true] }
'''Spring.GetUnitSeparation''' (returns the distance of 2 units)
( number unitID1, number unitID2 [, boolean 2D ] ) -> nil | number distance
'''Spring.GetUnitDefDimensions'''
( number unitDefID ) -> nil |
{
"height" = number,
"radius" = number,
"midx" = number,
"minx" = number,
"maxx" = number,
"midy" = number,
"miny" = number,
"maxy" = number,
"midz" = number,
"minz" = number,
"maxz" = number
}
'''Spring.GetUnitWeaponVectors'''
( number unitID, number weaponNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirY, number dirZ
'''Spring.GetUnitWeaponState'''
( number unitID, number weaponNum ) -> nil |
boolean angleGood, boolean loaded, number reloadFrame, number salvoLeft, number numStockpiled
( number unitID, number weaponNum, string tag ) -> nil | number
`tag` can be:
"reloadState" == "reloadFrame"
"reloadTime"
"accuracy"
"sprayAngle"
"range"
"projectileSpeed"
"burst"
"burstRate"
"projectiles"
'''Spring.GetUnitLastAttacker'''
( number unitID ) -> nil | number unitID
'''Spring.GetUnitLastAttackedPiece''''
( number unitID ) -> nil | string pieceName, number gameframe
'''Spring.GetUnitMoveTypeData''' new in version 0.80+
( number unitID ) -> nil | { movetype data }
'''Spring.GetUnitCollisionVolumeData'''
( number unitID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled
'''Spring.GetUnitPieceCollisionVolumeData'''
( number unitID, number pieceID )
-> number scaleX, number scaleY, number scaleZ,
number offsetX, number offsetY, number offsetZ,
number volumeType, number testType, number primaryAxis, boolean disabled

=== Unit Pieces ===
'''Spring.GetUnitVectors'''
( number unitID ) -> nil | {frontX,frontY,frontZ}, {upX,upY,upZ}, {rightX,rightY,rightZ}
'''Spring.GetUnitPiecePosition'''
( number unitID, number piece ) -> number posx, number posy, number posz
Returns piece position in unit space

'''Spring.GetUnitPieceDirection'''
( number unitID, number piece ) -> number dirx, number diry, number dirz
Consider this broken. It returns reverse direction in piece space (i.e. vertex(0)-vertex(1)) for pieces with >= 2 vertices and (1,1,1) for pieces with < 2 vertices)

'''Spring.GetUnitPieceMatrix'''
( number unitID, number piece ) -> { [1] = number, ... , [16] = number }
'''Spring.GetUnitPieceList'''
( number unitID ) -> { [1] = string "piecename", ... , [pieceNumN] = string "piecename" }
'''Spring.GetUnitPieceMap'''
( number unitID ) -> { "piecename1" = pieceNum1, ... , "piecenameN" = pieceNumN }
'''Spring.GetUnitPieceInfo'''
( number unitID, number piece ) -> {
"name" = string "piecename",
"isEmpty" = boolean,
"children" = { [1] = string "piecename", ... },
"min" = { [1] = number x, [2] = number y, [3] = number z },
"max" = { [1] = number x, [2] = number y, [3] = number z },
"offset" = { [1] = number x, [2] = number y, [3] = number z },
}
'''Spring.GetUnitScriptPiece'''
( number unitID [, number scriptPiece ] )
-> nil | { scriptPieceNum = number modelPieceNum } | number modelPieceNum

This functions translate the COB ScriptPiece numbers into the ModelPiece numbers (the set of ScriptPieces is a subset of the ModelPieces, means #ScriptPieces <= #ModelPieces), which is used in all other functions (the "number piece" means always the modelpiece). So if you get via Cob2Lua a pieceID you have to translate it with this function. Btw the COB ScriptPiece number is equal with the piece position in the piece definition in your cob/bos.

'''Spring.GetUnitScriptNames'''
( number unitID )
-> { "cobpiecename1" = ScriptPieceNum1, ... , "cobpiecenameN" = ScriptPieceNumN }
'''Spring.GetUnitPiecePosDir'''
( number unitID, number pieceNum ) -> nil | number posX, number posY, number posZ,
number dirX, number dirZ, number dirY
Returns piece position and direction in world space. The direction (dirX, dirY, dirZ) is not necessarily normalized. The position is defined as the position of the first vertex of the piece and it defines direction as the direction in which the line from the first vertex to the second vertex points.

=== CommandQueues ===

'''Spring.GetUnitCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}

'''Spring.GetCommandQueue''' (same as Spring.GetUnitCommands)
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}
'''Spring.GetFullBuildQueue'''
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetRealBuildQueue''' (cleans the buildqueue of things the unit can't build itself)
( number unitID ) ->
nil | buildOrders = {
[1] = { [number unitDefID] = number count }, etc...
}
'''Spring.GetFactoryCommands'''
( number unitID [, number count] ) -> nil | commandQueueTable = {
[1] = {
"id" = number,
"params" = { [1] = number, ...},
"options" = {
"coded" = number,
"alt" = boolean,
"ctrl" = boolean,
"shift" = boolean,
"right" = boolean,
"internal" = boolean,
"meta" = boolean
}
}, ...
}
'''Spring.GetFactoryCounts''' (used to get the buildqueue of a factory, seems screwed o_O)
( number unitID [, number count [, boolean addCMDs ] ] ) -> nil | commandQueueTable = {
[2] = { [number unitDefID | number -cmdID] = number count }, ...
}

=== Command Descriptions/Buttons ===
'''Spring.GetUnitCmdDescs'''
( number unitID [, number startIndex [, number endIndex ] ] ) -> nil | {
[1] = {
"id" = number,
"type" = number,
"name" = string,
"action" = string,
"tooltip" = string,
"texture" = string,
"cursor" = string,
"hidden" = boolean,
"disabled" = boolean,
"showUnique" = boolean,
"onlyTexture" = boolean,

"params" = { [1] = string, ... }
}, ...
}
'''Spring.FindUnitCmdDesc'''
( number unitID, number cmdID ) -> nil | number index

== Features ==
=== GetFeatures ===
'''Spring.GetFeaturesInRectangle'''
( number xmin, number zmin, number xmax, number zmax [,number teamID] )
-> nil | featureTable = { [1] = number featureID, etc... }
'''Spring.GetAllFeatures'''
( ) -> nil | { [1] = number featureID, ... }

=== Feature Informations ===
'''Spring.ValidFeatureID'''
( number featureID ) -> boolean
'''Spring.GetFeatureDefID'''
( number featureID ) -> nil | number featureDefID
'''Spring.GetFeatureTeam'''
( number featureID ) -> nil | number teamID
'''Spring.GetFeatureAllyTeam'''
( number featureID ) -> nil | number allyID
'''Spring.GetFeatureHealth'''
( number featureID ) -> nil | number health, number maxHealth, number resurrectProgress
'''Spring.GetFeatureHeight'''
( number featureID ) -> nil | number
'''Spring.GetFeatureRadius'''
( number featureID ) -> nil | number
'''Spring.GetFeaturePosition'''
( number featureID ) -> nil | number x, number y, number z
'''Spring.GetFeatureDirection'''
( number featureID ) -> nil | number dirx, number diry, number dirz
'''Spring.GetFeatureHeading'''
( number featureID ) -> nil | number heading
'''Spring.GetFeatureResources'''
( number featureID ) -> nil | number RemainingMetal, number maxMetal,
number RemainingEnergy, number maxEnergy, number reclaimLeft
'''Spring.GetFeatureNoSelect'''
( number featureID ) -> nil | boolean noSelect
'''Spring.GetFeatureResurrect'''
( number featureID ) -> nil | string UnitDefName, number buildFacing

== COB ==
'''Spring.GetCOBUnitVar'''
( number unitID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBTeamVar'''
( number teamID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBAllyTeamVar'''
( number allyID, integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY
'''Spring.GetCOBGlobalVar'''
( integer varID [, boolean unpack = false ] )
-> nil | number value | number unpackedX, number unpackedY

== Ground ==
=== Ground Informations ===
Elevation is y. Water level is always at y=0. Ground height can be changed during play (terraform or deformation).

'''Spring.GetGroundHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundOrigHeight'''
( number x, number z ) -> number y
'''Spring.GetGroundNormal'''
( number x, number z ) -> number x, number y, number z
'''Spring.GetGroundInfo'''
( number x, number z ) -> string "Type", number metal, number hardness,
number tankSpeed, number kbotSpeed, number hoverSpeed,
number shipSpeed, boolean receiveTracks
'''Spring.GetGroundBlocked'''
( number x, number z |
number x1, number z1, number x2, number z2 )
-> nil | string "feature", number featureID | string "unit", number unitID
'''Spring.GetGroundExtremes'''
( ) -> nil | number minHeight, number maxHeight

'''Spring.GetSmoothMeshHeight'''
( number x, number z ) -> number y

=== Test Building ===
'''Spring.TestBuildOrder'''
( number unitDefID, number x, number y, number z, number facing)
-> number blocking [,number featureID]

blocking can be:
0 - blocked
1 - mobile unit in the way
2 - free (or if featureID is != 0 then with a blocking feature that can be reclaimed)
facing can be:
0, "s", "south"
1, "e", "east"
2, "n", "north"
3, "w", "west"
'''Spring.Pos2BuildPos'''
( number unitDefID, number x, number y, number z ) -> nil | number x, number y, number z

=== PathFinding ===
'''Spring.GetUnitEstimatedPath'''
( number unitID ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table the waypoints and 1 table with indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

=== LOS ===
'''Spring.IsPosInLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInRadar'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.IsPosInAirLos'''
( number x, number y, number z, number allyID ) -> boolean
'''Spring.GetPositionLosState'''
( number x, number y, number z [, number allyID] )
-> boolean LosOrRadar, boolean inLos, boolean inRadar
'''Spring.GetClosestValidPosition''' //NOT FINISHED YET
( number unitDefID, number x, number z, number r ) -> nil

== Projectiles ==

'''Spring.GetProjectileName'''
( number projectileID ) -> nil | string name
'''Spring.GetProjectileType'''
( number projectileID ) -> nil | boolean weapon, boolean piece
'''Spring.GetProjectilePosition'''
( number projectileID ) -> nil | number px, number py, number pz
'''Spring.GetProjectileVelocity'''
( number projectileID ) -> nil | number vx, number vy, number vz
'''Spring.GetProjectileGravity'''
( number projectileID ) -> nil | number gravity
'''Spring.GetProjectileSpinAngle'''
( number projectileID ) -> nil | number angle
'''Spring.GetProjectileSpinSpeed'''
( number projectileID ) -> nil | number spinSpeed
'''Spring.GetProjectileSpinVec'''
( number projectileID ) -> nil | number x, number y, number z

[[category: Lua]]

Download

2010-09-02T23:16:48Z

Aegis: /* Spring Engine Updates */

{{#css:
#content * {font-family: 'Bitstream Vera Sans', 'Trebuchet MS', 'Arial', 'Myriad Pro', 'FreeSans';}
}}
= Downloads =
<center>
{|style="margin-top: 15px; padding: 10px; background:rgba(45,180,19,0.5); border: 1px solid rgba(0,0,0,0.5); border-radius: 6px 6px 6px 6px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
| If you just want to get ready to play, you want this:
|-
| style="margin-top: 15px; text-align: center" | [[GamesDownloads|Games Downloads]]
|}
</center>

= Spring Engine Updates =
Latest stable version is: '''0.82'''

{|
| style="padding-right:10px"| [[Image:Window.png]]
| '''Installer: [http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.5/spring_0.82.5.exe/download spring_0.82.5.exe ~18MB]''' - [http://springrts.com/dl/spring_0.82.5.exe {mirror}]''' 

|}

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
| follow the '''[[SetupGuide|Linux Setup guide]]'''
|}

{|
| style="padding-right:10px"| [[Image:Apple.png]]
| ''' ''No download yet'' '''
The Mac OS X port is rough and unfinished. Help with its development would be greatly appreciated. More information on the current state of this port can be found '''[[Spring_on_MacOSX|here]]'''.
|}

= Testing/Nightly Builds =
Used for testing latest engine developments.
[http://springrts.com/dl/buildbot/ list of all test builds]

= Source Code =
== git ==
'''[http://github.com/spring/spring Spring project page at github]''' [http://status.github.com (status page)]
=== Getting the Source ===
<code><pre>git clone git://github.com/spring/spring.git</pre></code>
This however gives you the bleeding edge, if you want to play online then run:
<code><pre>git checkout 0.82.3</pre></code>
from within the source directory. This will provide the correct source code
=== Alternate git url ===
<code><pre>git://springrts.git.sourceforge.net/gitroot/springrts/springrts</pre></code>

== Latest Stable Snapshot ==
This tarball is the same as that used to build the last public release. See [[Building spring]] for build instructions.

The packages below target Linux only and do not contain certain files required to compile using CMake on Windows.

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.3/spring_0.82.3_src.tar.lzma/download Source .tar.lzma]''' - [http://springrts.com/dl/spring_0.82.3_src.tar.lzma {mirror}]

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.3/spring_0.82.3_src.tar.gz/download Source .tar.gz]''' - [http://springrts.com/dl/spring_0.82.3_src.tar.gz {mirror}]

= Other springrts.com hosted projects =
== TASClient ==
An alternative windows only lobby client.

'''[http://springrts.com/dl/tasclient/TASClientLatest.7z Download TASClient]'''

== Lobby server==
If you do not want (or are unable) to use the public lobby server, you can download the server software here to run your own. See the readme '''[http://springrts.com/dl/tasserver_readme.txt here]'''.

'''[http://springrts.com/dl/TASServer.jar Click here to download]''' 100.7kb, added 2008-03-02 (requires Java Runtime Environment)

== SelectionEditor ==
Sources are in the [[#git|main git tree]] under "/tools/SelectionEditor/".

'''[http://springrts.com/dl/SelectionEditor.zip Click here to download (windows only)]'''
__NOTOC__

Download

2010-09-02T22:47:41Z

Aegis: /* Spring Engine Updates */

{{#css:
#content * {font-family: 'Bitstream Vera Sans', 'Trebuchet MS', 'Arial', 'Myriad Pro', 'FreeSans';}
}}
= Downloads =
<center>
{|style="margin-top: 15px; padding: 10px; background:rgba(45,180,19,0.5); border: 1px solid rgba(0,0,0,0.5); border-radius: 6px 6px 6px 6px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
| If you just want to get ready to play, you want this:
|-
| style="margin-top: 15px; text-align: center" | [[GamesDownloads|Games Downloads]]
|}
</center>

= Spring Engine Updates =
Latest stable version is: '''0.82'''

{|
| style="padding-right:10px"| [[Image:Window.png]]
| '''Installer: [http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.4/spring_0.82.4.exe/download spring_0.82.4.exe ~18MB]''' - [http://springrts.com/dl/spring_0.82.4.exe {mirror}]''' 

|}

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
| follow the '''[[SetupGuide|Linux Setup guide]]'''
|}

{|
| style="padding-right:10px"| [[Image:Apple.png]]
| ''' ''No download yet'' '''
The Mac OS X port is rough and unfinished. Help with its development would be greatly appreciated. More information on the current state of this port can be found '''[[Spring_on_MacOSX|here]]'''.
|}

= Testing/Nightly Builds =
Used for testing latest engine developments.
[http://springrts.com/dl/buildbot/ list of all test builds]

= Source Code =
== git ==
'''[http://github.com/spring/spring Spring project page at github]''' [http://status.github.com (status page)]
=== Getting the Source ===
<code><pre>git clone git://github.com/spring/spring.git</pre></code>
This however gives you the bleeding edge, if you want to play online then run:
<code><pre>git checkout 0.82.3</pre></code>
from within the source directory. This will provide the correct source code
=== Alternate git url ===
<code><pre>git://springrts.git.sourceforge.net/gitroot/springrts/springrts</pre></code>

== Latest Stable Snapshot ==
This tarball is the same as that used to build the last public release. See [[Building spring]] for build instructions.

The packages below target Linux only and do not contain certain files required to compile using CMake on Windows.

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.3/spring_0.82.3_src.tar.lzma/download Source .tar.lzma]''' - [http://springrts.com/dl/spring_0.82.3_src.tar.lzma {mirror}]

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.3/spring_0.82.3_src.tar.gz/download Source .tar.gz]''' - [http://springrts.com/dl/spring_0.82.3_src.tar.gz {mirror}]

= Other springrts.com hosted projects =
== TASClient ==
An alternative windows only lobby client.

'''[http://springrts.com/dl/tasclient/TASClientLatest.7z Download TASClient]'''

== Lobby server==
If you do not want (or are unable) to use the public lobby server, you can download the server software here to run your own. See the readme '''[http://springrts.com/dl/tasserver_readme.txt here]'''.

'''[http://springrts.com/dl/TASServer.jar Click here to download]''' 100.7kb, added 2008-03-02 (requires Java Runtime Environment)

== SelectionEditor ==
Sources are in the [[#git|main git tree]] under "/tools/SelectionEditor/".

'''[http://springrts.com/dl/SelectionEditor.zip Click here to download (windows only)]'''
__NOTOC__

Download

2010-09-02T22:47:23Z

Aegis: /* Spring Engine Updates */

{{#css:
#content * {font-family: 'Bitstream Vera Sans', 'Trebuchet MS', 'Arial', 'Myriad Pro', 'FreeSans';}
}}
= Downloads =
<center>
{|style="margin-top: 15px; padding: 10px; background:rgba(45,180,19,0.5); border: 1px solid rgba(0,0,0,0.5); border-radius: 6px 6px 6px 6px; box-shadow: 0 2px 6px rgba(0,0,0,0.3), inset 0 1px 2px rgba(255,255,255,0.5), inset 0 10px 8px rgba(255,255,255,0.3);" |
| If you just want to get ready to play, you want this:
|-
| style="margin-top: 15px; text-align: center" | [[GamesDownloads|Games Downloads]]
|}
</center>

= Spring Engine Updates =
Latest stable version is: '''0.82'''

{|
| style="padding-right:10px"| [[Image:Window.png]]
| '''Installer: [http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.3/spring_0.82.4.exe/download spring_0.82.4.exe ~18MB]''' - [http://springrts.com/dl/spring_0.82.4.exe {mirror}]''' 

|}

{|
| style="padding-right:10px"| [[Image:Tux-G2.pngâ€Ž]]
| follow the '''[[SetupGuide|Linux Setup guide]]'''
|}

{|
| style="padding-right:10px"| [[Image:Apple.png]]
| ''' ''No download yet'' '''
The Mac OS X port is rough and unfinished. Help with its development would be greatly appreciated. More information on the current state of this port can be found '''[[Spring_on_MacOSX|here]]'''.
|}

= Testing/Nightly Builds =
Used for testing latest engine developments.
[http://springrts.com/dl/buildbot/ list of all test builds]

= Source Code =
== git ==
'''[http://github.com/spring/spring Spring project page at github]''' [http://status.github.com (status page)]
=== Getting the Source ===
<code><pre>git clone git://github.com/spring/spring.git</pre></code>
This however gives you the bleeding edge, if you want to play online then run:
<code><pre>git checkout 0.82.3</pre></code>
from within the source directory. This will provide the correct source code
=== Alternate git url ===
<code><pre>git://springrts.git.sourceforge.net/gitroot/springrts/springrts</pre></code>

== Latest Stable Snapshot ==
This tarball is the same as that used to build the last public release. See [[Building spring]] for build instructions.

The packages below target Linux only and do not contain certain files required to compile using CMake on Windows.

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.3/spring_0.82.3_src.tar.lzma/download Source .tar.lzma]''' - [http://springrts.com/dl/spring_0.82.3_src.tar.lzma {mirror}]

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.82.3/spring_0.82.3_src.tar.gz/download Source .tar.gz]''' - [http://springrts.com/dl/spring_0.82.3_src.tar.gz {mirror}]

= Other springrts.com hosted projects =
== TASClient ==
An alternative windows only lobby client.

'''[http://springrts.com/dl/tasclient/TASClientLatest.7z Download TASClient]'''

== Lobby server==
If you do not want (or are unable) to use the public lobby server, you can download the server software here to run your own. See the readme '''[http://springrts.com/dl/tasserver_readme.txt here]'''.

'''[http://springrts.com/dl/TASServer.jar Click here to download]''' 100.7kb, added 2008-03-02 (requires Java Runtime Environment)

== SelectionEditor ==
Sources are in the [[#git|main git tree]] under "/tools/SelectionEditor/".

'''[http://springrts.com/dl/SelectionEditor.zip Click here to download (windows only)]'''
__NOTOC__

Lobby Development

2010-07-10T07:48:29Z

Aegis: /* UberServer */

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Lobby client development=
There are currently three working public lobby clients available, and two in development.
==Springlobby==
Springlobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It is a cross platform C++ project and uses the wxWidgets library. You can browse the sources and submit issues on its [http://springlobby.info/ website].
==TASClient==
TASClient is a Windows-only project in Delphi. You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here: http://springrts.com/dl/tasclient/TASClientLatest.7z Contact Satirik on the lobby itself or on the forum to get help.

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

==QtLobby==
Qt lobby is currently the fastest lobby available and is very stable. It is cross platform, programmed in C++ and uses the Qt library. Use its [http://code.google.com/p/qtlobby/ project page] to post issues, download or browse the sources.

=Lobby server development=
==Protocol==
[http://springrts.com/lobby/protocol/ProtocolDescription.xml Protocol Documentation]
==TASServer==
The current lobby server is old and only lightly maintained. It is a java project created by Betalord, using php for admin interface. You can fetch the sources through git. Details can be found on the [http://github.com/spring/TASServer development site].

==UberServer==
UberServer is a Python project made by aegis. You can [http://cgit.springlobby.info/cgit/aegis/uberserver.git/ browse the sources] or download them using its git repository (git://springlobby.info/git/aegis/uberserver.git). You can also contact aegis on the forum or the lobby to get more information.

[[Category: Lobbies]]

Lobby Development

2010-06-22T00:46:15Z

Aegis:

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Lobby client development=
There are currently three working public lobby clients available, and two in development.
==Springlobby==
Springlobby is the official lobby client of spring and is bundled with the Spring engine in the installer. It is a cross platform C++ project and uses the wxWidgets library. You can browse the sources and submit issues on its [http://springlobby.info/ website].
==TASClient==
TASClient is a Windows-only project in Delphi. You can download the sources from the [http://springrts.com/svn/spring/Lobby/TASClient/ subversion repository] (svn://springrts.com/svn/spring/Lobby/TASClient/) and browse them on the [http://springrts.com/websvn/listing.php?repname=Spring&path=%2FLobby%2FTASClient%2F#_Lobby_TASClient_ websvn]. Latest binary version is always available here: http://springrts.com/dl/tasclient/TASClientLatest.7z Contact Satirik on the lobby itself or on the forum to get help.

[http://springrts.com/phpbb/viewtopic.php?f=12&t=18999 How to compile TASClient]

[http://springrts.com/phpbb/viewtopic.php?f=14&t=19014 How to customize TASClient]

==QtLobby==
Qt lobby is currently the fastest lobby available and is very stable. It is cross platform, programmed in C++ and uses the Qt library. Use its [http://code.google.com/p/qtlobby/ project page] to post issues, download or browse the sources.

=Lobby server development=
==Protocol==
[http://springrts.com/lobby/protocol/ProtocolDescription.xml Protocol Documentation]
==TASServer==
The current lobby server is old and only lightly maintained. It is a java project created by Betalord, using php for admin interface. You can fetch the sources through git. Details can be found on the [http://github.com/spring/TASServer development site].

==UberServer==
UberServer is a Python project made by aegis. You can [http://cgit.springlobby.info/aegis/uberserver.git/ browse the sources] or download them using its git repository (git://springlobby.info/git/aegis/uberserver.git). You can also contact aegis on the forum or the lobby to get more information.

[[Category: Lobbies]]

LuaCallinReturn

2010-03-17T18:55:46Z

Aegis:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

===Lua Call-Ins, with parameters===

''Here are the known reserved parameter values for all Lua Call-Ins. If you add new Call-Ins to Spring, please document them here.''

==Commands, general-purpose:==

Shutdown() --> none.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button"

MouseRelease() --> "x, y, button"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitCreated() --> "unitID, unitDefID, teamID" ... I hope that's self-explanatory

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID, attackerID?"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams"

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag"

==Drawing:==

* DrawGenesis() --> none. Don't render here.

* Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

* Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

* Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GamePreload() --> none.

GameStart() --> none.

GameOver() --> none.

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID"

ProjectileDestroyed() --> "proID"

[[category: Lua]]

Download

2009-09-05T09:24:35Z

Aegis: /* Lobby server */

=Spring RTS Engine=

On this page you will find information on how to download the latest releases from the Spring project for various platforms.

==Windows==

=== Game installers (for players) ===

As Spring itself is just an engine and does not contain game content, we advise you to go to the website of the game you want to play for an all inclusive installer, however, you can use the "Spring Engine + Module Updater" installer. This installer will install the Spring Engine and the Spring Module Updater which contains a menu that lists many of the games available for the Spring Engine. Simply select which game you would like to install and it will download and install the game for you:

'''[http://springinfo.info/moddownloads/SpringEngine-Installer.exe Spring Engine + Spring Module Updater]'''

'''[http://springinfo.info/moddownloads/SpringModuleUpdater.exe Spring Module Updater (Standalone Installer)]'''

'''Below are some of the download pages of games using the Spring engine:'''

'''[http://www.evolutionrts.info/wordpress/?page_id=16 Evolution RTS]'''

'''[http://springfiles.com/1683 Kernel Panic]'''

'''[http://spring1944.net/downloads.php Spring 1944]'''

For more Spring games, check out the [[Games]] page. Please note that some of them will require you to have the engine installed in order to work, as they don't come with their own installer.

=== Engine installer (Bare Bones Installer) ===

'''[http://sourceforge.net/projects/springrts/files/springrts/spring-0.80.4.1/spring_0.80.4.1.exe/download Click here to download ]''' version 0.80.4.1 ~21MB, added 2009-09-04

'''[http://springrts.com/dl/spring_0.80.4.1.exe Backup in case the above doesn't work ]''' version 0.80.4.1 ~21MB, added 2009-09-04

As all Spring-based games don't have their own installer, the engine installer can also be used by players to play other games.
This installer provides the core files for Spring, the multiplayer lobby client and the autodownloader. Use the autodownloader to get maps and games, or download them from some hosting sites (listed in the lobby #main channel).


'''[http://springrts.com/dl/spring_0.80.4.7z Portable archive]'''

'''[http://buildbot.eat-peet.net/spring/executable/%5bMT%5d0.80.4-spring_exe_0.80.4-0-ga0534a8.zip Experimental Multithreading executable ]''' version 0.80.4, added 2009-08-31 ~3MB. Unzip to your installation folder. Does not work with all mods. '''[http://buildbot.eat-peet.net/spring/executable/%5bMTDEBUG%5d0.80.4-spring_exe_0.80.4-0-ga0534a8.zip Debug version ]'''



=== Nightly Builds (for developers/testers) ===

'''[http://buildbot.eat-peet.net/spring/installer/ click here for a list of test builds (only for testing purposes)]'''

==[[image:200px-Tux.svg.png|Linux|30px]] Linux==

The '''[[SetupGuide|Linux set up guide]]''' provides set up information for various Linux distributions.

Please note that due to the amount of distributions out there, we cannot provide binary packages for each of them. If yours is not listed there, you most likely need to build it yourself. If you do so, please share your results with others.

==Mac OS X==

Sorry no download yet.
The Mac OS X port is rough and unfinished. Help with its development would be greatly appreciated. More information on the current state of this port can be found '''[[Spring_on_MacOSX|here]]'''.

----

=Source Code=
{{Obtaining_The_Source_Code}}

=== Building instructions ===
If you want to compile it yourself, see [[Building_spring]] for some tips.

=Lobby server=

If you do not want (or are unable) to use the public lobby server, you can download the server software here to run your own. See the readme '''[http://springrts.com/dl/tasserver_readme.txt here]'''.

'''[http://springrts.com/dl/TASServer.jar Click here to download]''' 100.7kb, added 2008-03-02 (requires Java Runtime Environment)

Mapdev:SMD

2009-08-31T18:38:44Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== SMD Syntax ==
The SMD, to work correctly, must be set out correctly. The following are a few of these requirements that you have to follow:
*All lines must end in a ';'. This is just like any C derived programming language
*Sections begin with a keyword wrapped in [Square brackets], and are wrapped in {Curly Brackets}
*Each different tag must be placed on a different line (?)

The following are some recomendations to help other people read your SMD.
*Blank lines are allowed, and can be placed to help distinguish between different sections
*You may place comments in the SMD, and again like C programming languages, these are preceded by a '//'. Anything following a comment marker is ignored by the parser.
*You can tabulate your SMD to help the overall readability, and to show where sections begin and end.

== Example SMD ==

[MAP]
{
Description=Lot of metal in middle but look out for kbot walking over the mountains;
TidalStrength=20;
Gravity=130;
MaxMetal=0.03;

ExtractorRadius=400;
MapHardness=100;

[SMF]
{
minheight = -135;
maxheight = 265;
}
[ATMOSPHERE]
{
FogColor=0.7 0.7 0.8;
FogStart=0.2;

CloudColor=0.9 0.9 0.9;
SkyColor=0.1 0.15 0.7;

SunColor=1.0 1.0 1.0;
CloudDensity=0.55;

MinWind=5;
MaxWind=20;
}
[WATER]
{
WaterBaseColor=0.4 0.6 0.8;
WaterAbsorb=0.004 0.004 0.002;

WaterMinColor=0.1 0.1 0.3;
}
[LIGHT]
{
SunDir=0 1 2;

GroundAmbientColor=0.4 0.4 0.4;
GroundSunColor=0.7 0.7 0.7;

GroundShadowDensity=0.8;

UnitAmbientColor=0.3 0.3 0.3;
UnitSunColor=0.8 0.8 0.8;
UnitShadowDensity=0.8;

}
[TEAM0]
{
StartPosX=600;
StartPosZ=600;
}
[TEAM1]

{
StartPosX=3600;
StartPosZ=3600;
}
[TEAM2]
{
StartPosX=3600;
StartPosZ=600;
}
[TEAM3]
{
StartPosX=600;
StartPosZ=3600;

}
[TEAM4]
{
StartPosX=2000;
StartPosZ=600;
}
[TEAM5]

{
StartPosX=2000;
StartPosZ=3600;
}
//Up to [TEAM9]
[TERRAINTYPE0]
{
name=default;
hardness=1;
tankmovespeed=1;
kbotmovespeed=1;
hovermovespeed=1;
shipmovespeed=1;

}
}

== SMD Tags List ==
<table border="1">
<tr>
<th valign="top" bgcolor="#C0C0C0">Variable</th>
<th valign="top" bgcolor="#C0C0C0">Description</th>
<th valign="top" bgcolor="#C0C0C0">Examples</th>
</tr>
<tr>
<td valign="top">'''[TEAM''X'']'''</td>
<td valign="top">The number of the team, starting at 0 for player 1 and going on up to 9 for player 10, where ''X'' is the player number</td>
<td valign="top">[TEAM3]</td>
</tr>
<tr>
<td valign="top">'''[TERRAINTYPE''X'']'''</td>
<td valign="top">Used to define different terrain types that exist on the map. The value starts at 0 and goes on for as many terrain types as you have, where ''X'' is the type number. Which terrain type goes where on the map is determined by the typemap when compiling the map. For example, if the typemap has an area of red 128, then the corresponding terraintype tag is [TERRAINTYPE128] </td>
<td valign="top">[TERRAINTYPE0]</td>
</tr>

<tr>
<td valign="top">'''CloudColor'''</td>
<td valign="top">The color of the clouds. The values are in the order Red, Green, Blue. For all intensive purposes, 0.0 is black and 1.0 is white; however, giving values higher than 1.0 will give brighter fog and less than 0.0 will give darker.</td>
<td valign="top">CloudColor=0.9 0.9 0.9;</td>
</tr>
<tr>
<td valign="top">'''CloudDensity'''</td>

<td valign="top">The number of clouds in the sky. A percentage in decimal form, 0.0 to 1.0.</td>
<td valign="top">CloudDensity=0.55;</td>
</tr>
<tr>
<td valign="top">'''Description'''</td>
<td valign="top">The description of the map that shows in the multiplayer battleroom.</td>
<td valign="top">Description=Strong wind, good for 2v2 team games;</td>

</tr>
<tr>
<td valign="top">'''ExtractorRadius'''</td>
<td valign="top">The radius of effect that a single extractor will extract from. If two radii intersect, both extractors will suffer from reduced output.</td>
<td valign="top">ExtractorRadius=400;</td>
</tr>
<tr>

<td valign="top">'''GroundAmbientColor'''</td>
<td valign="top">The ambient (non-sun-lit) color of ground, grass, trees and other features.</td>
<td valign="top">GroundAmbientColor=0.4 0.4 0.4;</td>
</tr>
<tr>
<td valign="top">'''GroundShadowDensity'''</td>
<td valign="top">How far from the non shadowed to the ambient color stuff in shadow will go.</td>

<td valign="top">GroundShadowDensity=0.8;</td>
</tr>
<tr>
<td valign="top">'''GroundSunColor'''</td>
<td valign="top">The color of ground where it is fully sun lit (added to GroundAmbientColor).</td>
<td valign="top">GroundSunColor=0.7 0.7 0.7;</td>

</tr>
<tr>
<td valign="top">'''FogColor'''</td>
<td valign="top">The color of the fog and the infinite plane below the world. The values are in the order Red, Green, Blue. For all intensive purposes, 0.0 is black and 1.0 is white; however, giving values higher than 1.0 will give brighter fog and less than 0.0 will give darker.</td>
<td valign="top">FogColor=0.7 0.7 0.8;</td>
</tr>
<tr>

<td valign="top">'''FogStart'''</td>
<td valign="top">The distance from the camera at which the fog will start.</td>
<td valign="top">FogStart=0.2;</td>
</tr>
<tr>
<td valign="top">'''Hardness (terraintype)'''</td>
<td valign="top">Used as a multiplier against the MapHardness value. Can be used to make a particular terrain type softer or harder. A value of '1' will make it as hard as MapHardness, and 0.5 will make it half as hard.</td>

<td valign="top">hardness=0.75;</td>
</tr>
<tr>
<td valign="top">'''HoverNoveSpeed'''</td>
<td valign="top">Speed multiplier for hovercraft when travelling on the parent terrain type. A value of '1' is normal speed, 0.5 will make them travel at half speed on the parent terrain type.</td>
<td valign="top">hovermovespeed=1;</td>
</tr>

<tr>
<td valign="top">'''KbotMoveSpeed'''</td>
<td valign="top">Speed multiplier for Kbots when travelling on the parent terrain type. A value of '1' is normal speed, 0.5 will make them travel at half speed on the parent terrain type.</td>
<td valign="top">kbotmovespeed=1;</td>
</tr>
<tr>
<td valign="top">'''MapHardness'''</td>
<td valign="top">Defines how much the terrain will deform due to explosions and weapons.</td>
<td valign="top">MapHardness=100;</td>
</tr>
<tr>
<td valign="top">'''MaxMetal'''</td>
<td valign="top">How much metal a map square with the maximum metal value gives. Unsure how this is calculated, but a value of around 0.03 will give OTA-esque levels of metal from metal extractors.</td>
<td valign="top">MaxMetal=0.03;</td>

</tr>
<tr>
<td valign="top">'''MaxWind'''</td>
<td valign="top">The maximum amount of energy the wind on the map will give.</td>
<td valign="top">MaxWind=20;</td>
</tr>
<tr>

<td valign="top">'''MinWind'''</td>
<td valign="top">The minimum amount of energy the wind on the map will give.</td>
<td valign="top">MinWind=5;</td>
</tr>
<tr>
<td valign="top">'''Name (terraintype)'''</td>
<td valign="top">Used to define the name of the type of terrain. "Snow" or "Rock" or whatever you want.</td>
<td valign="top">Name=default;</td>
</tr>
<tr>
<td valign="top">'''ShipMoveSpeed'''</td>
<td valign="top">Speed multiplier for Ship when travelling on the parent terrain type. A value of '1' is normal speed, 0.5 will make them travel at half speed on the parent terrain type.</td>
<td valign="top">shipmovespeed=1;</td>
</tr>

<tr>
<td valign="top">'''SkyColor'''</td>
<td valign="top">The color of the sky itself. Works the same way as CloudColor and FogColor.</td>
<td valign="top">SkyColor=0.1 0.15 0.7;</td>
</tr>

<tr>
<td valign="top">'''StartPosX'''</td>
<td valign="top">The X (east-west in the TA camera) coordinates on the map where the player will start.</td>
<td valign="top">StartPosX=600;</td>
</tr>
<tr>
<td valign="top">'''StartPosZ'''</td>

<td valign="top">The Z (north-south in the TA camera) coordinates on the map where the player will start.</td>
<td valign="top">StartPosZ=600;</td>
</tr>
<tr>
<td valign="top">'''SunColor'''</td>
<td valign="top">The color of the sun in the sky. This will also effect the size of the star. As the value increases (including over 1.0), the disc will get bigger; the inverse is also true.</td>
<td valign="top">SunColor=1.0 1.0 1.0;</td>

</tr>
<tr>
<td valign="top">'''SunDir'''</td>
<td valign="top">The direction of the sun, which is normalized by Spring. The Y-axis is up. Here's a basic chart for values:
<center>
<table border="1" width="210px" align="center">
<tr height="70px">
<td width="70px">1 .5 -1</td><td width="70px">0 .5 -1</td><td width="70px">-1 .5 -1</td>
</tr>
<tr height="70px">
<td>1 .5 0</td><td>0 1 0</td><td>-1 .5 0</td>
</tr>
<tr height="70px">
<td>1 .5 1</td><td>0 .5 1</td><td>-1 .5 1</td>
</tr>
</table>
</center>
</td>
<td valign="top">SunDir=0 1 2;</td>
</tr>

<tr>
<td valign="top">'''TankMoveSpeed'''</td>
<td valign="top">Speed multiplier for tanks when travelling on the parent terrain type. A value of '1' is normal speed, 0.5 will make them travel at half speed on the parent terrain type.</td>
<td valign="top">tankmovespeed=1;</td>
</tr>
<tr>
<td valign="top">'''TidalStrength'''</td>
<td valign="top">The amount of energy which will be given by tidal generators.</td>
<td valign="top">TidalStrength=30;</td>
</tr>
<tr>
<td valign="top">'''UnitAmbientColor'''</td>
<td valign="top">The ambient (non-sun-lit) color of units and corpses.</td>
<td valign="top">UnitAmbientColor=0.3 0.3 0.3;</td>

</tr>
<tr>
<td valign="top">'''UnitShadowDensity'''</td>
<td valign="top">How far from the non shadowed to the ambient color stuff in shadow will go.</td>
<td valign="top">UnitShadowDensity=0.8;</td>
</tr>
<tr>

<td valign="top">'''UnitSunColor'''</td>
<td valign="top">The color of units where they is fully sun lit (added to UnitAmbientColor).</td>
<td valign="top">UnitSunColor=0.8 0.8 0.8;</td>
</tr>
<tr>
<td valign="top">'''WaterAbsorb'''</td>
<td valign="top">How fast different colors (RGB in order) are absorbed by the water. Can be used to make the water look murky at deeper sections and so on. How this works: the waterabsorb value for the color channel gets multiplied by the depth of the water at a point, and this product gets subtracted from ''WaterBaseColor'', until ''WaterMinColor'' is reached. Example: ''WaterAbsorb'' is 0.01, for the red channel, and we want to know how much red will be left in the water at a Spring elevation of -100, since 0.01*100= 1 , at this depth, there will be no more red component in the water, unless ''WaterMinColor'' is higher than 0 on the red channel.</td>
<td valign="top">WaterAbsorb=0.004 0.004 0.002;</td>
</tr>
<tr>
<td valign="top">'''WaterBaseColor'''</td>
<td valign="top">The color of the water just beneath the surface plane. This is the starting color from which deeper waters will absorb more color.</td>
<td valign="top">WaterBaseColor=0.4 0.6 0.8;</td>

</tr>
<tr>
<td valign="top">'''WaterMinColor'''</td>
<td valign="top">The smallest values the water will go down to due to WaterAbsorb.</td>
<td valign="top">WaterMinColor=0.1 0.1 0.3;</td>
</tr>
<tr>
<td valign="top">'''WaterPlaneColor'''</td>
<td valign="top">This set the color of the groundplane under the water outside the map boundaries</td>
<td valign="top">WaterPlaneColor = 0.75 0.8 0.85; </td>

</tr>
<tr>
<td valign="top">'''WaterSurfaceColor'''</td>
<td valign="top">The color of the water surface. Mostly affects the colors of the reflections off the top of the water. Does''' NOT''' effect bumped water!</td>
<td valign="top">WaterSurfaceColor = 0.75 0.8 0.85; </td>

</tr>
<tr>
<td valign="center">
== Bump mapped water SMD tags.==
''' These tags only affect bump mapped water and dont affect the other types. '''
</td>
</tr>

<tr>
<td valign="top">'''WaterSurfaceAlpha'''</td>
<td valign="top">Transparency of the water surface. 0 meaning almost fully transparent water plane(low amount of reflections visible), and 1 being nearly opaque (massive amount of reflections). Default=0.55</td>
<td valign="top">WaterSurfaceAlpha = 0.55; </td>
</tr>

<tr>
<td valign="top">'''WaterDiffuseColor'''</td>
<td valign="top">This specifies the diffuse color of the water body. '''WARNING''': use of this tag disables the effect of ''WaterAbsorb'' , in fact, this tag does nothing but disable WaterAbsorb. Avoid.</td>
<td valign="top">WaterDiffuseColor = 0.55 0.4 0.3; </td>

</tr>
<tr>

<td valign="top">'''WaterSpecularColor '''</td>
<td valign="top">WaterSpecularColor = groundSunColor - Altering this tag does not seem to have any effect at all.-</td>
<td valign="top"> //WaterSpecularColor = 0.55 0.4 0.3; </td>

</tr>
<tr>

<td valign="top">'''WaterSpecularPower '''</td>
<td valign="top"> -no clue-'''WARNING''': use of this tag disables the effect of ''WaterAbsorb'' </td>
<td valign="top">WaterSpecularPower = 2.0; </td>

</tr>
<tr>

<td valign="top">'''WaterSpecularFactor '''</td>
<td valign="top"> -no clue-</td>
<td valign="top">WaterSpecularFactor = 0.3; </td>

</tr>
<tr>

<td valign="top">'''WaterAmbientFactor '''</td>
<td valign="top"> -no clue-</td>
<td valign="top">WaterAmbientFactor = 1.3; </td>

</tr>
<tr>

<td valign="top">'''WaterDiffuseFactor '''</td>
<td valign="top"> -no clue-</td>
<td valign="top">WaterDiffuseFactor = 0.3; </td>

</tr>
<tr>

<td valign="top">'''WaterFresnelMin'''</td>
<td valign="top">I have no clue what the WaterFresnel tags do, someone with more knowlegde edit this page please.(0.0<x<=1.0)</td>
<td valign="top">WaterFresnelMin = 0.3; </td>

</tr>
<tr>

<td valign="top">'''WaterFresnelMax'''</td>
<td valign="top">(<1-WaterFresnelMin)</td>
<td valign="top">WaterFresnelMax = 0.8; </td>

</tr>
<tr>

<td valign="top">'''WaterFresnelPower'''</td>
<td valign="top">-no clue-</td>
<td valign="top">WaterFresnelPower = 4; </td>

</tr>
<tr>

<td valign="top">'''WaterReflectionDistortion'''</td>
<td valign="top">How much the surface should distort reflections that are cause by waves not being level: ergo it adds more choppyness to your reflections sensible from 0 to 20</td>
<td valign="top">WaterReflectionDistortion = 0.1; </td>

</tr>
<tr>

<td valign="top">'''WaterBlurBase'''</td>
<td valign="top">Something to do with blur, but it just seems to cause banding with values under 2 and corruption with values above 10</td>
<td valign="top">WaterBlurBase = 2; </td>

</tr>
<tr>

<td valign="top">'''WaterBlurExponent'''</td>
<td valign="top">How much reflections on water surface should be blurred together with the water surface, lower values meaning clearer reflections, (0.2-5) Warning: above 5 seems to cause water corruption</td>
<td valign="top">WaterBlurExponent = 2; </td>

</tr>
<tr>

<td valign="top">'''WaterPerlinStartFreq'''</td>
<td valign="top">Wave sizes, smaller = big waves, sensible: 1-20 (influence the wave sizes) default=8</td>
<td valign="top">WaterPerlinStartFreq = 8; </td>

</tr>
<tr>

<td valign="top">'''WaterPerlinLacunarity'''</td>
<td valign="top">new, any float; seems to define the size of the perlin waves, small values being big waves (0.2-5 is sensible) default= 3</td>
<td valign="top">WaterPerlinLacunarity = 3; </td>
</tr>
<tr>

<td valign="top">'''WaterPerlinAmplitude'''</td>
<td valign="top">Base stillness of water surface, 0 is dead still, 1 is 'windy' .This doesnt affect the bump texture depth, besides the fact that this disables the bump texture when set to 0 default=0.9 </td>
<td valign="top">WaterPerlinAmplitude= 0.9; </td>

</tr>

</table>

Tutorial:MapDesignHelp(IceXuick)

2009-08-31T18:34:34Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

'''How to build a map'''

Hello, welcome to the IceXuick map Design help. On this wiki page i will try to make a complete and organized 'topic' how to build a map, from A-Z. Tips, add-ons or other suggestions are always welcome. OKAY.

'''What do you need:''' 

First of all i'll sum up the thing you need:

- Photoshop / Gimp (or other image editor) 
- Bryce / L3dT (optional, if you don't want a great looking texture) 
- Mothers MapConv (map converter program) 
- Patience & passion 

If you have most of these things, you can start thinking about the map you want to make. It is very smart to make sketches of your map, before creating it. Try to design the map, so that in your 'mind' it could play well. Think of possible problems as porcing probabilities, turtling, strategic important places, but also metal layouts, geo-vent locations, and maybe even feature-placement.

'''What are you going to make:''' 

Well, how much different things you might have read, these are the things i use, and work very well, so i suggest you use this, and nothing else :). To know how big your map will be, the factor is 512 times the TA:S size: here are some (total)map sizes and corresponding dimensions:

'''TA Spring ---- Actual Pixels''' 
32 x 24 ------ 16384 x 12288 
16 x 12 ------ 8192 x 6144 
8 x 4 -------- 4096 x 2048 
 

This is the best order in which you should work: 
 

- '''Heightmap''' ... bmp 24-bit - 1/8 +1 of Total map size 
- '''Metalmap''' ..... bmp 24-bit - 1/8 +1 of Total map size 
- '''Featuremap''' .. bmp 24-bit - 1/8 of Total map size 
- '''Typemap''' ...... bmp 24-bit - 1/16 of Total map size 
- '''TestTexture''' .. bmp 24-bit - Total map size 
- '''Compiling''' ..... your maps with Mothers MapConv 
- '''SMD file''' ........ script of all kinds of things, including atmosfear, colors of sky and water, fog settings, but more important, metaloutput, winds, tidal, start locations and terraintypes. 
- '''Test Phase''' ... debug your map a much as possible 
- '''Texturemap''' .. bmp 24-bit - Total map size 

 

'''The Heightmap:''' 

Here are in following order the things that are to be done: 

- roughly outlining large mountains/valleys 
- go deeper into detail by lowering size of drawing brush 
- finalize details with 15px brush (in Photoshop) 
- make slopes/passages on your map with smudge/blur tools 
- Texturemap - bmp 24-bit - Total map size 
 

The heightmap is one the the most important things you make for a map, and therefor i always start with it. After you have drawn your concept of your map (sketches) you may want to digitize them (if you don't already have that) and you should think which mapsize would be best. If you want your map to be a 8x8 map you should (first) also make the heightmap this size. By doing so, you can use Bryce or L3dT to render your texture at the highest possible quality. 
 

So you now are going to start working in Photoshop (or other image program). Try to remake your sketch by drawing different shades of grey. White is the highest (255) and black (0) is the lowest. You can start drawing roughly, to outline every hill or valley. After that, try and go deeper into detail, and finally use a brush size of 15px in Photoshop for the final details. 
 

To make your map work for all the units, it should have passable slopes and passages: use a 'Smudge'-tool (optionally also Blur-tool). A lot of programs have this, so you should be able to figure it out. For every slope or passage that needs to be passable, the gradient from the lowest to the brightest color of that slope should be as smooth as possible. You need to get the feel of the smudge-tool in Photoshop, but after a while you'll get the hang of it. Also try to make slopes that have a big difference in highest and lowest point, long and smooth. 
 

When you think everything is smooth and detailed, save that image as FullHeight.bmp, at the same size as the Total Map. After that, scale down this file to 1/8th of the size of the Total map, +1 pixel (x and y), and save this one as Height.bmp 
 

'''The Metalmap:''' 
 

Okay, for playtesting value, you can now make your metal map. This is at first quite simple, and easily done, but the placement and balance is very hard. You can only try and think of good locations, and the output should be 15 metal per player (non-moho), if they have their part of the map (on a four player map, this would be 1/4th of the map)

In Photoshop, make another layer onto your heightmap, and put metal places around the map. Use a 6 or 8px '''PENCIL''' for the metal patches, and paint with red 255 (make sure there is no antialiasing, so that every pixel is RED 255.

When done, you can save this file as Metal.bmp (1/8th of Total map size +1). 
 

'''The Featuremap:''' 
 

In the featuremap you can place Geo-vents, Trees, grass, and extra features like rocks, palms, energy spires. You need to have these 'extra' features, later to be compiled within the map. Geo's, tree's and grass will work automatically. For the extra features, you need to get the whole pack, which consists of a couple of maps with files for the model, the texture and the script. Check the "maps" forum for features that were created. 
 

'''Geo's''' are represented by '''GREEN''' (255), single pixels. Every green (255), pixel will (most likely) be compiled as a geo-vent. 
 
The shades 200-215 of GREEN are different '''Tree-types'''. Remember to use 1 single pixel for tree's as well. 200-206 seem to be coniferous tree, 207-215 seem to be decidious. 
 
'''BLUE''' represents the ammount of '''Grass''' to be placed, where black means none, and BLUE (255) means full spreading of grass) 
 
Than Last but not least, '''RED''', for the '''Features'''. In the FS.txt file (that comes with Mothers MapConv, you can list all your features, that you want to use. The first feature that is listed in this file, will be represented as RED 255. The second feature will be RED 254, the third RED 253, and so on. Also features will need only one pixel. 
 
Try to make sure that no one of those pixel are next to each other within 4-5 pixels. This may crash during compiling, or gives strange results in-game. 
 

'''The Typemap:''' 
 

Okay, the Typemap, also known as the TerrainType map, let'a you set the '''terrain name''', the unit categories '''speed multipliers''', and also the '''hardness multiplier'''. This map works again with RED only. Every Shade of RED can be set in the SMD file, on which i'll return later on. The Typemap that worked for me is '''NOT''' the same as the height- and metalmap, but is '''1/16th''' of the Total Map size. 
 
So an 8x8 map is Total 4096 x 4096 pixels. If we then do the math: 4096 /16 = 256. (otherwise there will be a default terraintype (that you did not set) between different terraintypes, and this can be very annoying) 
 

Draw your 'terrain' onto your heightmap (make sure you again use the '''PENCIL''' mode, without antialiasing around your pixels), and save it as a BMP in 1/16th of the Total Map size (Typemap.bmp). 
 

'''Test Texture:''' 
 

You need to have a 'test'-texture in order to compile, so you can simply make a big grey image, that has the '''right dimensions''' (for 16x16 it will be 8192x8192). Save this as Texture.bmp 
 

'''Compiling your map:''' 
 

Before rendering your final, huge, super shweet texture, you want to know if your map plays okay, and that's why we first going to compile the map: 
 
- how is the heightmap, '''check it for all units''' if everything works 
- is the metal placing and spacing okay? are there spots on slopes or unbuildable terrain, or unreachable. 
- are the geo's working, and also well placed (no clusters of geo's?) 
- do units move quite right, or do they get stuck all the time 
- how is the water level (if there is any) 
- are the starting locations allright? 
- maybe you already want to check the other features, as grass, trees or extra's? 
 

Therefor, we are going to compile this thing first, to check all these things in-game. This will save you numerous re-renderings. And changes in the heightmap after the render, is '''NOT''' recommended. Esspecially for the people that play in '''TA-cam mode''', because they have to be able to tell from above what the terrain is like. 
 

Okay, if you did all of the above, and did it perfect, than this will be your first and second last compile... but trust me, you will compile a '''couple of times''' more, if you want the map to play well! 
 

Although there is a mapcompiler in the works as i type this, for now we need to do it the old fashioned way, by DOS. 
 

Unpack the files of '''Mothers MapConv''' into your directory with all your previously saved files. '''Make sure''' that all the (sub-)directories to this location '''DON'T have SPACES''' in them! After this being said, you will need to go to DOS mode. 
 
In Windows, go to "start", and then "run", and type 'cmd' (without the quotes). This will bring up the commandline prompt. Navigate to your directory in which all bmp's and Mothers Mapconv are located. I ain't gonna explain how you navigate is DOS, if you got this far, you probably know your way around with computers. 
 

Once in the right directory/folder, type 'MapConv --help' for a explaination of all parameters. This is not nescesary if you use it as following: 
 

'''MapConv -f Features.bmp -i -l -c 0.5 -x 300 -n -150 -o YourMapName.smf -y Typemap.bmp -m Metal.bmp -a Height.bmp -t Texture.bmp''' 
 

This line will compile your map will the above created files, and compresses it only half (normal compression is 0.8), what will leave a bit more of your original texture in tact, however your filesize will be higher. 
 
* The -i -l commands are nescesary. 
* The 0.5 compression can be altered to 0.8 or for high quality to 0.2 or 0.3 
* the -x is the maximum height and -n the, yes, minimum 
 

To get the water level right you can '''calculate the best values''' for the max. and min. height. Check your height.bmp and look which grey value you like to be the surface of the water (darker is submerged, higher is land). If this is grey 80, than you know that 80/(255/100) = 31.4% should be submerged. Depending on what total height you want to use, be sure that the zero-0-point (which is the water level) is at 31.4%. So if you want around 600 height difference in total, then you should use -x 412 -n -188 (you may do the math yourself). This should get near the water altitude that you want. Otherwise recompile and test again! 
 

If all went well, you should now have '''4 new files''' in that same directory. 
 
* '''mini.bmp''' - absolete, you don't need this. 
* '''mini.dds''' - needed for minimap 1024x1024 (texture in DirectX format DTX1) 
* '''YourMapName.smf''' - Feature file 
* '''YourMapName.smt''' - Texture file 

Now you have the basic files that TA:Spring can read, BUT you need to ''''sd7'''' them. SD7-ing kind of 'zips' these files into 'one map-zip-file-archive'. How you do this, is quite important. 
 
First make a '''new''' sub-directory, i always name it after the version, so 'v01' wil be right. In this directory, you need to make '''another sub-directory''' called 'maps'. In THIS directory, you need to place your .dds, .smf and .smt files. If you have downloaded extra features (with directories included such as 'features', 'objects3d' and 'unittextures') you need to copy them to the 'v01' directory as well, so it's '''next''' to your 'maps' subdirectory, not in the 'maps' dir. Also do '''NOT forget''' to copy your '''fs.txt''' file from your 'edit' directory, into the 'v01' directory. 
 

'''Create or Edit an SMD file:''' 
 

Now you have to create (or copy paste) a .smd file, that will be put next to the other files in the 'maps' sub-directory. I will post the most important stuff needed. You may also use the '''SMD Creator''', which is also available for download somewhere, and quite '''handy for sun direction and colors''', but 'sometimes' a bit buggy when opening and re-saving a file '''(crashes)'''. The most important stuff,'''--''' means that i've deleted something, and the '''//''' + remarks are to be removed: 
 

[MAP] 
{ 
Description=Describe your map shortly, it can be seen in the lobby; 
TidalStrength=10; //Energy that Tidal generators will give. (10-30) 
Gravity=120; //variable, 120-150 is kinda standard, test on map 
MaxMetal=1.2; //metal output rate. <1 is more OTA, >1 is more XTA 
ExtractorRadius=100; // radius of mexxes, 40-50 tiny, '''100 desirable''' 
MapHardness=100; // Global hardness of terrain 100 will deform from shots 
 
[ATMOSPHERE] 
{ 
-- 
MinWind=1; // minimum wind 
MaxWind=25; // max wind, know that a '''average of 10 is almost equal to solar''' 
} 
 
-- 
 
[TERRAINTYPE50] 
{ 
name=SoftTerrain; // name that will be shown in-game on mouse-hover 
hardness=2; // multiplier of Global MapHardness 
tankmovespeed=0.9; // The speed multiplier of the different units 
kbotmovespeed=1; 
hovermovespeed=1; 
shipmovespeed=0; // '''0 means impassable''' 
} 
 
[TEAM0] 
{ 
StartPosX=250; // start x-coord. of player 1 
StartPosZ=250; // start y-coord. of player 1 
} 
[TEAM1] // '''TEAM0 is player 1 and TEAM1 is player 2''' 
{ 
StartPosX=4950; 
StartPosZ=4950; 
} 
 
etc.. 
 

After you are satisfied with all the settings, you can then save this file as 'YourMapName.smd'. PLace it '''next''' to the other YourMapName.* files, in the 'maps' subdirectory, so that there are now '''4 files''' there. 
 

Assuming you have downloaded a '''7z zip program''' (which you can (re)name to .sd7) you then go into your 'v01' directory, and zip all those directories, including the fs.txt file if you use extra features. Three important things: 
 

* name your map 'YourMapName.sd7' and '''NOT else''' (use '''exact''' same name as with compile) 
* Compression can be set to '''ultra''' 
* Dictionary Size = 32 mb 
* Word size = 64 mb 
* do '''NOT''' make it an '''SOLID''' archive 
* Multi-threading, if you like 
 

When this is done, copy 'YourMapName.sd7' into the maps folder of TA Spring, and off you go! '''You can now start your game from within TA:Spring!!''' 
 

'''The Testing Phase''' 
 

Start up your map. If you did everything i told you to, '''it should work'''! The things i always do is build the following units to test the 'pathfinding' and movement areas: 
 
* '''Peewee's''' - k-bot footprint - same movement for all k-bots 
* '''Flashes''' - Tank footpring 
* '''Hover Tank''' - Hover footpring 
* Build '''all metal spots''' with mexxes to check if their location is buildable 
* If watermap, build boats and subs 
* Optionally build exp. bots like Krogoth & Orcone 
 

When you've build these units, select one, and '''press F2'''. You can now see where that unit can go (GREEN), where it will move slow (or fast downhill)(ORANGE), and where it '''CAN'T move'''(RED). This last one is particulary important. Test all units this way, and check the whole map, if some type or more types of units can't go somewhere. If this is so, you need to '''smoothen out that slope''' in your heightmap (and make it probably longer as well, or change the '''heightdifference'''). It can also be that units '''CAN''' pass certain 'ridges' that it weren't supposed to do. You can always do 2 things. '''OR''' you change the '''heightdifference''' (bigger is higher ridges), this is often the easiest way, '''OR''' you '''change your heightmap''', and make it right, what very often is the way to do it best. 
 

Make sure you '''check''' these things as well: 
 

* is the '''water level''' right? 
* How does the water look, do you need to change the colors? 
* How is the '''wind''', do you like it, is it too much or too little 
* How is the '''sun''' working out (more on this after Final Texture) 
* Can '''hovercrafts''' go onto the water easily
* Do all the '''boats''' work fine (maybe water level too deep) 
* How does your map look in FPS or sort of view? 
* are the '''Geo's''' working? 
* Do all '''features''' work? 
* Is the '''metal output''' okay, too much, too little? 
 

You see, there is a '''LOT''' to test and check, So do play and test and play and test alot! '''If''' one or more of these things aren't working allright, you need to change it in the SMD or in your bmp's and recompile. If you are playing against AAI as a testing method, be '''SURE''' that if you recompile a '''changed height, metal or feature map''', you need to '''delete all cached and cfg files''' in the AAI folders. Otherwise the AAI won't see the difference. 
 

After multiple testrounds, you should have a good working map. If you like to 'organic-ize' your map, you can/must do it now. If you make it too organic, the pathfinding and passable slopes could be distorted, and you don't want that! So you can heighten or lower certain parts, or even throw in a noize overlay, but be '''SURE''' that you check if the map still plays okay! 
 

'''ARE YOU READY??''' 
 
OKay than you can start working on the looks!! 
 

'''The Texture:''' 
 

Remember the heightmap "fullHeight.bmp" we made bigger than we eventually will need? Well now you will see. Personally i use Bryce for rendering maps. I makes them nice and gives a perfect OTA feel to them. If you have Bryce, you must do the following steps: 
 

- create a terrain 
- edit the terrain, go to the picture tab, and load "FullHeight.bmp" 
- optionally add some height- or slopenoise, but do not overdo this 
- set the material, choose one, alter it a bit, so you like it! 
- set the atmosfear, light angle, and play with the icons and colors 
- last but not least, make the camera settings right! 
 

To do this you need to enter camera mode (you'll a camera icon). Then you must click the grey triangle next to the round sphere thing. There you can click on "edit current camera". In this menu, you must set the following where '''A''' an '''B''' are variables: 
 

- - - - - '''x''' --- '''y''' --- '''z''' 
origin -- 0 --- '''A''' --- 0 
pos - -- 0 --- '''A''' --- 0 
rotate - 90 -- 0 --- 0 

FOV: 1 degree
Scale: '''B'''

Only the first time, you need to tweak this, then you can save it as an template. The scale '''B''' should at least be 100% (but bigger ain't a problem). 
 
After that, you need to set the 'altitude' of the camera with '''A'''. You need to tweak this, so that you terrain completely fills the map. It will be a '''large number''', my template uses 25600. If you have a square map, set your document settings to square (800x800 for example). If it's not, make that change, just make sure the map fits the scene/screen. 
 
When you are sure your map 'fits' you can start your render. You must "Render to Disk" and you should also set the antialiasing to ultrafine for the best results (you can do this also in "document setup"). 
 
If you are not sure the map fits 100% (in any case, don't make it TOO big, because you will '''loose map''' that way), than you should consider rendering a bit larger, let's say 3-5% bigger (for a render of 8192, render to 8500) and you can then later cut of the edges and change it to the desired size of your image in Photoshop. (Although this is '''NOT recommended''') 
 

'''Voila''', after a couple of hours (depending on your system en scene settings) you'll probably have a nice render. (on which you can work later, to add more details...) 
 

Now you can open this file again in Photoshop, and start working on the details. Most important of all, is that you add the metalspots. The best way to do this, is to open your Metal.bmp, scale it to you Total Map size (8192x8192 for example) and put this image in a layer on top of your final texture layer, and set the opacity to 30-50%. Now you can see where the metal is supposed to be, and you can start drawing these in the map. (You can also download the original TA Metal patches somewhere, and add these)

After you have done all this, and are '''satisfied''' with the result, save your texture as Texture.bmp. You are now ready to compile it. You should use the settings that you now know (min. & max. height and compression setting). After Compiling, copy the files to your 'maps' directory, SD7 them, and finally place the final 'YourMapName.sd7' in your TA:Spring 'maps' folder, 
 

'''you can now play it!!''' 
 

If you also want to play it against other people, you should upload this sd7 file to Fileuniverse.com. Be sure to place it in the TA:Spring area, and also add a minimap (at least). 
 
 
 
Hopefully you have enjoyed this tutorial. Question, tips and suggestion are always welcome!! 
 

Good Luck with mapping!! 
 

IceXuick

Tutorial:MapMaking(Runecrafter)

2009-08-31T18:34:25Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

==Runecrafter's Map Tutorial==

Greetings, Myself (Runecrafter) and my fiancee (Moonchime) have been working on a map tutorial where we are going to try to teach you how to make maps quickly and easily.

==A list of what you will require.==

*'''Idea'''
**You will need to at least have an idea of what kind of map you wish to make.

*'''Art App'''
**Some kind of 2D art program, like [http://www.adobe.com/products/photoshop/main.html Photoshop], [http://www.corel.com/servlet/Satellite?pagename=Corel3/Products/Display&pfid=1047024307383&pid=1047025487586&cid=1047025488099&trkid=googlepsp&trkid=14679803 Paint Shop Pro], or [http://www.gimp.org/ The Gimp].

*'''5 Images'''
**You will need to create 5 images: Height, Metal, Type, Featuremap, Texture (Type is optional).

*'''[http://www.fileuniverse.com/?p=showitem&ID=1507 Mother's Mapconv]'''
*'''[http://www.fileuniverse.com/?p=showitem&ID=1507 Mother's Mapconv 'Optimized']'''
**A program to compile the 5 images into the map for Spring.

*'''[http://www.7-zip.org/ 7Zip]'''
**You will need this program (alot like WinZip) to compress the map into a .sd7 or .sdz after you are done compiling with Mother's Mapconv.

==Ok Let's Get Started...==

*'''Step 1: Size'''
**First we will need to determine the size that our map will be.Think of it this way, a Spring map that is 2x2 in size will use a texture image that is 1024x1024 where a 4x4 map uses a texture image of 2048x2048 etc.. To get an idea of how big a map is, 10x10 or less is small 12x12 - 16x16 Medium 18x18 - 24x24 Large 26x26 - 30x30 Giant 32x32 and up OMG! To my knowledge, 64x64 is the largest that Spring can take at this time. For this tutorial we will make a 16x16 (Medium) Map. 

*'''Step 2: Height Map'''
**The Height map is the image that determines the shape of the map(i.e.- hills, valleys, mountains, etc.). It is a Gray Scale image, that means that it only uses the colors of Black and White. Where black is the lowest point on the map and white is the highest point on the map. There are 255 shades in the gray scale- where 0,0,0 is black and 255,255,255 is white. http://spring.clan-sy.com/w/images/3/34/Rune_Height.jpg 
**Ok, now to make our Height map. First, we need to determine the size that our Height map image needs to be. Since our map is 16x16 that means that our Texture image will be 8192x8192, the Height map is 1/8 the size of our Texture map +1 pixel on both heighth and width. So with that in mind our Height map image should be 1025x1025. After you are done creating your height map save it and leave the image open.

*'''Step 3: Metal Map'''
**The Metal map is the image that determines metal placement on the map. This map uses the Red Channel. The Red Channel consists solely of the colors red and black. Black on the Red Channel is equivalent to zero or no metal(in game). Pure red is equivalent to the maximum amount of metal. http://spring.clan-sy.com/w/images/3/3e/Rune_Metal.jpg 
**The Metal map should be the same size as your Height map. For example, for our map the Height map is 1025x1025; therefore; the metal map should also be 1025x1025.
**'''Some Advice''' Make sure to disperse the metal equally on all sides of the map as people will be playing on all sides of the map. Also, take note that if you place large amounts of metal in the center of the map or in any one location, people will fight for that particular location above all others. While this might make for interesting game play, the downfall to this is that whoever obtains it will most surely be the victor. Therefore, if you are going to place a large amount of metal in a certain location-make sure the amount is not so large that it destroys game play.

*'''Step 4: Type Map (Optional)'''
**The Type map is the image that determines the terrain properties (such as ground hardness and unit movement speed). The Type map uses the Red Channel. The color black or zero is the default terrain type. The varying shades between black and pure red (255 shades) determine other terrain types. For example, 0,0,0 = [TERRAINTYPE0] (default), 1,0,0 = [TERRAINTYPE1], and 2,0,0 = [TERRAINTYPE2]. You can have up to 255 different terrain types. The terrain types are defined in the .SMD file.
**The Type map should be the same size as your Height map. For example, for our map the Height map is 1025x1025; therefore; the Type map should also be 1025x1025.

*'''Step 5: Featuremap'''
**The Featuremap is the image that determines the placement of features such as: trees, grass, geovents, and custom features (i.e.-rocks, buildings, crystals, etc.). 
**The Feature map should be the same size as your Height map - 1 pixel on both heighth and width. For example, for our map the Height map is 1025x1025; therefore; the feature map should be 1024x1024. 
**To place a feature you simply place 1 pixel of the appropriate color on the featuremap in the place where you wish it to appear on your map. 
**Geovents - Green - 255 
**Trees - Green - 200-215 
**Grass - Blue - 0-255 
**Features - Red - 255-0 
**'''Some Advice''' Open the height map, resize the height map the the size of your featuremap, Make a new layer, on this layer place the pixels where you want your features, under this layer make a new layer and fill it in with the color black 0,0,0 then flaten the image and save it as Featuremap.bmp 

*'''Step 6: Texture Map''' 
**http://spring.clan-sy.com/w/images/b/b6/Rune_Texture.jpg 
*'''The End Result''' 
**http://spring.clan-sy.com/w/images/f/f3/Demo_screen001.jpg http://spring.clan-sy.com/w/images/e/e1/Demo_screen002.jpg

[[Category:Map making]]

Tutorial:CompleteMapMaking(Wannes)

2009-08-31T18:34:19Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== Complete Map Making tutorial by Wannes ==

Hello everyone,
In this tutorial i'm gonna try to teach you everything you need to know to make your first decent map.

First i want to thank Maelstorm and aGorm for their tutorials, they tought me a lot.

=== Things You need: ===

An image editing program like Photoshop (which I will use in the rest of this tutorial), Paintshop Pro, . . .
Or 'the Gimp': [ ftp://ftp.gimp.org/pub/gimp/v2.2/ ]

Mapconv: This is the program that converts the Bitmap files you will be making into something that Spring can use (meaning a .smf and .smt file)
This program comes in 2 versions, Mothers mapconv and the "normal" one
In the rest of this tutorial I will be using mothers Mapconv
[ http://www.fileuniverse.com/uploads/60b1MapConv.zip ]

Map creation tools (optional): These programs help you making heightmaps, generate heightmaps, and apply textures to them.
Examples are:
* Terragen (Mars was made with the random terrain function in terragen by SJ)[ http://www.planetside.co.uk/terragen/download.shtml ]
* L3DT[ http://www.bundysoft.com/L3DT/downloads/standard.php ]
* World Machine.[ http://www.world-machine.com/download.html ]

If you are planning to make big maps 16x16 and more you really need a good cpu and alot of memory and HD space. Especially when you are going to make everything in Photoshop.

=== The Parts of the Map ===

Each map contains 4 parts (3 parts on the normal mapconv)

=== The texture Map: ===

This defines how the terrain for your map will look.
It needs to be a 24 bit bitmap, with dimensions that are a multiple of 1024.
A 16x16 map (you see this at spring lobby) equals a 8192x8192 pixels bitmap.
As you will soon notice these bitmaps have huge sizes. In order to compress these large bitmaps to a small mapfiles they created somethign named tiles.

A tile is a a small picture of a terrain like grass or sand or water. when you fill up your whole map with 1 or more tiles, mapconv can see this and make good use of it to compress your map. So its important you use tiles because it makes the map sizes alot smalle but you should pay attention your maps don't get too boring because of the same tile you see everywhere.

You can't just use tiles of any size. mapconv will check your map for tiles that are a multiple of 32 pixels. So you can use 32x32 64x64 . . . bigger tiles will usually be nicer on your map because its harder to spot u repeat the same tile over and over, but this also makes you map bigger.
You can even use tiles like 32x64, as long as its a multiple of 32

So it important that you find a good balance between the number of tiles you use and their size.

If you want to use tiles in Photoshop, do this:
open the tile picture, resize it to a multiple of 32, do edit->define pattern
then go to the terrain picture and use edit -> fill and select the wanted pattern. On large bitmaps this may take some time.
When you have applied a couple of tiles like this you can make them blend in to each other using the eraser on a low opacity.

You can also use terragen to generate you a texture map, using an imported height map or one you made inside terragen. Although I can give you no further info about the use of terragen because I don't know alot about it either.

===The Heightmap===

This is the key part of your map. It defines everything about the heights of your map (including water).

These are the basics: your heightmap must only contain black and white colors, and must be textmapsizeX/8 1 x textmapsizeY/8 1 so if you have a 8192 x 8192 texture map you got to have a 1025 x 1025 heightmap.
The whiter something is, the higher it will be in spring and black is the lowest your map can be.

so basically what you do is you paint your whole map grey (usually I take 127 127 127) and then add white and black where you want mountains and valleys

I'm not very good at making heightmaps myself so maybe someone else can write some things here.
The way I do it: I only use photoshop , take a white brush on very low opacity and start drawling a mountain on my map. It takes alot of time and patience making it very smooth. The blur tools helps alot and the surface blur filter helps alot too (or any other blur filter). If you want to make your terrain more interesting you shouldn't leave it all perfectly flat. There are many ways of doing this, you can use the filter->render-> clouds or some things in the filer->noise menu (remember not to use colors!)
After applying these filers you can try to put opacity of that layer low or merge it with the other layers (don't use this, but might be better)

===The Metal Map===

Aah this is an easy one : )
it uses the same dimensions as the heightmap.
The normal mapconv uses this map to place the metal and geovents on, but mothers mapconv has a special feature layer for the geo's (see later) so the metal map just keeps track of all the metal on your map.

It uses red to represent Metal , so you can use red going from 0 -255 to define your metal.
Remember that white = all colors so when you make a white map with red dots your whole map will be covered with metal. On the normal mapconv this will be even worse because white also contains green (which it uses for geo's) so the entire map wille be full of geo's. Because each green pixel represents a geo this will cause a big error when you start your map.

So always paint your map black (love that song) first and then add red dots (unless you are making a metal map)

===The Feature Map===

This is for Mothers mapconv only
It uses same dimensions as the height and metalmap.

GEO's:
It uses green 255 to represent a geo add 1 pixel to add one geo on your map don't place alot of green pixels next to eachother because this will make spring crash.

TREE's
It uses green color 200-215 to represent trees of 16 differant types

GRASS:

It uses blue color 0-255 0 = no grass 255 = full grass

FEATURES:
***taken from mothers mapconv readme***
Red Channel:
255 - feature of type on first line of text file specified with
254 - " " second " " "

ie. fs.txt has armjeth_dead on the first line, so a pixel of 255 Blue places an armjeth_dead !

Format is one feature type per line.
These features currently must be found in the .tdf files in the mods/<modname.sd7>/features filesystem.
*** taken from mothers mapconv readme ***

===Using Mapconv===

ok now you have your 4 maps, copy them into mothersmapconv folder

now you have to get mapconv to work. You can edit the .bat file or do this:
goto start-> run and type "cmd" this will open a dospromt
for those that don't knwo dos, use cd.. to go up one level cd "mapname" to change folder and "d:" to go to your D drive
navigate to the mapconv folder.

Then you need to type "mapconv" follwoed by a list of parameters

This is a list taken from mothers mapconv help:

USAGE:

mapconv [-l] [-i] [-c <compression>] -x <max height> -n <min height> [-o
<Output file>] [-e <tile file>] [-y <Typemap file>] -m <Metalmap file> -a
<Heightmap file> -t <Texture file> [--] [-v] [-h]

Where:

-l, --lowpass
Lowpass filters the heightmap

-i, --invert
Inverts the height map vertically (not the height values but the height map
(uhm someone rewrite this))

-c <compression>, --compress <compression>
(value required) How much we should try to compress the texture file.
Default value 0.8 . (lower=higher quality, larger file)

-x <max height>, --maxheight <max height>
(required) (value required) What altitude in spring the max(0xffff) level
of the height map should represent

-n <min height>, --minheight <min height>
(required) (value required) What altitude in spring the min(0) level of
the height map should represent

-o <Output file>, --outfile <Output file>
(value required) The name of the created map

-e <tile file>, --externaltilefile <tile file>
(value required) External tile file that will be used for finding tiles,
tiles not found in this will be added in a new tile file

-y <Typemap file>, --typemap <Typemap file>
(value required) Type map to use, uses the red channel to decide type,
types are defined in the .smd, if this argument is skipped the map will be
all type 0

-m <Metalmap file>, --metalmap <Metalmap file>
(required) (value required) Metal map to use, red channel is amount of
metal, green=255 is where to place geos (one pixel=one geo). Is resized to
fit the mapsize

-a <Heightmap file>, --heightmap <Heightmap file>
(required) (value required) Input heightmap to use for the map, this
should be in 16 bit raw format (.raw extension) or an image file. Must be
xsize*128 1 x ysize*128 1 in size.

-t <Texture file>, --intex <Texture file>
(required) (value required) Input bitmap to use for the map. Must be
xsize*1024 x ysize*1024 in size. (xsize,ysize integers determined from this
file)

--, --ignore_rest
Ignores the rest of the labeled arguments following this flag.

-v, --version
Displays version information and exits.

-h, --help
Displays usage information and exits.

This is an example of a command to convert your map (mame is crossroads)
I allways use the -i parameter else the texture map gets applied wrong

mapconv.exe -i -f w_crossroadsf.bmp -x 300 -n 50 -m w_crossroadsm.bmp -a w_crossroadsh.bmp -t w_crossroads.bmp -o w_crossroads.smf

If you run this you will see 2 new files in the mapconv folder yourmapname.smf and yourmapname.smt
You still need an extra file; yourmapname.smd
A smd file contains all things like wind speeds max metal sun direction map description, starting positions etc.
You can take a smd file from another map and edit or use Maelstorms SMD creator:
http://taspring.clan-sy.com/phpbb/viewtopic.php?t=2420

Now put these 3 files in a folder called "maps", download 7-zip [http://www.7-zip.org here], open it and navigate to the maps folder then right-click on it and do add to archive. Just let it make a zip file, and later rename it to yourmapname.sd7 (you have to edit the extension)

Put this file in your spring maps folder and you're ready to test it!

I'm gonna cleanup this tutorial alter and add alot more stuff but if you aren't bothered too much because of all the typo's this should teach you how to make your first map

cheers!

[[Category:Map making]]

Tutorial:BasicMapMaking(Maelstrom)

2009-08-31T18:34:04Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== Basic Map making ==

This tutorial is designed to help people make a basic map in an image editor like Photoshop. Things covered in this tutorial include:
* Making a basic concept drawing
* Making and using tiles
* Placing major map features
* Making use of layers to easily design and modify the map

First things first, we need to set up some folders and stuff to make all our lives easier. As the map compiler does not accept path names with spaces in them, it is easier if we just place the files in a folder straight on the C:\ drive. So, heres what folders to make:

* C:\Maps\
** MapName\
*** Tiles\
*** Texture\
*** Metal\
*** Height\

When we save each file, save them to the relevant folder. When we have finished that file, export it as a .bmp into the MapName folder for convinience. Remeber to save regularly, so as not to loose any work!

Whenever you create another map, make the same folders again. It makes life just that little bit easier.

=== Step 1: Concept Drawing ===

First things first, we need an idea of what the map will be about. For this map, I have made the following picture: 
[[Image:Rough Design.jpg]]

Green areas will be grass, Grey is mountains and Blue is water. This design does not need to be a major work of art, it just needs to convey the basic idea of the map, so that you have something to work off later.

=== Step 2: Making Tiles ===

The secret to small file sizes for maps is tiles. A Tile is a small picture that is repeated on the texture many times. This texture is then tiled by the map converter, and a 400mb 10240x10240 pixel big bitmap is transformed into a 200kb map file. The tiling system is very powerfull and very handy, but we still need to give it a hand.

Tiles in spring are based on 32x32 peices of the texture. Therefore, for our tiling to work correctly, our tile needs to be a size that is a multiple of 32. Sizes include:
* A basic, but boring looking 32x32 pixels
* A slightly better, but still slightly repetetive 64x64 pixels
* A good size of 128x128 pixels
* A large 256x256 pixels

Tiles can also be rectangular, and can be anything between the numbers mentioned above, but still need to be multiples of 32. To look good, tiles also need to be seamless, so when they are repeated no obvious join can be seen between the tiles.

For my map, as it has grass, mountains and a river I need three tiles.
* A green Grass Tile
[[Image:Grass.jpg]]
* A grey Mountain Tile
[[Image:Rock.jpg]]
* A blue River tile
[[Image:Water.jpg]]

=== Step 3: Setting up the Texture layers ===

A textures needs to be a certain size for it to work in the Spring engine. Textures must always be a size that is a multiple of 1024 pixels. 1024 pixels will equal 2 map 'size units' in the Spring engine, so a map of 5120x5120 pixels will be a 10x10 map. For a better description, go to one of the other pages.

We will need 4 layers for our map texture. One layer for our Grass texture, one for our Mountains, one for the River and one for the Concept drawing. First things first, make 4 layers. Fill the very bottom layer with the Water texture. The next layer is for the mountain texture, and the next is for the grass layer. Then, over all that, you draw in your concept again, but this time only the borders of the area's. Doing all this will make your life alot easier, and will help out alot in the long run.

Your texture should now look something like this, but just alot bigger: 
[[Image:Texture1.jpg]]

=== Step 4: Placing the major features ===

Now that you have your layers set up, you can start placing things like mountains and rivers. To do this, select the grass layer, and grab the eraser tool. Following the outline from your Concept design, rub out an area for the mountain to poke through. 
[[Image:Texture2.jpg]]

Then, do the other mountain: 
[[Image:Texture3.jpg]]

Now, we need to do the river. As the river layer is 'below' the gras layer AND the mountain layer, we need to rub a hole in each of them. So, pull out the eraser again, and get rubbing! 
[[Image:Texture4.jpg]]

After that, turn the concept drawing off, and there you have one tile base, small filesize texture! With a bit of playing around, blurring the edges, adding more layers, and little stuff like that you can make a really good looking map by just using an image editor. Just look at River Dale for an example!

=== Step 5: Making a height map ===
This is one of the tricker bits to get right. But without a good height map, your map is also no good. So, down to buisness!

A height map is a picture that the Spring uses to work out the height of different bits of land. Hence, a height map. A height map looks a little strange at first, but you get the hang of the pretty quickly. A height map will be a greyscale image (an image made up of shades of grey, as opposed to colours), where white represents mountains, and black valleys, or water.

First off, the height map needs to be a different size to the texture. The height map needs to be 1/8th of the size of the texture, plus one pixel. So, to make this easier, here is a nice formula!
Height map size = (Texture size / 8) 1
For this tutorial my height map will be the same size as my texture, but thats just so I can show you how to make it easier.

OK, now onto the height map! Make 2 layers. On the bottom layer, put your Texture, just resized to the right size. The top layer will be where we are going to draw our height map. To help us do this, we need to set the Opcaity (how transparent an image is) of the height map layer to around 50%. Some people like more, some people like less.

Grab the paint bucket tool and fill the whole of the height map dark grey. This will be the flat, grassy bit of our map. Then, grab the paint brush tool, set it to White, make it big and make the edges soft. When you paint with this brush you should get a white dot in the middle, with a steady fall off towards the grey that you have as your grass. Use this brush to paint in some mountains, with the White in the center, slowly fading out to the grey grass on the out side.

[[Image:Maelstrom-Height2.jpg]]

Then, make the same brush black, and draw a big long line for the river.

[[Image:Maelstrom-Height3.jpg]]

When this is done, make the Opacity of the Height map 100% again, and save the picture. The Height map is done! It may require some tweaking later, but its fine for now.

[[Image:Maelstrom-Height.jpg]]

=== Step 6: Metal Map ===

The metal map is alot like the height map. It is 1/8th the size one pixel. You can still underlay the texture for reference. It is still just a simple picture, like the height map. But this time, you need to do it in 'redscale', instead of greyscale. That is, using only red, and no green or blue. The more red the colour, the more metal is given. Depending on the style of map you want is how you make your metal map. For this map, we are going with an OTA style map with metal patches.

Make 2 layers. On the bottom layer, we will have our texture. On the top layer we will draw in the metal. For now, we can leave the metal layer empty, with full opacity, unlike the metal map.

Grab a brush. Make it about 3 pixels big and square. Make the colour about half red, with all the other colours all the way down. This will be some low metal patches for the starting positions. Place a couple of patches around the corners, enough to start with, like so:

[[Image:Maelstrom-Metal1.jpg]]

Then, make the brush full red. Place some more patches in places like the mountains, and the middle of the map. Places that will be under constant attack. These will be the good spots for the players willing to risk it for the extra metal.

[[Image:Maelstrom-Metal2.jpg]]

Now we need to hide the texture. To do this, grab the paint bucket tool and fill in the empty area black. You have now finished your metal map. Save the picture and your done!

[[Image:Maelstrom-Metal.jpg]]

=== Feature Map ===
A feature map is used to place Grass, Trees, Geovents and Features on a map. The tutorial will not cover how to make this, however the file is still needed. So we will just make a blank Feature map.

Feature maps are a bit like the other maps, however instead of being one eighth of the texture 1 pixel, they are just one eighth of the texture. So, for example, instead of being 129x129 pixels, your Feature map will be 128x128 pixels. Create a picture that is the required size, and fill it black. If you fill it white, you will overload the game, and it will probably crash. Which is a bad thing.

== Compiling ==
For compiling, see the [[Maps:Compiling|compiling tutorial]]

[[Category:Map making]]

Tutorial:CompleteMapMaking(Wannes)

2009-08-31T18:28:39Z

Aegis:

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}

== Complete Map Making tutorial by Wannes ==

Hello everyone,
In this tutorial i'm gonna try to teach you everything you need to know to make your first decent map.

First i want to thank Maelstorm and aGorm for their tutorials, they tought me a lot.

=== Things You need: ===

An image editing program like Photoshop (which I will use in the rest of this tutorial), Paintshop Pro, . . .
Or 'the Gimp': [ ftp://ftp.gimp.org/pub/gimp/v2.2/ ]

Mapconv: This is the program that converts the Bitmap files you will be making into something that Spring can use (meaning a .smf and .smt file)
This program comes in 2 versions, Mothers mapconv and the "normal" one
In the rest of this tutorial I will be using mothers Mapconv
[ http://www.fileuniverse.com/uploads/60b1MapConv.zip ]

Map creation tools (optional): These programs help you making heightmaps, generate heightmaps, and apply textures to them.
Examples are:
* Terragen (Mars was made with the random terrain function in terragen by SJ)[ http://www.planetside.co.uk/terragen/download.shtml ]
* L3DT[ http://www.bundysoft.com/L3DT/downloads/standard.php ]
* World Machine.[ http://www.world-machine.com/download.html ]

If you are planning to make big maps 16x16 and more you really need a good cpu and alot of memory and HD space. Especially when you are going to make everything in Photoshop.

=== The Parts of the Map ===

Each map contains 4 parts (3 parts on the normal mapconv)

=== The texture Map: ===

This defines how the terrain for your map will look.
It needs to be a 24 bit bitmap, with dimensions that are a multiple of 1024.
A 16x16 map (you see this at spring lobby) equals a 8192x8192 pixels bitmap.
As you will soon notice these bitmaps have huge sizes. In order to compress these large bitmaps to a small mapfiles they created somethign named tiles.

A tile is a a small picture of a terrain like grass or sand or water. when you fill up your whole map with 1 or more tiles, mapconv can see this and make good use of it to compress your map. So its important you use tiles because it makes the map sizes alot smalle but you should pay attention your maps don't get too boring because of the same tile you see everywhere.

You can't just use tiles of any size. mapconv will check your map for tiles that are a multiple of 32 pixels. So you can use 32x32 64x64 . . . bigger tiles will usually be nicer on your map because its harder to spot u repeat the same tile over and over, but this also makes you map bigger.
You can even use tiles like 32x64, as long as its a multiple of 32

So it important that you find a good balance between the number of tiles you use and their size.

If you want to use tiles in Photoshop, do this:
open the tile picture, resize it to a multiple of 32, do edit->define pattern
then go to the terrain picture and use edit -> fill and select the wanted pattern. On large bitmaps this may take some time.
When you have applied a couple of tiles like this you can make them blend in to each other using the eraser on a low opacity.

You can also use terragen to generate you a texture map, using an imported height map or one you made inside terragen. Although I can give you no further info about the use of terragen because I don't know alot about it either.

===The Heightmap===

This is the key part of your map. It defines everything about the heights of your map (including water).

These are the basics: your heightmap must only contain black and white colors, and must be textmapsizeX/8 1 x textmapsizeY/8 1 so if you have a 8192 x 8192 texture map you got to have a 1025 x 1025 heightmap.
The whiter something is, the higher it will be in spring and black is the lowest your map can be.

so basically what you do is you paint your whole map grey (usually I take 127 127 127) and then add white and black where you want mountains and valleys

I'm not very good at making heightmaps myself so maybe someone else can write some things here.
The way I do it: I only use photoshop , take a white brush on very low opacity and start drawling a mountain on my map. It takes alot of time and patience making it very smooth. The blur tools helps alot and the surface blur filter helps alot too (or any other blur filter). If you want to make your terrain more interesting you shouldn't leave it all perfectly flat. There are many ways of doing this, you can use the filter->render-> clouds or some things in the filer->noise menu (remember not to use colors!)
After applying these filers you can try to put opacity of that layer low or merge it with the other layers (don't use this, but might be better)

===The Metal Map===

Aah this is an easy one : )
it uses the same dimensions as the heightmap.
The normal mapconv uses this map to place the metal and geovents on, but mothers mapconv has a special feature layer for the geo's (see later) so the metal map just keeps track of all the metal on your map.

It uses red to represent Metal , so you can use red going from 0 -255 to define your metal.
Remember that white = all colors so when you make a white map with red dots your whole map will be covered with metal. On the normal mapconv this will be even worse because white also contains green (which it uses for geo's) so the entire map wille be full of geo's. Because each green pixel represents a geo this will cause a big error when you start your map.

So always paint your map black (love that song) first and then add red dots (unless you are making a metal map)

===The Feature Map===

This is for Mothers mapconv only
It uses same dimensions as the height and metalmap.

GEO's:
It uses green 255 to represent a geo add 1 pixel to add one geo on your map don't place alot of green pixels next to eachother because this will make spring crash.

TREE's
It uses green color 200-215 to represent trees of 16 differant types

GRASS:

It uses blue color 0-255 0 = no grass 255 = full grass

FEATURES:
***taken from mothers mapconv readme***
Red Channel:
255 - feature of type on first line of text file specified with
254 - " " second " " "

ie. fs.txt has armjeth_dead on the first line, so a pixel of 255 Blue places an armjeth_dead !

Format is one feature type per line.
These features currently must be found in the .tdf files in the mods/<modname.sd7>/features filesystem.
*** taken from mothers mapconv readme ***

===Using Mapconv===

ok now you have your 4 maps, copy them into mothersmapconv folder

now you have to get mapconv to work. You can edit the .bat file or do this:
goto start-> run and type "cmd" this will open a dospromt
for those that don't knwo dos, use cd.. to go up one level cd "mapname" to change folder and "d:" to go to your D drive
navigate to the mapconv folder.

Then you need to type "mapconv" follwoed by a list of parameters

This is a list taken from mothers mapconv help:

USAGE:

mapconv [-l] [-i] [-c <compression>] -x <max height> -n <min height> [-o
<Output file>] [-e <tile file>] [-y <Typemap file>] -m <Metalmap file> -a
<Heightmap file> -t <Texture file> [--] [-v] [-h]

Where:

-l, --lowpass
Lowpass filters the heightmap

-i, --invert
Inverts the height map vertically (not the height values but the height map
(uhm someone rewrite this))

-c <compression>, --compress <compression>
(value required) How much we should try to compress the texture file.
Default value 0.8 . (lower=higher quality, larger file)

-x <max height>, --maxheight <max height>
(required) (value required) What altitude in spring the max(0xffff) level
of the height map should represent

-n <min height>, --minheight <min height>
(required) (value required) What altitude in spring the min(0) level of
the height map should represent

-o <Output file>, --outfile <Output file>
(value required) The name of the created map

-e <tile file>, --externaltilefile <tile file>
(value required) External tile file that will be used for finding tiles,
tiles not found in this will be added in a new tile file

-y <Typemap file>, --typemap <Typemap file>
(value required) Type map to use, uses the red channel to decide type,
types are defined in the .smd, if this argument is skipped the map will be
all type 0

-m <Metalmap file>, --metalmap <Metalmap file>
(required) (value required) Metal map to use, red channel is amount of
metal, green=255 is where to place geos (one pixel=one geo). Is resized to
fit the mapsize

-a <Heightmap file>, --heightmap <Heightmap file>
(required) (value required) Input heightmap to use for the map, this
should be in 16 bit raw format (.raw extension) or an image file. Must be
xsize*128 1 x ysize*128 1 in size.

-t <Texture file>, --intex <Texture file>
(required) (value required) Input bitmap to use for the map. Must be
xsize*1024 x ysize*1024 in size. (xsize,ysize integers determined from this
file)

--, --ignore_rest
Ignores the rest of the labeled arguments following this flag.

-v, --version
Displays version information and exits.

-h, --help
Displays usage information and exits.

This is an example of a command to convert your map (mame is crossroads)
I allways use the -i parameter else the texture map gets applied wrong

mapconv.exe -i -f w_crossroadsf.bmp -x 300 -n 50 -m w_crossroadsm.bmp -a w_crossroadsh.bmp -t w_crossroads.bmp -o w_crossroads.smf

If you run this you will see 2 new files in the mapconv folder yourmapname.smf and yourmapname.smt
You still need an extra file; yourmapname.smd
A smd file contains all things like wind speeds max metal sun direction map description, starting positions etc.
You can take a smd file from another map and edit or use Maelstorms SMD creator:
http://taspring.clan-sy.com/phpbb/viewtopic.php?t=2420

Now put these 3 files in a folder called "maps", download 7-zip [http://www.7-zip.org here], open it and navigate to the maps folder then right-click on it and do add to archive. Just let it make a zip file, and later rename it to yourmapname.sd7 (you have to edit the extension)

Put this file in your spring maps folder and you're ready to test it!

I'm gonna cleanup this tutorial alter and add alot more stuff but if you aren't bothered too much because of all the typo's this should teach you how to make your first map

cheers!

[[Category:Map making]]

Tutorial:MapMakingGuide(aGorm)

2009-08-31T18:18:05Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

This has been moved to a title with teh correct spelling...

By the way, im currently making a map, thats why this isn't changing...

----
<big>'''aGorms Ultimate Map Making Guide:'''</big>

== Stage A Ã¢â‚¬â€œ Pre-Preparation ==

So you want to make a map? Want to give something back? Good! However there are several things youÃ¢â‚¬â„¢re going to have to make sure you know before you start. And thatÃ¢â‚¬â„¢s what this section is about.

===Have you the Time?===

Believe me when I say, making a map will take a lot of your time. Hours. Days. Some take weeks to finish. So make sure you want to commit yourself to it first (this isnÃ¢â‚¬â„¢t a StarCraft style, make a map in 5 minuets sort of situation)

===Have you the Hardware?===

Making a map unfortunately requires a computer better than that need to actually play spring. Sounds daft? YouÃ¢â‚¬â„¢re dealing with very large images, which take up a lot of ram. Seeing as Windows needs 512 just to run, youÃ¢â‚¬â„¢ll need at least a gig if you want any joy. Also youÃ¢â‚¬â„¢ll need a half decent processor, or compiling will take forever. Some people will disagree, but honestly, at least a 2 GHz and a gig of ram would be useful.

===Have you the Software?===

First off, you will need Several Different pieces of software.

====Mapconv:====
There are actually two versions; however, I will strongly recommend that you use Mothers Mapconv program. All the advice given below will assume you will be using it. And whilst the vast majority of this will be relevant for the original one, there are a few vital differences in what does what etcÃ¢â‚¬Â¦

====Art Program:====
You will need an art program. Paint will not be sufficient. You can use whatever you are comfortable with, but this guild is written with Photoshop in mind. However many of the options are the same, they all do the same thing in the end.
Suggestions of programs to use:

* Photoshop
* Paint shop Pro
* GIMP
* Fireworks

The following are not required, but are useful, or needed for more advanced maps.

====Terrain Generators:====
Terragen / TerrTexGen Ã¢â‚¬â€œ both of these programs take a height map, and create a realistic render of terrain based of it, using values you input.

====3D software:====
There are HUNDREDS of different 3D packages out there, any one of them can be used to make a feature for you map, however youÃ¢â‚¬â„¢ll only be able to finish the model off in ONE program, named 3DO Builder. In this program you can create the final file that spring can read.

===Beverages:===
Making a map sucks you in; I suggest you keep [http://www.onebob.co.uk/darren/pics/water.jpg water handy] at all times, along with a light snack.

===Music:===
I Suggest you put your favorit Music on, that way your doing two things at once. However If you gonna head bang put down the mouse first...

==Stage B Ã¢â‚¬â€œ Preparation==

Now you have prepared your self of the task ahead, its time to actually think about making the map. This section is about map concepts, ideas, and to help you decided what sections of this tutorial your going top want to read (After all, not all maps require the same things, most maps have no features, donÃ¢â‚¬â„¢t use a custom skybox, and may not make use of the terrain type mapÃ¢â‚¬Â¦ So you will not want to bother with those sections!)

===Concepts:===
This is something all maps need in one degree or another. What purpose do you want your map to serve? This can be as simple as Ã¢â‚¬Å“I want the map to be really huge so that we can enjoy huge battlesÃ¯Â¿Â½? to something more conceptual like Ã¢â‚¬Å“I want to make a platform style map, with limited access and lots of cover, with most of the resources in the middleÃ¯Â¿Â½?. It doesnÃ¢â‚¬â„¢t matter too much what your concept is, as long as you have one. Maps made without a concept tend to be boring, dull, uneven, and unplayed. And you donÃ¢â‚¬â„¢t want thatÃ¢â‚¬Â¦ do you?

===What makes it special:===
So what do you want your map to include? For instance, say I was going to take the first concept and just make a really huge map. What am I going to do to make it special? Shall I use custom features? Or a radical skybox? Maybe there should be reclaimable wreckages strewn over the battle field. There are many different things you can add to a map to make it unique, and often itÃ¢â‚¬â„¢s a case of striking a balance between them all. All the different things you can add to a map have there own section in this tutorial, so once you know what you want youÃ¢â‚¬â„¢ll be able to go and read up on how to make your dream a reality.

===Very First Steps:===
No turning back now!! Befor we get to the nitty gritty, you need to make several key desisions:
* How Big is your map? A small map would be between 10 x 10 and 16 x 16. Medium maps are 16x 16 to 24 x 24, anything over that can be safly called big, and If you manage to make one over 32 x 32 then its Huge!
* Rough drawing. Which is self explanatory, make a rough drawing of what you are imagining. I can be as crap as you like, but belive me its much easier to map when you have a reference. Only people with a vivid imagination can skip this...

==Stage C Ã¢â‚¬â€œ Height Map==

Some people will be thinking, hold on, why is Height Map first! We'll, it's quite simple... textures may change, but heightmaps dont! Let me explane that... Two maps with the same heightmap will play exactly the same as each other, irrespective of what texture you use. For instance, when making a map I once made a snowy Mountain one. However while it played nicly, I decided it looked crap, so I changed it to being a sandy island. Lots of maps out there have had several revisions of texture map!

Now Im going to explane the stages of making a heightmap (for which you'll need a graphics program, I use Photoshop, and an Idea of were your mountains and valleys are.)

===Basic heightmap:===
First things first, make a black canvas with teh following dimentions:
X dimention: (map width) x 64 1
Y dimention: (map height) x 64 1
For instance a 16 x 16 map will need a 1025 x 1025 heightmap.

[[Image:Height1.jpg]]

Black is the lowest point on the map. So valleys, or on water maps, water are going to be in these areas.
White is the heighest point on the map. So the top of a mountain will be white.
Greys are the levels in between, of which there are 256 levels.

===Adding a mountain:===
To add a mountain (all be it, a very unnatural one) take a paint brush and put down a splodge of white were the mountain will be. Tada! In game that will already be a mountain! Now your probablie thinking, wait it can't be that easy... Well as I said early, that will make a mountain, but It won't look very natural. However we'll deal with taht later. For now, you want to paint on roughly were your heighest points are. If you want smaller hills, use a shade of grey to draw with.

[[Image:Height2.jpg]]

===Making Some Variation:===
So the land looks like a kids rendition of a landscape, with perfect hills, and smoth valleys. Not to realistic right? Well there are several techniques to add that bit of variation to the land. Bare in mind these steps will work in other software besides photoshop, but that you may have to go about them in a different way...

====Noise:====
Create a New layer on top of your current heightmap and fill it black. Next, drop down the filters menu, go to noise, add noise, and it will open teh noise diolog box. Make sure you select "Monochromatic" (for black and white)and drag the slider till it looks about half and half. Click OK and you should have noise!
Now go to filters, blur, gausation blur. Set it to between 2 and 4 pixels and click OK again. Now you should have a greyish black mess.
Now mess around with the layer blending settings (in photoshop there in the drop down just above the layers, and start with normal) I normaly use somthing like a "linear dodge", and set the opacity to 50% ish, but Its best to play around.

[[Image:Height3.jpg]]

What this will have done Is lightened small areas of your map by a small amount, causeing minor variations in the height, which means your land wont be entirly flat. And because its only a minor variation you can normaly still build on it (if you cant build on the land, drop the opacity a bit more, which of course means make sure you save with layers ON)

====Sharpness:====
OK, so you got all that, but your still thinking that those mountains are a bit... odd? Well thats because most mountains are infact not perfectly rounded hills. They have steep sides, sharp transitions, sher drops, as well as the plesent rolling hills that you get.
To begin to get the effect, go to teh layer below the layer with your noise on it (else it will overwrite it!) and get a black brush. Make sure you turn the hardness up a bit (50% should do for a basic test). Then carve out a section on the hill. That makes a shear drop! But you may not want that, so turn down the opacity of that layer.

[[Image:Height4.jpg]]

I then genraly build up these layers (each with maybe 20%-40% opacity) till I have made the sort of hills Id like. Bear in mind this is all personal preference!

[[Image:Height5.jpg]]

[[Category:Map making]]

Mapdev:SMD

2009-08-31T18:17:37Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== SMD Syntax ==
The SMD, to work correctly, must be set out correctly. The following are a few of these requirements that you have to follow:
*All lines must end in a ';'. This is just like any C derived programming language
*Sections begin with a keyword wrapped in [Square brackets], and are wrapped in {Curly Brackets}
*Each different tag must be placed on a different line (?)

The following are some recomendations to help other people read your SMD.
*Blank lines are allowed, and can be placed to help distinguish between different sections
*You may place comments in the SMD, and again like C programming languages, these are preceded by a '//'. Anything following a comment marker is ignored by the parser.
*You can tabulate your SMD to help the overall readability, and to show where sections begin and end.

== Example SMD ==

[MAP]
{
Description=Lot of metal in middle but look out for kbot walking over the mountains;
TidalStrength=20;
Gravity=130;
MaxMetal=0.03;

ExtractorRadius=400;
MapHardness=100;

[SMF]
{
minheight = -135;
maxheight = 265;
}
[ATMOSPHERE]
{
FogColor=0.7 0.7 0.8;
FogStart=0.2;

CloudColor=0.9 0.9 0.9;
SkyColor=0.1 0.15 0.7;

SunColor=1.0 1.0 1.0;
CloudDensity=0.55;

MinWind=5;
MaxWind=20;
}
[WATER]
{
WaterBaseColor=0.4 0.6 0.8;
WaterAbsorb=0.004 0.004 0.002;

WaterMinColor=0.1 0.1 0.3;
}
[LIGHT]
{
SunDir=0 1 2;

GroundAmbientColor=0.4 0.4 0.4;
GroundSunColor=0.7 0.7 0.7;

GroundShadowDensity=0.8;

UnitAmbientColor=0.3 0.3 0.3;
UnitSunColor=0.8 0.8 0.8;
UnitShadowDensity=0.8;

}
[TEAM0]
{
StartPosX=600;
StartPosZ=600;
}
[TEAM1]

{
StartPosX=3600;
StartPosZ=3600;
}
[TEAM2]
{
StartPosX=3600;
StartPosZ=600;
}
[TEAM3]
{
StartPosX=600;
StartPosZ=3600;

}
[TEAM4]
{
StartPosX=2000;
StartPosZ=600;
}
[TEAM5]

{
StartPosX=2000;
StartPosZ=3600;
}
//Up to [TEAM9]
[TERRAINTYPE0]
{
name=default;
hardness=1;
tankmovespeed=1;
kbotmovespeed=1;
hovermovespeed=1;
shipmovespeed=1;

}
}

== SMD Tags List ==
<table border="1">
<tr>
<th valign="top" bgcolor="#C0C0C0">Variable</th>
<th valign="top" bgcolor="#C0C0C0">Description</th>
<th valign="top" bgcolor="#C0C0C0">Examples</th>
</tr>
<tr>
<td valign="top">'''[TEAM''X'']'''</td>
<td valign="top">The number of the team, starting at 0 for player 1 and going on up to 9 for player 10, where ''X'' is the player number</td>
<td valign="top">[TEAM3]</td>
</tr>
<tr>
<td valign="top">'''[TERRAINTYPE''X'']'''</td>
<td valign="top">Used to define different terrain types that exist on the map. The value starts at 0 and goes on for as many terrain types as you have, where ''X'' is the type number. Which terrain type goes where on the map is determined by the typemap when compiling the map. For example, if the typemap has an area of red 128, then the corresponding terraintype tag is [TERRAINTYPE128] </td>
<td valign="top">[TERRAINTYPE0]</td>
</tr>

<tr>
<td valign="top">'''CloudColor'''</td>
<td valign="top">The color of the clouds. The values are in the order Red, Green, Blue. For all intensive purposes, 0.0 is black and 1.0 is white; however, giving values higher than 1.0 will give brighter fog and less than 0.0 will give darker.</td>
<td valign="top">CloudColor=0.9 0.9 0.9;</td>
</tr>
<tr>
<td valign="top">'''CloudDensity'''</td>

<td valign="top">The number of clouds in the sky. A percentage in decimal form, 0.0 to 1.0.</td>
<td valign="top">CloudDensity=0.55;</td>
</tr>
<tr>
<td valign="top">'''Description'''</td>
<td valign="top">The description of the map that shows in the multiplayer battleroom.</td>
<td valign="top">Description=Strong wind, good for 2v2 team games;</td>

</tr>
<tr>
<td valign="top">'''ExtractorRadius'''</td>
<td valign="top">The radius of effect that a single extractor will extract from. If two radii intersect, both extractors will suffer from reduced output.</td>
<td valign="top">ExtractorRadius=400;</td>
</tr>
<tr>

<td valign="top">'''GroundAmbientColor'''</td>
<td valign="top">The ambient (non-sun-lit) color of ground, grass, trees and other features.</td>
<td valign="top">GroundAmbientColor=0.4 0.4 0.4;</td>
</tr>
<tr>
<td valign="top">'''GroundShadowDensity'''</td>
<td valign="top">How far from the non shadowed to the ambient color stuff in shadow will go.</td>

<td valign="top">GroundShadowDensity=0.8;</td>
</tr>
<tr>
<td valign="top">'''GroundSunColor'''</td>
<td valign="top">The color of ground where it is fully sun lit (added to GroundAmbientColor).</td>
<td valign="top">GroundSunColor=0.7 0.7 0.7;</td>

</tr>
<tr>
<td valign="top">'''FogColor'''</td>
<td valign="top">The color of the fog and the infinite plane below the world. The values are in the order Red, Green, Blue. For all intensive purposes, 0.0 is black and 1.0 is white; however, giving values higher than 1.0 will give brighter fog and less than 0.0 will give darker.</td>
<td valign="top">FogColor=0.7 0.7 0.8;</td>
</tr>
<tr>

<td valign="top">'''FogStart'''</td>
<td valign="top">The distance from the camera at which the fog will start.</td>
<td valign="top">FogStart=0.2;</td>
</tr>
<tr>
<td valign="top">'''Hardness (terraintype)'''</td>
<td valign="top">Used as a multiplier against the MapHardness value. Can be used to make a particular terrain type softer or harder. A value of '1' will make it as hard as MapHardness, and 0.5 will make it half as hard.</td>

<td valign="top">hardness=0.75;</td>
</tr>
<tr>
<td valign="top">'''HoverNoveSpeed'''</td>
<td valign="top">Speed multiplier for hovercraft when travelling on the parent terrain type. A value of '1' is normal speed, 0.5 will make them travel at half speed on the parent terrain type.</td>
<td valign="top">hovermovespeed=1;</td>
</tr>

<tr>
<td valign="top">'''KbotMoveSpeed'''</td>
<td valign="top">Speed multiplier for Kbots when travelling on the parent terrain type. A value of '1' is normal speed, 0.5 will make them travel at half speed on the parent terrain type.</td>
<td valign="top">kbotmovespeed=1;</td>
</tr>
<tr>
<td valign="top">'''MapHardness'''</td>
<td valign="top">Defines how much the terrain will deform due to explosions and weapons.</td>
<td valign="top">MapHardness=100;</td>
</tr>
<tr>
<td valign="top">'''MaxMetal'''</td>
<td valign="top">How much metal a map square with the maximum metal value gives. Unsure how this is calculated, but a value of around 0.03 will give OTA-esque levels of metal from metal extractors.</td>
<td valign="top">MaxMetal=0.03;</td>

</tr>
<tr>
<td valign="top">'''MaxWind'''</td>
<td valign="top">The maximum amount of energy the wind on the map will give.</td>
<td valign="top">MaxWind=20;</td>
</tr>
<tr>

<td valign="top">'''MinWind'''</td>
<td valign="top">The minimum amount of energy the wind on the map will give.</td>
<td valign="top">MinWind=5;</td>
</tr>
<tr>
<td valign="top">'''Name (terraintype)'''</td>
<td valign="top">Used to define the name of the type of terrain. "Snow" or "Rock" or whatever you want.</td>
<td valign="top">Name=default;</td>
</tr>
<tr>
<td valign="top">'''ShipMoveSpeed'''</td>
<td valign="top">Speed multiplier for Ship when travelling on the parent terrain type. A value of '1' is normal speed, 0.5 will make them travel at half speed on the parent terrain type.</td>
<td valign="top">shipmovespeed=1;</td>
</tr>

<tr>
<td valign="top">'''SkyColor'''</td>
<td valign="top">The color of the sky itself. Works the same way as CloudColor and FogColor.</td>
<td valign="top">SkyColor=0.1 0.15 0.7;</td>
</tr>

<tr>
<td valign="top">'''StartPosX'''</td>
<td valign="top">The X (east-west in the TA camera) coordinates on the map where the player will start.</td>
<td valign="top">StartPosX=600;</td>
</tr>
<tr>
<td valign="top">'''StartPosZ'''</td>

<td valign="top">The Z (north-south in the TA camera) coordinates on the map where the player will start.</td>
<td valign="top">StartPosZ=600;</td>
</tr>
<tr>
<td valign="top">'''SunColor'''</td>
<td valign="top">The color of the sun in the sky. This will also effect the size of the star. As the value increases (including over 1.0), the disc will get bigger; the inverse is also true.</td>
<td valign="top">SunColor=1.0 1.0 1.0;</td>

</tr>
<tr>
<td valign="top">'''SunDir'''</td>
<td valign="top">The direction of the sun, which is normalized by Spring. The Y-axis is up. Here's a basic chart for values:
<center>
<table border="1" width="210px" align="center">
<tr height="70px">
<td width="70px">1 .5 -1</td><td width="70px">0 .5 -1</td><td width="70px">-1 .5 -1</td>
</tr>
<tr height="70px">
<td>1 .5 0</td><td>0 1 0</td><td>-1 .5 0</td>
</tr>
<tr height="70px">
<td>1 .5 1</td><td>0 .5 1</td><td>-1 .5 1</td>
</tr>
</table>
</center>
</td>
<td valign="top">SunDir=0 1 2;</td>
</tr>

<tr>
<td valign="top">'''TankMoveSpeed'''</td>
<td valign="top">Speed multiplier for tanks when travelling on the parent terrain type. A value of '1' is normal speed, 0.5 will make them travel at half speed on the parent terrain type.</td>
<td valign="top">tankmovespeed=1;</td>
</tr>
<tr>
<td valign="top">'''TidalStrength'''</td>
<td valign="top">The amount of energy which will be given by tidal generators.</td>
<td valign="top">TidalStrength=30;</td>
</tr>
<tr>
<td valign="top">'''UnitAmbientColor'''</td>
<td valign="top">The ambient (non-sun-lit) color of units and corpses.</td>
<td valign="top">UnitAmbientColor=0.3 0.3 0.3;</td>

</tr>
<tr>
<td valign="top">'''UnitShadowDensity'''</td>
<td valign="top">How far from the non shadowed to the ambient color stuff in shadow will go.</td>
<td valign="top">UnitShadowDensity=0.8;</td>
</tr>
<tr>

<td valign="top">'''UnitSunColor'''</td>
<td valign="top">The color of units where they is fully sun lit (added to UnitAmbientColor).</td>
<td valign="top">UnitSunColor=0.8 0.8 0.8;</td>
</tr>
<tr>
<td valign="top">'''WaterAbsorb'''</td>
<td valign="top">How fast different colors (RGB in order) are absorbed by the water. Can be used to make the water look murky at deeper sections and so on. How this works: the waterabsorb value for the color channel gets multiplied by the depth of the water at a point, and this product gets subtracted from ''WaterBaseColor'', until ''WaterMinColor'' is reached. Example: ''WaterAbsorb'' is 0.01, for the red channel, and we want to know how much red will be left in the water at a Spring elevation of -100, since 0.01*100= 1 , at this depth, there will be no more red component in the water, unless ''WaterMinColor'' is higher than 0 on the red channel.</td>
<td valign="top">WaterAbsorb=0.004 0.004 0.002;</td>
</tr>
<tr>
<td valign="top">'''WaterBaseColor'''</td>
<td valign="top">The color of the water just beneath the surface plane. This is the starting color from which deeper waters will absorb more color.</td>
<td valign="top">WaterBaseColor=0.4 0.6 0.8;</td>

</tr>
<tr>
<td valign="top">'''WaterMinColor'''</td>
<td valign="top">The smallest values the water will go down to due to WaterAbsorb.</td>
<td valign="top">WaterMinColor=0.1 0.1 0.3;</td>
</tr>
<tr>
<td valign="top">'''WaterPlaneColor'''</td>
<td valign="top">This set the color of the groundplane under the water outside the map boundaries</td>
<td valign="top">WaterPlaneColor = 0.75 0.8 0.85; </td>

</tr>
<tr>
<td valign="top">'''WaterSurfaceColor'''</td>
<td valign="top">The color of the water surface. Mostly affects the colors of the reflections off the top of the water. Does''' NOT''' effect bumped water!</td>
<td valign="top">WaterSurfaceColor = 0.75 0.8 0.85; </td>

</tr>
<tr>
<td valign="center">
== Bump mapped water SMD tags. These tags only affect bump mapped water and dont affect the other types. ==
</td>
</tr>

<tr>
<td valign="top">'''WaterSurfaceAlpha'''</td>
<td valign="top">Transparency of the water surface. 0 meaning almost fully transparent water plane(low amount of reflections visible), and 1 being nearly opaque (massive amount of reflections). Default=0.55</td>
<td valign="top">WaterSurfaceAlpha = 0.55; </td>
</tr>

<tr>
<td valign="top">'''WaterDiffuseColor'''</td>
<td valign="top">This specifies the diffuse color of the water body. '''WARNING''': use of this tag disables the effect of ''WaterAbsorb'' , in fact, this tag does nothing but disable WaterAbsorb. Avoid.</td>
<td valign="top">WaterDiffuseColor = 0.55 0.4 0.3; </td>

</tr>
<tr>

<td valign="top">'''WaterSpecularColor '''</td>
<td valign="top">WaterSpecularColor = groundSunColor - Altering this tag does not seem to have any effect at all.-</td>
<td valign="top"> //WaterSpecularColor = 0.55 0.4 0.3; </td>

</tr>
<tr>

<td valign="top">'''WaterSpecularPower '''</td>
<td valign="top"> -no clue-'''WARNING''': use of this tag disables the effect of ''WaterAbsorb'' </td>
<td valign="top">WaterSpecularPower = 2.0; </td>

</tr>
<tr>

<td valign="top">'''WaterSpecularFactor '''</td>
<td valign="top"> -no clue-</td>
<td valign="top">WaterSpecularFactor = 0.3; </td>

</tr>
<tr>

<td valign="top">'''WaterAmbientFactor '''</td>
<td valign="top"> -no clue-</td>
<td valign="top">WaterAmbientFactor = 1.3; </td>

</tr>
<tr>

<td valign="top">'''WaterDiffuseFactor '''</td>
<td valign="top"> -no clue-</td>
<td valign="top">WaterDiffuseFactor = 0.3; </td>

</tr>
<tr>

<td valign="top">'''WaterFresnelMin'''</td>
<td valign="top">I have no clue what the WaterFresnel tags do, someone with more knowlegde edit this page please.(0.0<x<=1.0)</td>
<td valign="top">WaterFresnelMin = 0.3; </td>

</tr>
<tr>

<td valign="top">'''WaterFresnelMax'''</td>
<td valign="top">(<1-WaterFresnelMin)</td>
<td valign="top">WaterFresnelMax = 0.8; </td>

</tr>
<tr>

<td valign="top">'''WaterFresnelPower'''</td>
<td valign="top">-no clue-</td>
<td valign="top">WaterFresnelPower = 4; </td>

</tr>
<tr>

<td valign="top">'''WaterReflectionDistortion'''</td>
<td valign="top">How much the surface should distort reflections that are cause by waves not being level: ergo it adds more choppyness to your reflections sensible from 0 to 20</td>
<td valign="top">WaterReflectionDistortion = 0.1; </td>

</tr>
<tr>

<td valign="top">'''WaterBlurBase'''</td>
<td valign="top">Something to do with blur, but it just seems to cause banding with values under 2 and corruption with values above 10</td>
<td valign="top">WaterBlurBase = 2; </td>

</tr>
<tr>

<td valign="top">'''WaterBlurExponent'''</td>
<td valign="top">How much reflections on water surface should be blurred together with the water surface, lower values meaning clearer reflections, (0.2-5) Warning: above 5 seems to cause water corruption</td>
<td valign="top">WaterBlurExponent = 2; </td>

</tr>
<tr>

<td valign="top">'''WaterPerlinStartFreq'''</td>
<td valign="top">Wave sizes, smaller = big waves, sensible: 1-20 (influence the wave sizes) default=8</td>
<td valign="top">WaterPerlinStartFreq = 8; </td>

</tr>
<tr>

<td valign="top">'''WaterPerlinLacunarity'''</td>
<td valign="top">new, any float; seems to define the size of the perlin waves, small values being big waves (0.2-5 is sensible) default= 3</td>
<td valign="top">WaterPerlinLacunarity = 3; </td>
</tr>
<tr>

<td valign="top">'''WaterPerlinAmplitude'''</td>
<td valign="top">Base stillness of water surface, 0 is dead still, 1 is 'windy' .This doesnt affect the bump texture depth, besides the fact that this disables the bump texture when set to 0 default=0.9 </td>
<td valign="top">WaterPerlinAmplitude= 0.9; </td>

</tr>

</table>

Maps:Compiling

2009-08-31T17:57:14Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== Compiling Spring Maps ==

This is often the bit that scares a lot of people off, but it is really not that difficult. 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.

'''**NOTE!** IF YOU EVER GET JUST A PINK TEXTURE AFTER COMPILING THE ISSUE IS THAT YOU EITHER RENAMED THE FILES AFTER COMPILING OR CHANGED THE DIRECTORY STRUCTURE! THE SMD, SMT, AND SMF FILES MUST BE ALL CONTAINED WITHIN A DIRECTORY INSIDE YOUR ARCHIVE NAMED "maps"!!!'''

=== Before you start ===

First off, download a map converter. These can be found on [http://spring.jobjol.nl/ spring.jobjol.nl]. There are two compilers that most people use:
* [http://spring.jobjol.nl/show_file.php?id=1745 mother's MapConv with 'optimization'] This version should work for everyone, it has the no scanlines hack included. Works just like its described below.
* [http://www.fileuniverse.com/?p=showitem&ID=1507 Users mapconv (link broken), without optimization] Use this if you feel adventurous or need very special features.

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 practice 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 (mapsize*64*8 pixels)
* Height.bmp (mapsizesize*8+1 pixels)
* Metal.bmp (mapsize*8+1 pixels)
* Feature.bmp (mapsize*8 pixels)

All .bmp files should be 24bit RGB bitmaps.

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''' will give a compression of 0. Range is 0-1, where 0 is no compression, and will make you final map file size very large. **NOTE** NEVER USE THE SMF COMPRESSION, IT IS UTTERLY USELESS! (Further note, its not useles, just ugly. If your making a map thats bigger than 16*16, then I advise you to use it to save on the file size and texture memory. Values of up to 0.6 wont cause too noticable loss in quality, while still reducing file size.)

'''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 terrain type map.
Please note that these names cannot contain 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 helpful, some are annoying and some are just a mystery. This is basically 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'''. Very useful feature if your heightmap is a bit noisy but you dont want to lose detail by blurring/smoothing it in an image manipulation program
*'''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. With invert option enabled, black areas on the heightmap will correspond do the lowest points on the map.

=== 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 -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 -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'''.

=== Testing your map ===

Most often, its very annoying to have to zip and replace your map files for them to work. There is a very simple workaround that allows you, for example, to edit your .smd file and not have to zip it all up again:

Create a '''Mapname.sdd''' '''directory''' in your spring/maps folder, and copy the all the files you would normally place into the zipped map into it. This will allow Spring to load the map just as if it were 7zipped and renamed to .sd7

Example file placing:
Spring/maps/Mapname.sdd/maps/Mapname.smd

After you've got everything fine tuned, you can 7zip the map for distribution.

=== 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]]

MapsBalance

2009-08-31T17:56:59Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== Making properly balanced maps ==
So, you're making a map. But how much resources should it have?

Don't regard this as of little relevance! This is very important!

All units in unit sets are balanced assuming that, for example, metal is x harder to get than energy. If your map has, for example, too much metal, units that cost more onto the metal side than energy side become unbalancedly cheap.

== Resource Standards ==
When making maps, these are the standards for resources:

'''Metal:'''
*The amount per normal metal extractor is between 0.7 and 2.5
*The amount of total metal in all patches, when beeing extracted by normal metal extractors, is about 5~15 per player, assuming each player is controlling about a quarter of the map. It should be noted, though, that this metal should be SPREAD OUT, not all located at the start position.

'''Energy:'''
*The amount of tidal energy is almost always 20
*The amount of solar energy is almost always 20
*The amount of wind, is usually 1(min)~25(max) or some other min~max values that average between 7 and 13
*The amount of geothermals available to each player generally varies widely depending on the map. A good guideline is to usually have 1 geothermal for every 2 players as a minimum, or 2 geothermals per player as a maximum.

Standards are just that, standards, and you don't HAVE to follow them. But it's better not to go too overboard with resources or use diferent standards very frequently. For example an interesting variation may be to increase the amount of metal generated per extractor, but reduce the number of extractors, so that the total metal available is not changed significantly.

In all cases, less metal = more strategy. Too little metal is always better than too much. This point cannot be stressed too much.

== Gravity ==
When making maps, the standard gravity is '''140''', or so some assume. No clear "default" value has actually be given by the developers, but it most likely lies somewhere between 100 and 150. If you decide to use a value much higher value, units that fire balistic projectiles (cannons) may not be able to fire their projectiles at the intended range. Be sure to test your map alot before releasing it if you are going to change the gravity drastically.

== Resource Dynamics ==
This section is dedicated to a more throughout explanation of the workings of the resources in Spring so you can balance your map accordingly.

'''Metal:'''

Additional info needed.

'''Energy:'''

A somewhat edited quote from the map forum (thus not a true quote);

"On the wind issue I belive somewhere around 0-20 or 0-30 is pretty reasonable for a map where you want wind to be the "best" option, which it wasn't on all TA maps. Although wind was viable on most maps with the expection of the moon maps.
Relying on wind for your energy needs has always been a risky move though, even on maps where it has proven to be useful, because you might just get stuck with all of your generators giving an output of 1, thus ruining your economy for the moment. I hope it stays this way in TA, and personally I find the suggestion that you'd need 30-40 as an average output for wind to be viable quite odd, as online play in TA has shown that's not true.
Just for reference, two maps where almost only wind was used in TA are GoW and PD. In GoW I belive the wind varied between 3 to 27, while on PD it was between 1 (or 0, not sure) to 24.

From what I've discussed so far though (with old TA players), most seems to agree that once the average income goes to 7 or above, wind quickly becomes the better option. Some do favor having a few solars just as a backup, but overall wind quickly becomes the better option for your main source of energy income, the solars will at most get the postion of a small backup. It can lead to the added investment of energy storages though.

From this you can easily come to your own conclusions, there are however some minor points that I would want to add. First of, you have to take into account that solars in XTA doesn't cost any energy at all, this is however something that mostly comes into play if your current source of energy is getting destroyed, so you lack energy.
The other thing I want to add is a short overview of the advantages of the two different sources of energy, ordered by (from my point of view and without taking into account the lack of energy cost for the XTA solar) importance;
1) The wind generator costs less, only 1/3 of a solar. An average income of 7 will thus already put it as the better choice theoretically.
2) The wind generator builds quicker, this means you will start to get your energy income faster too which might matter quite a bit.
3) The solar gives you a constant supply of energy that does not vary.
4) The solar is better armored than the wind generator. I'm not sure if 3 wind generators have more health than a single solar though (you also have to take into account that they are often built next to each other, so when one goes it will damage the ones next to it).
5) A single solar takes less space than 3 wind generators. Once the average wind income from a single generator is 20 or above this points becomes moot though, but before that it can potentially be important on certain maps.
6) A solar usually leaves a "better" wreckage, thus yielding you more metal when you reclaim it. This of course means it was destroyed in the first place, which never is that good.

This is all disregarding the tidal of course, but that's another matter entirely as it needs water to be built. It works by the same principle as the solar however, the difference being that the wind generator is only Ã‚Â½ the cost of the tidal. There are also some other differences compared to the solar of course (size, armor etc), but generally it should be pretty straightforward to decide if its worth the cost or not if you already understand the relation between solars and wind generators.

One more note about wind, if I remember correctly. In OTA the wind was highest on the barren worlds (ice/desert etc), while it wasn't a real option on moon maps."

'''A short summary of this "quote" reads as follows;'''

Wind generators starts to become the best choice as soon as the average energy income from a single generator goes above 7. As the average gets higher the wind generators quickly become the only real choice if you want to win.
If your map does have an average income of 7 or above, the only real benifits of a solar is more armor, constant supply, less space and finally it usually leaves wreckage behind.
A single solar costs 3 times that of a wind generator, a single tidal costs 2 times the amount of a wind generator.

[[Category:Map making]]

MapSizes

2009-08-31T17:56:44Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

This table shows you how big the map is in pixels. And some other useless information.
 
<hr>
 
<table border=1>
<tr>
<td>TASpring Map size</td>
<td>Size in pixels</td>
<td>1/8 size in pixels</td>
<td>(Square) Mem usage in MB (24bit)</td>
<td>(Square) Mem usage in MB (32bit)</td>
<td>(Square) Saved blocks</td>
<td>(Square) Max tile size</td>
</tr>
<tr>
<td>2</td>
<td>1024</td>
<td>128</td>
<td>3</td>
<td>4</td>
<td>1</td>
<td>1024</td>
</tr>
<tr>
<td>4</td>
<td>2048</td>
<td>256</td>
<td>12</td>
<td>16</td>
<td>4</td>
<td>4096</td>
</tr>
<tr>
<td>6</td>
<td>3072</td>
<td>384</td>
<td>27</td>
<td>36</td>
<td>9</td>
<td>9216</td>
</tr>
<tr>
<td>8</td>
<td>4096</td>
<td>512</td>
<td>48</td>
<td>64</td>
<td>16</td>
<td>16384</td>
</tr>
<tr>
<td>10</td>
<td>5120</td>
<td>640</td>
<td>75</td>
<td>100</td>
<td>25</td>
<td>25600</td>
</tr>
<tr>
<td>12</td>
<td>6144</td>
<td>768</td>
<td>108</td>
<td>144</td>
<td>36</td>
<td>36864</td>
</tr>
<tr>
<td>14</td>
<td>7168</td>
<td>896</td>
<td>147</td>
<td>196</td>
<td>49</td>
<td>50176</td>
</tr>
<tr>
<td>16</td>
<td>8192</td>
<td>1024</td>
<td>192</td>
<td>256</td>
<td>64</td>
<td>65536</td>
</tr>
<tr>
<td>18</td>
<td>9216</td>
<td>1152</td>
<td>243</td>
<td>324</td>
<td>81</td>
<td>82944</td>
</tr>
<tr>
<td>20</td>
<td>10240</td>
<td>1280</td>
<td>300</td>
<td>400</td>
<td>100</td>
<td>102400</td>
</tr>
<tr>
<td>22</td>
<td>11264</td>
<td>1408</td>
<td>363</td>
<td>484</td>
<td>121</td>
<td>123904</td>
</tr>
<tr>
<td>24</td>
<td>12288</td>
<td>1536</td>
<td>432</td>
<td>576</td>
<td>144</td>
<td>147456</td>
</tr>
<tr>
<td>26</td>
<td>13312</td>
<td>1664</td>
<td>507</td>
<td>676</td>
<td>169</td>
<td>173056</td>
</tr>
<tr>
<td>28</td>
<td>14336</td>
<td>1792</td>
<td>588</td>
<td>784</td>
<td>196</td>
<td>200704</td>
</tr>
<tr>
<td>30</td>
<td>15360</td>
<td>1920</td>
<td>675</td>
<td>900</td>
<td>225</td>
<td>230400</td>
</tr>
<tr>
<td>32</td>
<td>16384</td>
<td>2048</td>
<td>768</td>
<td>1024</td>
<td>256</td>
<td>262144</td>
</tr>
<tr>
<td>34</td>
<td>17408</td>
<td>2176</td>
<td>867</td>
<td>1156</td>
<td>289</td>
<td>295936</td>
</tr>
<tr>
<td>36</td>
<td>18432</td>
<td>2304</td>
<td>972</td>
<td>1296</td>
<td>324</td>
<td>331776</td>
</tr>
<tr>
<td>38</td>
<td>19456</td>
<td>2432</td>
<td>1083</td>
<td>1444</td>
<td>361</td>
<td>369664</td>
</tr>
<tr>
<td>40</td>
<td>20480</td>
<td>2560</td>
<td>1200</td>
<td>1600</td>
<td>400</td>
<td>409600</td>
</tr>
<tr>
<td>42</td>
<td>21504</td>
<td>2688</td>
<td>1323</td>
<td>1764</td>
<td>441</td>
<td>451584</td>
</tr>
<tr>
<td>44</td>
<td>22528</td>
<td>2816</td>
<td>1452</td>
<td>1936</td>
<td>484</td>
<td>495616</td>
</tr>
<tr>
<td>46</td>
<td>23552</td>
<td>2944</td>
<td>1587</td>
<td>2116</td>
<td>529</td>
<td>541696</td>
</tr>
<tr>
<td>48</td>
<td>24576</td>
<td>3072</td>
<td>1728</td>
<td>2304</td>
<td>576</td>
<td>589824</td>
</tr>
<tr>
<td>50</td>
<td>25600</td>
<td>3200</td>
<td>1875</td>
<td>2500</td>
<td>625</td>
<td>640000</td>
</tr>
<tr>
<td>52</td>
<td>26624</td>
<td>3328</td>
<td>2028</td>
<td>2704</td>
<td>676</td>
<td>692224</td>
</tr>
<tr>
<td>54</td>
<td>27648</td>
<td>3456</td>
<td>2187</td>
<td>2916</td>
<td>729</td>
<td>746496</td>
</tr>
<tr>
<td>56</td>
<td>28672</td>
<td>3584</td>
<td>2352</td>
<td>3136</td>
<td>784</td>
<td>802816</td>
</tr>
<tr>
<td>58</td>
<td>29696</td>
<td>3712</td>
<td>2523</td>
<td>3364</td>
<td>841</td>
<td>861184</td>
</tr>
<tr>
<td>60</td>
<td>30720</td>
<td>3840</td>
<td>2700</td>
<td>3600</td>
<td>900</td>
<td>921600</td>
</tr>
<tr>
<td>62</td>
<td>31744</td>
<td>3968</td>
<td>2883</td>
<td>3844</td>
<td>961</td>
<td>984064</td>
</tr>
<tr>
<td>64</td>
<td>32768</td>
<td>4096</td>
<td>3072</td>
<td>4096</td>
<td>1024</td>
<td>1048576</td>
</tr>
</table>

MapSizes

2009-08-31T17:56:36Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

 
 
This table shows you how big the map is in pixels. And some other useless information.
 
<hr>
 
<table border=1>
<tr>
<td>TASpring Map size</td>
<td>Size in pixels</td>
<td>1/8 size in pixels</td>
<td>(Square) Mem usage in MB (24bit)</td>
<td>(Square) Mem usage in MB (32bit)</td>
<td>(Square) Saved blocks</td>
<td>(Square) Max tile size</td>
</tr>
<tr>
<td>2</td>
<td>1024</td>
<td>128</td>
<td>3</td>
<td>4</td>
<td>1</td>
<td>1024</td>
</tr>
<tr>
<td>4</td>
<td>2048</td>
<td>256</td>
<td>12</td>
<td>16</td>
<td>4</td>
<td>4096</td>
</tr>
<tr>
<td>6</td>
<td>3072</td>
<td>384</td>
<td>27</td>
<td>36</td>
<td>9</td>
<td>9216</td>
</tr>
<tr>
<td>8</td>
<td>4096</td>
<td>512</td>
<td>48</td>
<td>64</td>
<td>16</td>
<td>16384</td>
</tr>
<tr>
<td>10</td>
<td>5120</td>
<td>640</td>
<td>75</td>
<td>100</td>
<td>25</td>
<td>25600</td>
</tr>
<tr>
<td>12</td>
<td>6144</td>
<td>768</td>
<td>108</td>
<td>144</td>
<td>36</td>
<td>36864</td>
</tr>
<tr>
<td>14</td>
<td>7168</td>
<td>896</td>
<td>147</td>
<td>196</td>
<td>49</td>
<td>50176</td>
</tr>
<tr>
<td>16</td>
<td>8192</td>
<td>1024</td>
<td>192</td>
<td>256</td>
<td>64</td>
<td>65536</td>
</tr>
<tr>
<td>18</td>
<td>9216</td>
<td>1152</td>
<td>243</td>
<td>324</td>
<td>81</td>
<td>82944</td>
</tr>
<tr>
<td>20</td>
<td>10240</td>
<td>1280</td>
<td>300</td>
<td>400</td>
<td>100</td>
<td>102400</td>
</tr>
<tr>
<td>22</td>
<td>11264</td>
<td>1408</td>
<td>363</td>
<td>484</td>
<td>121</td>
<td>123904</td>
</tr>
<tr>
<td>24</td>
<td>12288</td>
<td>1536</td>
<td>432</td>
<td>576</td>
<td>144</td>
<td>147456</td>
</tr>
<tr>
<td>26</td>
<td>13312</td>
<td>1664</td>
<td>507</td>
<td>676</td>
<td>169</td>
<td>173056</td>
</tr>
<tr>
<td>28</td>
<td>14336</td>
<td>1792</td>
<td>588</td>
<td>784</td>
<td>196</td>
<td>200704</td>
</tr>
<tr>
<td>30</td>
<td>15360</td>
<td>1920</td>
<td>675</td>
<td>900</td>
<td>225</td>
<td>230400</td>
</tr>
<tr>
<td>32</td>
<td>16384</td>
<td>2048</td>
<td>768</td>
<td>1024</td>
<td>256</td>
<td>262144</td>
</tr>
<tr>
<td>34</td>
<td>17408</td>
<td>2176</td>
<td>867</td>
<td>1156</td>
<td>289</td>
<td>295936</td>
</tr>
<tr>
<td>36</td>
<td>18432</td>
<td>2304</td>
<td>972</td>
<td>1296</td>
<td>324</td>
<td>331776</td>
</tr>
<tr>
<td>38</td>
<td>19456</td>
<td>2432</td>
<td>1083</td>
<td>1444</td>
<td>361</td>
<td>369664</td>
</tr>
<tr>
<td>40</td>
<td>20480</td>
<td>2560</td>
<td>1200</td>
<td>1600</td>
<td>400</td>
<td>409600</td>
</tr>
<tr>
<td>42</td>
<td>21504</td>
<td>2688</td>
<td>1323</td>
<td>1764</td>
<td>441</td>
<td>451584</td>
</tr>
<tr>
<td>44</td>
<td>22528</td>
<td>2816</td>
<td>1452</td>
<td>1936</td>
<td>484</td>
<td>495616</td>
</tr>
<tr>
<td>46</td>
<td>23552</td>
<td>2944</td>
<td>1587</td>
<td>2116</td>
<td>529</td>
<td>541696</td>
</tr>
<tr>
<td>48</td>
<td>24576</td>
<td>3072</td>
<td>1728</td>
<td>2304</td>
<td>576</td>
<td>589824</td>
</tr>
<tr>
<td>50</td>
<td>25600</td>
<td>3200</td>
<td>1875</td>
<td>2500</td>
<td>625</td>
<td>640000</td>
</tr>
<tr>
<td>52</td>
<td>26624</td>
<td>3328</td>
<td>2028</td>
<td>2704</td>
<td>676</td>
<td>692224</td>
</tr>
<tr>
<td>54</td>
<td>27648</td>
<td>3456</td>
<td>2187</td>
<td>2916</td>
<td>729</td>
<td>746496</td>
</tr>
<tr>
<td>56</td>
<td>28672</td>
<td>3584</td>
<td>2352</td>
<td>3136</td>
<td>784</td>
<td>802816</td>
</tr>
<tr>
<td>58</td>
<td>29696</td>
<td>3712</td>
<td>2523</td>
<td>3364</td>
<td>841</td>
<td>861184</td>
</tr>
<tr>
<td>60</td>
<td>30720</td>
<td>3840</td>
<td>2700</td>
<td>3600</td>
<td>900</td>
<td>921600</td>
</tr>
<tr>
<td>62</td>
<td>31744</td>
<td>3968</td>
<td>2883</td>
<td>3844</td>
<td>961</td>
<td>984064</td>
</tr>
<tr>
<td>64</td>
<td>32768</td>
<td>4096</td>
<td>3072</td>
<td>4096</td>
<td>1024</td>
<td>1048576</td>
</tr>
</table>

Tutorial:HeightMapWithPOVRay(RogerN)

2009-08-31T17:56:27Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

==Overview==

Most of the other Spring mapping tutorials focus primarily on the technical aspects of mapping related to compilation (e.g. how to compile your map, what size your height map should be, how to place features, etcÃ¢â‚¬Â¦). Consequently, this tutorial will not go into those details. Instead, this document will focus solely on some tips for creating height maps.

==Required Tools==

In order to make this tutorial accessible to everyone, the tools weÃ¢â‚¬â„¢ll be using are free, open source programs. WeÃ¢â‚¬â„¢re going to be using a generic painting / image processing program and a ray-tracer. These programs are:

[http://www.gimp.org GIMP]: Best described as a Photoshop clone, this is an extremely useful image processing tool. It offers many of the same features as Adobe Photoshop at a much more reasonable price ($0).

[http://www.povray.org POV-Ray]: As a ray-tracer, POV-Ray is primarily designed to render 3D images. WeÃ¢â‚¬â„¢ll be using it to preview our height map in 3D. However, the program also has some tricks we can use to tweak our height map directly. Eventually we can also use POV-Ray to render the final texture for our map (covered in a different tutorial).

Once youÃ¢â‚¬â„¢ve installed the above programs (or Photoshop instead of GIMP), thereÃ¢â‚¬â„¢s one other file you ought to download and extract:

[http://webpages.charter.net/kgnorris/HeightMapTut/HeightMapTutorialFiles.zip Tutorial POV-Ray files]: This archive contains some POV-Ray input files that weÃ¢â‚¬â„¢ll be using throughout the tutorial.

==A Simple Hill==

{|
|- valign="top"
|
In this first section of the tutorial weÃ¢â‚¬â„¢ll be creating a height map for a 4x4 Spring map. This means that our height map needs to be 257 x 257 pixels. So, start up GIMP and create a new image by clicking "File > New".
|[[Image:RogerNTut1_CreateImage.png]]
|}

{|
|- valign="top"
|
[[Image:RogerNTut1_BucketFill.png]]
|To get our image ready for use, fill the entire image with black. Select black as your foreground color and then use the bucket fill tool to paint the whole thing black.
|}
 
{|
|- valign="top"
|
[[Image:RogerNTut1_Lasso.png]]
|Now we want to create a simple hill in the center of our map. Begin by selecting white as your foreground color. Next, we want to select the region which is going to be the top of our hill. Activate the lasso tool.
|}
 
{|
|- valign="top"
|
Use the lasso tool to outline a region in the center of the height map. This will be the top of our hill. DonÃ¢â‚¬â„¢t make your selection too close to any of the sides because weÃ¢â‚¬â„¢ll need some space around the edges later (the slopes going up our hill need space).
|[[Image:RogerNTut1_SelectRegion.png]]
|}
 
{|
|- valign="top"
|
Before we fill our selected region we want to ensure that our hill has gradual slopes (rather than a sheer face). Right-click the image and click "Select > Feather..." WeÃ¢â‚¬â„¢re going to use 30 pixels here to give a very gradual slope.
|[[Image:RogerNTut1_Feather.png]]
|}
 
{|
|- valign="top"
|
Now weÃ¢â‚¬â„¢re ready to draw the hill. Select white as your foreground color. Then right-click the image and click "Edit > Fill with FG color." Now we ought to have a hill in the center of our image with a nice gradient for the slopes.
|[[Image:RogerNTut1_Feathered.png]]
|}

Our relatively simple hill is complete for now, so save the image as a bitmap in the same folder as the tutorial files downloaded previously. Right-click the image and click "File > Save as..."

==Viewing in 3D==

Before we continue to tweak our hill, weÃ¢â‚¬â„¢d like to know what it looks like in 3D. POV-Ray can help us quickly render the height map in 3D.

Start up POV-Ray. Open the provided tutorial file, "Render3DHeight.pov". We have a few settings we want to check before we click run.

Near the top of the POV-Ray file you should see a section for Spring settings. We need to modify these settings for our current project. Specifically, we need to change the height map file name, the map size, and the altitude settings.

Change the height map file to match the name of the bitmap we saved in step 1. The next setting, ViewAngle, is fine at the default for now. The altitude settings need to match what weÃ¢â‚¬â„¢ll eventually use for the map compiler Ã¢â‚¬â€œ for now, choose 100 for the min and 500 for the max. Our Spring map size should be set to 4 x 4.

[[Image:RogerNTut1_SpringSettings1.png]]

WeÃ¢â‚¬â„¢re almost ready to render the 3D image. The last thing to do is pick the render resolution. Either use the drop-down box in the toolbar to select one of the common resolutions, or use the adjacent text box to type the resolution options directly:

[[Image:RogerNTut1_Resolution.png]]

Now click the Run button on the tool bar. You ought to get a 3D picture of our simple hill.

[[Image:RogerNTut1_SimpleHill3D.jpg]]

==Making it realistic==

Unfortunately, our simple hill looks quite unrealistic at the moment. The slopes are too regular to be believable. There are many techniques we can use to spice it up a bit. In this step weÃ¢â‚¬â„¢ll be examining a simple POV-Ray trick for improving our height map.

Using POV-Ray again, open the provided tutorial file "RenderTurbulence.pov". This file will help us add some entropy to our height map to make it look more natural.

Once again, we need to modify some settings near the top of the file. Locate the Spring settings near the top and modify them to match our current project. We need to set the name of our height map file, and the map size:

[[Image:RogerNTut1_SpringSettings2.png]]

Immediately below the map size are settings for turbulence and noise. These settings control the style and amount of randomness or distortion that will be added to our height map. The default values ought to work fine. However, feel free to play around with the settings to get results that you like.

One important task remains before rendering a new height map. We need to ensure that POV-Ray is set to use the correct resolution! Remember that our height map needs to be 257 x 257 pixels. Use the text box in the POV-Ray tool bar to specify the output resolution:

[[Image:RogerNTut1_OverrideRes.png]]

When you click the Run button in the tool bar, you should see a new version of the height map for our simple hill. POV-Ray has taken our original height map as input and added some turbulence to the image:

[[Image:RogerNTut1_Turbulence.jpg]]

Note that POV-Ray has saved the new image as "RenderTurbulence.bmp", and has not overwritten our original height map. Also, after applying turbulence in this fashion it is sometimes necessary to apply a small Gaussian blur to smooth out the rough edges (using GIMP, choose "Filters > Blur > Gaussian Blur...", radius 2). If POV-Ray renders the height map in 3D with small holes in some areas then the height map ought to be smoothed / blurred.

So what does our height map look like in 3D now that weÃ¢â‚¬â„¢ve added turbulence? Return to "Render3DHeight.pov" in order to find out. Remember that our original height map hasnÃ¢â‚¬â„¢t changed, so we need to update the file name to "RenderTurbulence.bmp".

The new height map looks something like this when rendered in 3D:

[[Image:RogerNTut1_Turbulence3d.jpg]]

Not bad! ItÃ¢â‚¬â„¢s definitely more realistic than our first attempt. At this point I recommend that you play around with the various turbulence / noise settings, to see how they affect the results. The default values use only turbulence; be sure to try increasing the NoiseAmplitude.

==Create a mountain range==

In creating the template for our simple hill (step #1) we used a feathered selection to generate a rounded hilltop. This section of the tutorial will demonstrate a slightly different approach which may yield better results for mountains (not hills). Mountains differ from hills in that they tend to be pointed at the top and more angular in shape.

Start up GIMP and create another 257 x 257 height map. Fill the image with black, as before.

Now, using the lasso tool, select a roughly triangular region:

[[Image:RogerNTut1_Triangle.png]]

Next we want to use the gradient tool to fill in our triangular region. First, select the gradient tool.

[[Image:RogerNTut1_Gradient.png]]

Ensure that the foreground color is set to white, and that the background color is set to black. With the gradient tool selected, ensure that the Shape is set to "Shaped (angular)."

[[Image:RogerNTut1_GradientSettings.png]]

Click anywhere inside the selected region and drag the mouse a short distance. When you release the mouse button, the gradient tool will fill our selection:

[[Image:RogerNTut1_FilledTriangle.png]]

By itself this would be a pretty poor (and lonely) mountain, even with turbulence and noise added. But by repeating the process several times (with different shades of gray) we can make a nice mountain range. Use GIMP layers set to Screen in order to overlay mountains effectively.

[[Image:RogerNTut1_mount1.jpg]]

[[Image:RogerNTut1_mount2.jpg]]

In the 3D screenshot note that weÃ¢â‚¬â„¢ve added some turbulence (settings were tweaked to get good results) and blurred the results a bit.

[[Category:Map making]]

Tutorial:MapWithPOVRay(Tinnut)

2009-08-31T17:54:14Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== Howto ==
'''Create a map's texture using Povray to generate the texture'''

!! This is currently a work in progress and make take some time to complete. !!

=== Intro ===
This guide will take you through creating a texture for a Spring map using the freeware Povray program. Povray is an excellent [http://en.wikipedia.org/wiki/Ray_tracing raytracing] application that generates "scene" images using a scene definition language in a text file. We can use it to create a map's texture by creating a heightfield object, putting our "camera" directly over the object, setting the camera to orthographic, and rendering a bitmap at our map's dimension. The steps below will give you an easy enough to follow process to generate a nice map, but if you want to create different maps you'll need to learn Povray's scene definition language. This language is easy enough to follow, but depending on your tastes you could be better off using a tool that specialises in maps and map textures, such as the excellent [http://www.bundysoft.com/L3DT/ L3DT].

The guide does not cover other aspects of map creation (heighmaps, features, metal, compiling, etc), but there are a few excellent guides within the Wiki that already cover those steps.

Povray is available for both Windows and Linux. I have only tested these steps under Windows, but they should work under Linux.

Please note that a lot of the maths used in the scene definition file has only been tested on a 16x16 map (8192x8192 pixels).

Warning: The base textures I use in this example are all mostly rubbish that I created in a couple of minutes. I would suggest that you do not use them in your own maps :)

=== Initial Steps ===
1) Download and install Povray: [http://www.povray.org/ Povray Site]

2) Create a working folder for your map, for this example, we'll make C:\PovMap

3) Create a heightmap using whatever program (I like [http://www.gimp.org/ The GIMP], which is good, and it's free). Here is the one we'll use for our map (I created this in a hurry and it was quite a mistake that it ended up so similar to Altered Divide):

[http://img441.imageshack.us/my.php?image=povmapheightbp9.png http://img441.imageshack.us/img441/8862/povmapheightbp9.th.png]

Your map will need to be named povmap_height.png, but if you want to use another name, just update the pov script below to use your heightmap's actual name.

4) For our example, we'll be defining three different elevation levels for which there are different terrain textures, these will be (each at 512x512):

4.1) Lowest elevation (low lying areas):

[http://img176.imageshack.us/my.php?image=level1zd7.png http://img176.imageshack.us/img176/953/level1zd7.th.png]

4.2) Middle elevation (main map surface):

[http://img170.imageshack.us/my.php?image=level2pf6.png http://img170.imageshack.us/img170/6473/level2pf6.th.png]

4.3) Highest elevation (mountains):

[http://img176.imageshack.us/my.php?image=level3wv7.png http://img176.imageshack.us/img176/6159/level3wv7.th.png]

5) Now also for our example, we'll be defining two different textures to be used by sloping areas, one for slopes in the lower elevation areas of the map, and another for slopes in the higher elevations:

5.1) Lower elevations:

[http://img411.imageshack.us/my.php?image=slope1on6.png http://img411.imageshack.us/img411/2153/slope1on6.th.png]

5.2) Higher elevations:

[http://img411.imageshack.us/my.php?image=slope2fk7.png http://img411.imageshack.us/img411/8908/slope2fk7.th.png]

6) Create an empty text file in your C:\Povmap folder named gen_pov_texture.pov

7) Copy the following povray scene code into the above file:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>

// Setup some parameters that we will use within the script
#declare MAP_WIDTH=8192;
#declare MAP_HEIGHT=8192;
#declare MAP_EL=600; // elevation

global_settings {
// ambient light level
ambient_light rgb<1,1,1>
}

// Set a directional light
light_source {
<100,-100,100> * 20, color rgb 1
parallel
point_at <1, 0, 0>
}

// Set the background colour
background {rgb<1,1,1>}

// Define our camera position, and set it to "orthographic" (important :)
camera {
orthographic
location <0,0,MAP_EL + 90> // position & direction of view
look_at <0,0,0>
right MAP_WIDTH*x // horizontal size of view
up MAP_HEIGHT*z // vertical size of view
}

// ** Define our primary textures **

// lowest texture (512 x 512)
// Found in low lying areas of the heightfield
#declare level1_texture =
texture {
pigment {
image_map {
png "level1.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// middle texture (512 x 512)
// Found in the middle areas of the heightfield
#declare level2_texture =
texture {
pigment {
image_map {
png "level2.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// highest texture (512 x 512)
// Found in the peaks / hills / mountains of the heightfield
#declare level3_texture =
texture {
pigment {
image_map {
png "level3.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// Define a texture that blends from one level's texture to the next,
// depending on elevation:
#declare levels_elevation_texture=
texture {
gradient z

texture_map {
[0.00 level1_texture] // from 0.0 to 0.1 we have just level1.png
[0.10 level1_texture]
// from 0.1 to 0.2 we blend from level1.png to level2.png
[0.30 level2_texture] // from 0.2 to 0.5 we have just level2.png
[0.40 level2_texture]
// from 0.5 to 0.6 we blend from level2.png to level3.png
[0.60 level3_texture] // from 0.6 to 1.0 we have just level2.png
[1.00 level3_texture]
}
}

// ** Define textures used on areas of slope

// lower slope texture (512 x 512)
#declare slope1_texture =
texture {
pigment {
image_map {
png "slope1.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// upper slope texture (512 x 512)
#declare slope2_texture =
texture {
pigment {
image_map {
png "slope2.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// Define a texture that blends from one slope's texture to the next,
// depending on elevation:
#declare slopes_elevation_texture=
texture {
gradient z

texture_map {
[0.00 slope1_texture]
[0.30 slope1_texture]

[0.65 slope2_texture]
[1.00 slope2_texture]
}
}

// ** Now define the final texture blending between the height textures
// and the slope textures:
#declare final_texture =
texture {
slope {
<0,0,-1>, 0, 0.5
}
texture_map {
[0.00 levels_elevation_texture]
[0.06 levels_elevation_texture]
[0.40 slopes_elevation_texture]
[1.00 slopes_elevation_texture]
}
}

// ***!! Now we declare our heightfield object that uses this texture
#declare primaryHF=
height_field {
png "povmap_height.png"
smooth // smooth the heightfield
no_shadow // you may want to remove this
translate <-.5, -.5, -.5>
rotate <90,0,0> // rotate it so that the projection of the texture is correct
scale <1,-1,1> // invert the y axis
translate <0.5, 0.5, 0.5>
texture {
final_texture
}

// now scale to the maps height x width
scale <MAP_WIDTH, MAP_HEIGHT, MAP_EL>
// and center it for the camera
translate <-MAP_WIDTH/2, -MAP_HEIGHT/2, -MAP_EL/2>
}

// ** If you're going to add the metal placement stuff
// ** described below, you need to put it here!

object {primaryHF}

</pre>
|}

What we're essentially doing above is:

* Setting up scene parameters: lighting, the orthographic camera, etc.

* Defining a set of textures to display at different elevations and different slopes; and

* Defining a heightmap that uses our png image and applies our texture to this object

8) Double click on your gen_pov_texture.pov file so that it opens up in Povray.

9) Add a new render size (8192 x 8192):

9.1) Drop down menu "Render" > "Edit Settings/Render" > Click "Edit" button

9.2) Add text at bottom of file:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
[8192x8192, No AA Spring]
Width=8192
Height=8192
Antialias=Off
</pre>
|}

9.3) Save file

10) Restart Povray so that it re-reads the ini-file

11) Select your new render size and click Render. This creates a bitmap file: gen_pov_texture.bmp

12) Convert to gen_pov_texture.bmp to a png file if you're using the new mapconv (it doesn't seem to like bitmaps). I personally use [http://www.imagemagick.org/ imagemagick] to do this as it has a simple command line program "convert.exe" that will convert an image from one format to another and it works well with the very large bitmap image that comes out of the above steps.

13) Do all the other map stuff: metal placement bitmap, feature placement bitmap, smd file

14) Compile your map with mapconv

15) Test it :)

== Advanced stuff ==
Check out your help file that came with Povray. There is a LOT that you can do!

=== Complex Texture Map Combinations ===
As you can see from the pov code above, a "texture" declaration can be an image (called an "image_map"), but it can also be a definition of a blend between any number of earlier defined textures (called a "texture_map"), which is based on a function. In the above example, it uses the "gradient" function for changes in elevation, and the "slope" function for changes in slope. It is possible to define much more complex sets of textures than those defined above, such as mixing different combination of slope mapings with combinations of elevation mapings.

Our blend function could actually be an image if you wanted finer control of a map's texture, by having sections of metal mixed with sections of wilderness, for example. To do this, you would:

1) Create a new png image the same size as your heightmap (although you could make it larger or smaller) and paint sections of the map that are to use your wilderness textures in white, and the sections that are to use your metal texture in black. For effect you could do a slight blur on the image to create grey coloured transitions where the two sections meet. For our example I created this:

[http://img185.imageshack.us/my.php?image=texturedistributionpa8.png http://img185.imageshack.us/img185/2641/texturedistributionpa8.th.png]

3) Change the "final_texture" texture name in your script to "final_nature_texture"

4) Define a set of textures in a similar manner that define your metal textures (based on heights and slopes), with the final blended metal texture named "final_metal_texture". Don't forget to give them different names than the wilderness texture names are.

5) Create a new "final_texture" that is:

{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
#declare final_texture =
texture {
image_pattern { png "texture_distribution.png" }
texture_map {
[0.00 final_metal_texture]
[1.00 final_nature_texture]
}
}
</pre>
|}

Here is a screen shot of our map using this:

[http://img341.imageshack.us/my.php?image=screen000wd0.png http://img341.imageshack.us/img341/43/screen000wd0.th.png]

=== Procedural Textures ===
It is also possible to use "procedural textures" instead of image_map textures. These can be quite useful for areas on your map that have a high slope as they can create a better looking texture, including effects such as the layered rock textures - like "Painted Rock". Unfortunately these types of textures can result in larger map sizes, but if you just use them on the high slope areas of your map it should not be too bad.

Some good examples used in terrains can be found at the [http://geomorph.sourceforge.net/povray/en/Geomorph%20-%20Predefined%20Povray%20Scripts.html Geomorph website].

The povray install also includes a number of nice example procedural textures.

=== Placing Metal Textures ===
There are quite a few posible ways to have Povray place metal textures for you. One approach that I have used is:

1) Define a function that will return the current metal locations in a pov kind of way:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
#declare getMetal = function {
pigment {
image_map {
png "metallocations.png"
}
scale <1,-1,1>
}
}
</pre>
|}
This function, when called for a given coordinate (0 to 1), returns a vector of the three colours for that point.

2) We now define a texture that we'll use for our metal (this is made up of a number of subcomponent textures):
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
// A transparent texture
#declare Transparent_Texture=
texture {
pigment {color rgbt<0,0,0,1>}
}

// A simple brownish texture
#declare dirt_Texture=
texture {
pigment { rgb <0.75,0.55,0.35>*0.7 }
normal {
granite 0.5 // for use with normal{} (0...1 or more)
//scale MAP_WIDTH
}
finish {
ambient 0.5
diffuse .9
}
}

// A shiny metalish texture
#declare metal_TextureBase =
texture {
pigment {
rgb<1,1,1>
}
normal {
granite 0.9 // for use with normal{} (0...1 or more)
scale 80/5
}
finish {
ambient 0.6
brilliance 4
diffuse 1
specular 0.90
roughness 1/80
}
}

// A combination of the metal_TextureBase, the dirt_Texture and the
// Transparent_Texture
#declare metal_Texture=
texture {
bozo // very smooth, random noise function
turbulence 0.3 // turbulence often useful

texture_map {
[0.0 metal_TextureBase] //T_Silver_3B
[0.42 metal_TextureBase]
[0.47 dirt_Texture]
[0.50 dirt_Texture]
[0.55 Transparent_Texture]
[1.0 Transparent_Texture]
}
//scale <16, 16, 16> //even
scale <7, 32, 16> //stretched
rotate z*40 //set it at an angle so it looks betterer ;)
}

#declare blob_Texture=
texture {
slope { z, 0.0, 0.5 }
texture_map {
[0.0 Transparent_Texture]
[0.6 Transparent_Texture]
[1.0 metal_Texture]
}
}
</pre>
|}
3) Finally, we define a "blob" object that adds a sphere object to the master blob object for each point in the metal map:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre> #declare metalBlob=
blob {
#declare geos=0;
#declare ix=4.0;
#declare num=0;
#while (ix < MAP_WIDTH)
#declare iy=0.0;
#while (iy < MAP_WIDTH)
#declare metal=getMetal(ix/MAP_WIDTH, iy/MAP_WIDTH, 0);
#if (metal.red)
#declare Pos = trace(primaryHF,<ix-MAP_WIDTH/2, -iy+MAP_WIDTH/2, MAP_EL*2>,-z);
sphere {
//Pos-<0,0,5>, 8*6, 8
Pos-<0,0,5>, 8*2, 8
}
#end
#declare iy=iy+8;
#end
#declare ix=ix+8;
#end

texture {
blob_Texture
}
scale <1,1,0.5>
} //metalBlob

object {metalBlob}</pre>
|}
This all adds some time to the rendering time, but seems to work well enough (although it could be nicer).

Tutorial:MapWithPOVRay(Tinnut)

2009-08-31T17:54:01Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== Howto ===
'''Create a map's texture using Povray to generate the texture'''

!! This is currently a work in progress and make take some time to complete. !!

=== Intro ===
This guide will take you through creating a texture for a Spring map using the freeware Povray program. Povray is an excellent [http://en.wikipedia.org/wiki/Ray_tracing raytracing] application that generates "scene" images using a scene definition language in a text file. We can use it to create a map's texture by creating a heightfield object, putting our "camera" directly over the object, setting the camera to orthographic, and rendering a bitmap at our map's dimension. The steps below will give you an easy enough to follow process to generate a nice map, but if you want to create different maps you'll need to learn Povray's scene definition language. This language is easy enough to follow, but depending on your tastes you could be better off using a tool that specialises in maps and map textures, such as the excellent [http://www.bundysoft.com/L3DT/ L3DT].

The guide does not cover other aspects of map creation (heighmaps, features, metal, compiling, etc), but there are a few excellent guides within the Wiki that already cover those steps.

Povray is available for both Windows and Linux. I have only tested these steps under Windows, but they should work under Linux.

Please note that a lot of the maths used in the scene definition file has only been tested on a 16x16 map (8192x8192 pixels).

Warning: The base textures I use in this example are all mostly rubbish that I created in a couple of minutes. I would suggest that you do not use them in your own maps :)

=== Initial Steps ===
1) Download and install Povray: [http://www.povray.org/ Povray Site]

2) Create a working folder for your map, for this example, we'll make C:\PovMap

3) Create a heightmap using whatever program (I like [http://www.gimp.org/ The GIMP], which is good, and it's free). Here is the one we'll use for our map (I created this in a hurry and it was quite a mistake that it ended up so similar to Altered Divide):

[http://img441.imageshack.us/my.php?image=povmapheightbp9.png http://img441.imageshack.us/img441/8862/povmapheightbp9.th.png]

Your map will need to be named povmap_height.png, but if you want to use another name, just update the pov script below to use your heightmap's actual name.

4) For our example, we'll be defining three different elevation levels for which there are different terrain textures, these will be (each at 512x512):

4.1) Lowest elevation (low lying areas):

[http://img176.imageshack.us/my.php?image=level1zd7.png http://img176.imageshack.us/img176/953/level1zd7.th.png]

4.2) Middle elevation (main map surface):

[http://img170.imageshack.us/my.php?image=level2pf6.png http://img170.imageshack.us/img170/6473/level2pf6.th.png]

4.3) Highest elevation (mountains):

[http://img176.imageshack.us/my.php?image=level3wv7.png http://img176.imageshack.us/img176/6159/level3wv7.th.png]

5) Now also for our example, we'll be defining two different textures to be used by sloping areas, one for slopes in the lower elevation areas of the map, and another for slopes in the higher elevations:

5.1) Lower elevations:

[http://img411.imageshack.us/my.php?image=slope1on6.png http://img411.imageshack.us/img411/2153/slope1on6.th.png]

5.2) Higher elevations:

[http://img411.imageshack.us/my.php?image=slope2fk7.png http://img411.imageshack.us/img411/8908/slope2fk7.th.png]

6) Create an empty text file in your C:\Povmap folder named gen_pov_texture.pov

7) Copy the following povray scene code into the above file:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>

// Setup some parameters that we will use within the script
#declare MAP_WIDTH=8192;
#declare MAP_HEIGHT=8192;
#declare MAP_EL=600; // elevation

global_settings {
// ambient light level
ambient_light rgb<1,1,1>
}

// Set a directional light
light_source {
<100,-100,100> * 20, color rgb 1
parallel
point_at <1, 0, 0>
}

// Set the background colour
background {rgb<1,1,1>}

// Define our camera position, and set it to "orthographic" (important :)
camera {
orthographic
location <0,0,MAP_EL + 90> // position & direction of view
look_at <0,0,0>
right MAP_WIDTH*x // horizontal size of view
up MAP_HEIGHT*z // vertical size of view
}

// ** Define our primary textures **

// lowest texture (512 x 512)
// Found in low lying areas of the heightfield
#declare level1_texture =
texture {
pigment {
image_map {
png "level1.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// middle texture (512 x 512)
// Found in the middle areas of the heightfield
#declare level2_texture =
texture {
pigment {
image_map {
png "level2.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// highest texture (512 x 512)
// Found in the peaks / hills / mountains of the heightfield
#declare level3_texture =
texture {
pigment {
image_map {
png "level3.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// Define a texture that blends from one level's texture to the next,
// depending on elevation:
#declare levels_elevation_texture=
texture {
gradient z

texture_map {
[0.00 level1_texture] // from 0.0 to 0.1 we have just level1.png
[0.10 level1_texture]
// from 0.1 to 0.2 we blend from level1.png to level2.png
[0.30 level2_texture] // from 0.2 to 0.5 we have just level2.png
[0.40 level2_texture]
// from 0.5 to 0.6 we blend from level2.png to level3.png
[0.60 level3_texture] // from 0.6 to 1.0 we have just level2.png
[1.00 level3_texture]
}
}

// ** Define textures used on areas of slope

// lower slope texture (512 x 512)
#declare slope1_texture =
texture {
pigment {
image_map {
png "slope1.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// upper slope texture (512 x 512)
#declare slope2_texture =
texture {
pigment {
image_map {
png "slope2.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// Define a texture that blends from one slope's texture to the next,
// depending on elevation:
#declare slopes_elevation_texture=
texture {
gradient z

texture_map {
[0.00 slope1_texture]
[0.30 slope1_texture]

[0.65 slope2_texture]
[1.00 slope2_texture]
}
}

// ** Now define the final texture blending between the height textures
// and the slope textures:
#declare final_texture =
texture {
slope {
<0,0,-1>, 0, 0.5
}
texture_map {
[0.00 levels_elevation_texture]
[0.06 levels_elevation_texture]
[0.40 slopes_elevation_texture]
[1.00 slopes_elevation_texture]
}
}

// ***!! Now we declare our heightfield object that uses this texture
#declare primaryHF=
height_field {
png "povmap_height.png"
smooth // smooth the heightfield
no_shadow // you may want to remove this
translate <-.5, -.5, -.5>
rotate <90,0,0> // rotate it so that the projection of the texture is correct
scale <1,-1,1> // invert the y axis
translate <0.5, 0.5, 0.5>
texture {
final_texture
}

// now scale to the maps height x width
scale <MAP_WIDTH, MAP_HEIGHT, MAP_EL>
// and center it for the camera
translate <-MAP_WIDTH/2, -MAP_HEIGHT/2, -MAP_EL/2>
}

// ** If you're going to add the metal placement stuff
// ** described below, you need to put it here!

object {primaryHF}

</pre>
|}

What we're essentially doing above is:

* Setting up scene parameters: lighting, the orthographic camera, etc.

* Defining a set of textures to display at different elevations and different slopes; and

* Defining a heightmap that uses our png image and applies our texture to this object

8) Double click on your gen_pov_texture.pov file so that it opens up in Povray.

9) Add a new render size (8192 x 8192):

9.1) Drop down menu "Render" > "Edit Settings/Render" > Click "Edit" button

9.2) Add text at bottom of file:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
[8192x8192, No AA Spring]
Width=8192
Height=8192
Antialias=Off
</pre>
|}

9.3) Save file

10) Restart Povray so that it re-reads the ini-file

11) Select your new render size and click Render. This creates a bitmap file: gen_pov_texture.bmp

12) Convert to gen_pov_texture.bmp to a png file if you're using the new mapconv (it doesn't seem to like bitmaps). I personally use [http://www.imagemagick.org/ imagemagick] to do this as it has a simple command line program "convert.exe" that will convert an image from one format to another and it works well with the very large bitmap image that comes out of the above steps.

13) Do all the other map stuff: metal placement bitmap, feature placement bitmap, smd file

14) Compile your map with mapconv

15) Test it :)

== Advanced stuff ==
Check out your help file that came with Povray. There is a LOT that you can do!

=== Complex Texture Map Combinations ===
As you can see from the pov code above, a "texture" declaration can be an image (called an "image_map"), but it can also be a definition of a blend between any number of earlier defined textures (called a "texture_map"), which is based on a function. In the above example, it uses the "gradient" function for changes in elevation, and the "slope" function for changes in slope. It is possible to define much more complex sets of textures than those defined above, such as mixing different combination of slope mapings with combinations of elevation mapings.

Our blend function could actually be an image if you wanted finer control of a map's texture, by having sections of metal mixed with sections of wilderness, for example. To do this, you would:

1) Create a new png image the same size as your heightmap (although you could make it larger or smaller) and paint sections of the map that are to use your wilderness textures in white, and the sections that are to use your metal texture in black. For effect you could do a slight blur on the image to create grey coloured transitions where the two sections meet. For our example I created this:

[http://img185.imageshack.us/my.php?image=texturedistributionpa8.png http://img185.imageshack.us/img185/2641/texturedistributionpa8.th.png]

3) Change the "final_texture" texture name in your script to "final_nature_texture"

4) Define a set of textures in a similar manner that define your metal textures (based on heights and slopes), with the final blended metal texture named "final_metal_texture". Don't forget to give them different names than the wilderness texture names are.

5) Create a new "final_texture" that is:

{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
#declare final_texture =
texture {
image_pattern { png "texture_distribution.png" }
texture_map {
[0.00 final_metal_texture]
[1.00 final_nature_texture]
}
}
</pre>
|}

Here is a screen shot of our map using this:

[http://img341.imageshack.us/my.php?image=screen000wd0.png http://img341.imageshack.us/img341/43/screen000wd0.th.png]

=== Procedural Textures ===
It is also possible to use "procedural textures" instead of image_map textures. These can be quite useful for areas on your map that have a high slope as they can create a better looking texture, including effects such as the layered rock textures - like "Painted Rock". Unfortunately these types of textures can result in larger map sizes, but if you just use them on the high slope areas of your map it should not be too bad.

Some good examples used in terrains can be found at the [http://geomorph.sourceforge.net/povray/en/Geomorph%20-%20Predefined%20Povray%20Scripts.html Geomorph website].

The povray install also includes a number of nice example procedural textures.

=== Placing Metal Textures ===
There are quite a few posible ways to have Povray place metal textures for you. One approach that I have used is:

1) Define a function that will return the current metal locations in a pov kind of way:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
#declare getMetal = function {
pigment {
image_map {
png "metallocations.png"
}
scale <1,-1,1>
}
}
</pre>
|}
This function, when called for a given coordinate (0 to 1), returns a vector of the three colours for that point.

2) We now define a texture that we'll use for our metal (this is made up of a number of subcomponent textures):
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
// A transparent texture
#declare Transparent_Texture=
texture {
pigment {color rgbt<0,0,0,1>}
}

// A simple brownish texture
#declare dirt_Texture=
texture {
pigment { rgb <0.75,0.55,0.35>*0.7 }
normal {
granite 0.5 // for use with normal{} (0...1 or more)
//scale MAP_WIDTH
}
finish {
ambient 0.5
diffuse .9
}
}

// A shiny metalish texture
#declare metal_TextureBase =
texture {
pigment {
rgb<1,1,1>
}
normal {
granite 0.9 // for use with normal{} (0...1 or more)
scale 80/5
}
finish {
ambient 0.6
brilliance 4
diffuse 1
specular 0.90
roughness 1/80
}
}

// A combination of the metal_TextureBase, the dirt_Texture and the
// Transparent_Texture
#declare metal_Texture=
texture {
bozo // very smooth, random noise function
turbulence 0.3 // turbulence often useful

texture_map {
[0.0 metal_TextureBase] //T_Silver_3B
[0.42 metal_TextureBase]
[0.47 dirt_Texture]
[0.50 dirt_Texture]
[0.55 Transparent_Texture]
[1.0 Transparent_Texture]
}
//scale <16, 16, 16> //even
scale <7, 32, 16> //stretched
rotate z*40 //set it at an angle so it looks betterer ;)
}

#declare blob_Texture=
texture {
slope { z, 0.0, 0.5 }
texture_map {
[0.0 Transparent_Texture]
[0.6 Transparent_Texture]
[1.0 metal_Texture]
}
}
</pre>
|}
3) Finally, we define a "blob" object that adds a sphere object to the master blob object for each point in the metal map:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre> #declare metalBlob=
blob {
#declare geos=0;
#declare ix=4.0;
#declare num=0;
#while (ix < MAP_WIDTH)
#declare iy=0.0;
#while (iy < MAP_WIDTH)
#declare metal=getMetal(ix/MAP_WIDTH, iy/MAP_WIDTH, 0);
#if (metal.red)
#declare Pos = trace(primaryHF,<ix-MAP_WIDTH/2, -iy+MAP_WIDTH/2, MAP_EL*2>,-z);
sphere {
//Pos-<0,0,5>, 8*6, 8
Pos-<0,0,5>, 8*2, 8
}
#end
#declare iy=iy+8;
#end
#declare ix=ix+8;
#end

texture {
blob_Texture
}
scale <1,1,0.5>
} //metalBlob

object {metalBlob}</pre>
|}
This all adds some time to the rendering time, but seems to work well enough (although it could be nicer).

Tutorial:MapWithPOVRay(Tinnut)

2009-08-31T17:53:42Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== Howto: Create a map's texture using Povray to generate the texture ==

!! This is currently a work in progress and make take some time to complete. !!

=== Intro ===
This guide will take you through creating a texture for a Spring map using the freeware Povray program. Povray is an excellent [http://en.wikipedia.org/wiki/Ray_tracing raytracing] application that generates "scene" images using a scene definition language in a text file. We can use it to create a map's texture by creating a heightfield object, putting our "camera" directly over the object, setting the camera to orthographic, and rendering a bitmap at our map's dimension. The steps below will give you an easy enough to follow process to generate a nice map, but if you want to create different maps you'll need to learn Povray's scene definition language. This language is easy enough to follow, but depending on your tastes you could be better off using a tool that specialises in maps and map textures, such as the excellent [http://www.bundysoft.com/L3DT/ L3DT].

The guide does not cover other aspects of map creation (heighmaps, features, metal, compiling, etc), but there are a few excellent guides within the Wiki that already cover those steps.

Povray is available for both Windows and Linux. I have only tested these steps under Windows, but they should work under Linux.

Please note that a lot of the maths used in the scene definition file has only been tested on a 16x16 map (8192x8192 pixels).

Warning: The base textures I use in this example are all mostly rubbish that I created in a couple of minutes. I would suggest that you do not use them in your own maps :)

=== Initial Steps ===
1) Download and install Povray: [http://www.povray.org/ Povray Site]

2) Create a working folder for your map, for this example, we'll make C:\PovMap

3) Create a heightmap using whatever program (I like [http://www.gimp.org/ The GIMP], which is good, and it's free). Here is the one we'll use for our map (I created this in a hurry and it was quite a mistake that it ended up so similar to Altered Divide):

[http://img441.imageshack.us/my.php?image=povmapheightbp9.png http://img441.imageshack.us/img441/8862/povmapheightbp9.th.png]

Your map will need to be named povmap_height.png, but if you want to use another name, just update the pov script below to use your heightmap's actual name.

4) For our example, we'll be defining three different elevation levels for which there are different terrain textures, these will be (each at 512x512):

4.1) Lowest elevation (low lying areas):

[http://img176.imageshack.us/my.php?image=level1zd7.png http://img176.imageshack.us/img176/953/level1zd7.th.png]

4.2) Middle elevation (main map surface):

[http://img170.imageshack.us/my.php?image=level2pf6.png http://img170.imageshack.us/img170/6473/level2pf6.th.png]

4.3) Highest elevation (mountains):

[http://img176.imageshack.us/my.php?image=level3wv7.png http://img176.imageshack.us/img176/6159/level3wv7.th.png]

5) Now also for our example, we'll be defining two different textures to be used by sloping areas, one for slopes in the lower elevation areas of the map, and another for slopes in the higher elevations:

5.1) Lower elevations:

[http://img411.imageshack.us/my.php?image=slope1on6.png http://img411.imageshack.us/img411/2153/slope1on6.th.png]

5.2) Higher elevations:

[http://img411.imageshack.us/my.php?image=slope2fk7.png http://img411.imageshack.us/img411/8908/slope2fk7.th.png]

6) Create an empty text file in your C:\Povmap folder named gen_pov_texture.pov

7) Copy the following povray scene code into the above file:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>

// Setup some parameters that we will use within the script
#declare MAP_WIDTH=8192;
#declare MAP_HEIGHT=8192;
#declare MAP_EL=600; // elevation

global_settings {
// ambient light level
ambient_light rgb<1,1,1>
}

// Set a directional light
light_source {
<100,-100,100> * 20, color rgb 1
parallel
point_at <1, 0, 0>
}

// Set the background colour
background {rgb<1,1,1>}

// Define our camera position, and set it to "orthographic" (important :)
camera {
orthographic
location <0,0,MAP_EL + 90> // position & direction of view
look_at <0,0,0>
right MAP_WIDTH*x // horizontal size of view
up MAP_HEIGHT*z // vertical size of view
}

// ** Define our primary textures **

// lowest texture (512 x 512)
// Found in low lying areas of the heightfield
#declare level1_texture =
texture {
pigment {
image_map {
png "level1.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// middle texture (512 x 512)
// Found in the middle areas of the heightfield
#declare level2_texture =
texture {
pigment {
image_map {
png "level2.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// highest texture (512 x 512)
// Found in the peaks / hills / mountains of the heightfield
#declare level3_texture =
texture {
pigment {
image_map {
png "level3.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// Define a texture that blends from one level's texture to the next,
// depending on elevation:
#declare levels_elevation_texture=
texture {
gradient z

texture_map {
[0.00 level1_texture] // from 0.0 to 0.1 we have just level1.png
[0.10 level1_texture]
// from 0.1 to 0.2 we blend from level1.png to level2.png
[0.30 level2_texture] // from 0.2 to 0.5 we have just level2.png
[0.40 level2_texture]
// from 0.5 to 0.6 we blend from level2.png to level3.png
[0.60 level3_texture] // from 0.6 to 1.0 we have just level2.png
[1.00 level3_texture]
}
}

// ** Define textures used on areas of slope

// lower slope texture (512 x 512)
#declare slope1_texture =
texture {
pigment {
image_map {
png "slope1.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// upper slope texture (512 x 512)
#declare slope2_texture =
texture {
pigment {
image_map {
png "slope2.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// Define a texture that blends from one slope's texture to the next,
// depending on elevation:
#declare slopes_elevation_texture=
texture {
gradient z

texture_map {
[0.00 slope1_texture]
[0.30 slope1_texture]

[0.65 slope2_texture]
[1.00 slope2_texture]
}
}

// ** Now define the final texture blending between the height textures
// and the slope textures:
#declare final_texture =
texture {
slope {
<0,0,-1>, 0, 0.5
}
texture_map {
[0.00 levels_elevation_texture]
[0.06 levels_elevation_texture]
[0.40 slopes_elevation_texture]
[1.00 slopes_elevation_texture]
}
}

// ***!! Now we declare our heightfield object that uses this texture
#declare primaryHF=
height_field {
png "povmap_height.png"
smooth // smooth the heightfield
no_shadow // you may want to remove this
translate <-.5, -.5, -.5>
rotate <90,0,0> // rotate it so that the projection of the texture is correct
scale <1,-1,1> // invert the y axis
translate <0.5, 0.5, 0.5>
texture {
final_texture
}

// now scale to the maps height x width
scale <MAP_WIDTH, MAP_HEIGHT, MAP_EL>
// and center it for the camera
translate <-MAP_WIDTH/2, -MAP_HEIGHT/2, -MAP_EL/2>
}

// ** If you're going to add the metal placement stuff
// ** described below, you need to put it here!

object {primaryHF}

</pre>
|}

What we're essentially doing above is:

* Setting up scene parameters: lighting, the orthographic camera, etc.

* Defining a set of textures to display at different elevations and different slopes; and

* Defining a heightmap that uses our png image and applies our texture to this object

8) Double click on your gen_pov_texture.pov file so that it opens up in Povray.

9) Add a new render size (8192 x 8192):

9.1) Drop down menu "Render" > "Edit Settings/Render" > Click "Edit" button

9.2) Add text at bottom of file:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
[8192x8192, No AA Spring]
Width=8192
Height=8192
Antialias=Off
</pre>
|}

9.3) Save file

10) Restart Povray so that it re-reads the ini-file

11) Select your new render size and click Render. This creates a bitmap file: gen_pov_texture.bmp

12) Convert to gen_pov_texture.bmp to a png file if you're using the new mapconv (it doesn't seem to like bitmaps). I personally use [http://www.imagemagick.org/ imagemagick] to do this as it has a simple command line program "convert.exe" that will convert an image from one format to another and it works well with the very large bitmap image that comes out of the above steps.

13) Do all the other map stuff: metal placement bitmap, feature placement bitmap, smd file

14) Compile your map with mapconv

15) Test it :)

== Advanced stuff ==
Check out your help file that came with Povray. There is a LOT that you can do!

=== Complex Texture Map Combinations ===
As you can see from the pov code above, a "texture" declaration can be an image (called an "image_map"), but it can also be a definition of a blend between any number of earlier defined textures (called a "texture_map"), which is based on a function. In the above example, it uses the "gradient" function for changes in elevation, and the "slope" function for changes in slope. It is possible to define much more complex sets of textures than those defined above, such as mixing different combination of slope mapings with combinations of elevation mapings.

Our blend function could actually be an image if you wanted finer control of a map's texture, by having sections of metal mixed with sections of wilderness, for example. To do this, you would:

1) Create a new png image the same size as your heightmap (although you could make it larger or smaller) and paint sections of the map that are to use your wilderness textures in white, and the sections that are to use your metal texture in black. For effect you could do a slight blur on the image to create grey coloured transitions where the two sections meet. For our example I created this:

[http://img185.imageshack.us/my.php?image=texturedistributionpa8.png http://img185.imageshack.us/img185/2641/texturedistributionpa8.th.png]

3) Change the "final_texture" texture name in your script to "final_nature_texture"

4) Define a set of textures in a similar manner that define your metal textures (based on heights and slopes), with the final blended metal texture named "final_metal_texture". Don't forget to give them different names than the wilderness texture names are.

5) Create a new "final_texture" that is:

{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
#declare final_texture =
texture {
image_pattern { png "texture_distribution.png" }
texture_map {
[0.00 final_metal_texture]
[1.00 final_nature_texture]
}
}
</pre>
|}

Here is a screen shot of our map using this:

[http://img341.imageshack.us/my.php?image=screen000wd0.png http://img341.imageshack.us/img341/43/screen000wd0.th.png]

=== Procedural Textures ===
It is also possible to use "procedural textures" instead of image_map textures. These can be quite useful for areas on your map that have a high slope as they can create a better looking texture, including effects such as the layered rock textures - like "Painted Rock". Unfortunately these types of textures can result in larger map sizes, but if you just use them on the high slope areas of your map it should not be too bad.

Some good examples used in terrains can be found at the [http://geomorph.sourceforge.net/povray/en/Geomorph%20-%20Predefined%20Povray%20Scripts.html Geomorph website].

The povray install also includes a number of nice example procedural textures.

=== Placing Metal Textures ===
There are quite a few posible ways to have Povray place metal textures for you. One approach that I have used is:

1) Define a function that will return the current metal locations in a pov kind of way:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
#declare getMetal = function {
pigment {
image_map {
png "metallocations.png"
}
scale <1,-1,1>
}
}
</pre>
|}
This function, when called for a given coordinate (0 to 1), returns a vector of the three colours for that point.

2) We now define a texture that we'll use for our metal (this is made up of a number of subcomponent textures):
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre>
// A transparent texture
#declare Transparent_Texture=
texture {
pigment {color rgbt<0,0,0,1>}
}

// A simple brownish texture
#declare dirt_Texture=
texture {
pigment { rgb <0.75,0.55,0.35>*0.7 }
normal {
granite 0.5 // for use with normal{} (0...1 or more)
//scale MAP_WIDTH
}
finish {
ambient 0.5
diffuse .9
}
}

// A shiny metalish texture
#declare metal_TextureBase =
texture {
pigment {
rgb<1,1,1>
}
normal {
granite 0.9 // for use with normal{} (0...1 or more)
scale 80/5
}
finish {
ambient 0.6
brilliance 4
diffuse 1
specular 0.90
roughness 1/80
}
}

// A combination of the metal_TextureBase, the dirt_Texture and the
// Transparent_Texture
#declare metal_Texture=
texture {
bozo // very smooth, random noise function
turbulence 0.3 // turbulence often useful

texture_map {
[0.0 metal_TextureBase] //T_Silver_3B
[0.42 metal_TextureBase]
[0.47 dirt_Texture]
[0.50 dirt_Texture]
[0.55 Transparent_Texture]
[1.0 Transparent_Texture]
}
//scale <16, 16, 16> //even
scale <7, 32, 16> //stretched
rotate z*40 //set it at an angle so it looks betterer ;)
}

#declare blob_Texture=
texture {
slope { z, 0.0, 0.5 }
texture_map {
[0.0 Transparent_Texture]
[0.6 Transparent_Texture]
[1.0 metal_Texture]
}
}
</pre>
|}
3) Finally, we define a "blob" object that adds a sphere object to the master blob object for each point in the metal map:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed white; background-color: rgb(56, 70, 79);"
|
<pre> #declare metalBlob=
blob {
#declare geos=0;
#declare ix=4.0;
#declare num=0;
#while (ix < MAP_WIDTH)
#declare iy=0.0;
#while (iy < MAP_WIDTH)
#declare metal=getMetal(ix/MAP_WIDTH, iy/MAP_WIDTH, 0);
#if (metal.red)
#declare Pos = trace(primaryHF,<ix-MAP_WIDTH/2, -iy+MAP_WIDTH/2, MAP_EL*2>,-z);
sphere {
//Pos-<0,0,5>, 8*6, 8
Pos-<0,0,5>, 8*2, 8
}
#end
#declare iy=iy+8;
#end
#declare ix=ix+8;
#end

texture {
blob_Texture
}
scale <1,1,0.5>
} //metalBlob

object {metalBlob}</pre>
|}
This all adds some time to the rendering time, but seems to work well enough (although it could be nicer).

Tutorial:MapWithPOVRay(Tinnut)

2009-08-31T17:53:18Z

Aegis:

Tutorial:MapWithPOVRay(Tinnut)

2009-08-31T17:45:48Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== Howto: Create a map's texture using Povray to generate the texture ==

!! This is currently a work in progress and make take some time to complete. !!

=== Intro ===
This guide will take you through creating a texture for a Spring map using the freeware Povray program. Povray is an excellent [http://en.wikipedia.org/wiki/Ray_tracing raytracing] application that generates "scene" images using a scene definition language in a text file. We can use it to create a map's texture by creating a heightfield object, putting our "camera" directly over the object, setting the camera to orthographic, and rendering a bitmap at our map's dimension. The steps below will give you an easy enough to follow process to generate a nice map, but if you want to create different maps you'll need to learn Povray's scene definition language. This language is easy enough to follow, but depending on your tastes you could be better off using a tool that specialises in maps and map textures, such as the excellent [http://www.bundysoft.com/L3DT/ L3DT].

The guide does not cover other aspects of map creation (heighmaps, features, metal, compiling, etc), but there are a few excellent guides within the Wiki that already cover those steps.

Povray is available for both Windows and Linux. I have only tested these steps under Windows, but they should work under Linux.

Please note that a lot of the maths used in the scene definition file has only been tested on a 16x16 map (8192x8192 pixels).

Warning: The base textures I use in this example are all mostly rubbish that I created in a couple of minutes. I would suggest that you do not use them in your own maps :)

=== Initial Steps ===
1) Download and install Povray: [http://www.povray.org/ Povray Site]

2) Create a working folder for your map, for this example, we'll make C:\PovMap

3) Create a heightmap using whatever program (I like [http://www.gimp.org/ The GIMP], which is good, and it's free). Here is the one we'll use for our map (I created this in a hurry and it was quite a mistake that it ended up so similar to Altered Divide):

[http://img441.imageshack.us/my.php?image=povmapheightbp9.png http://img441.imageshack.us/img441/8862/povmapheightbp9.th.png]

Your map will need to be named povmap_height.png, but if you want to use another name, just update the pov script below to use your heightmap's actual name.

4) For our example, we'll be defining three different elevation levels for which there are different terrain textures, these will be (each at 512x512):

4.1) Lowest elevation (low lying areas):

[http://img176.imageshack.us/my.php?image=level1zd7.png http://img176.imageshack.us/img176/953/level1zd7.th.png]

4.2) Middle elevation (main map surface):

[http://img170.imageshack.us/my.php?image=level2pf6.png http://img170.imageshack.us/img170/6473/level2pf6.th.png]

4.3) Highest elevation (mountains):

[http://img176.imageshack.us/my.php?image=level3wv7.png http://img176.imageshack.us/img176/6159/level3wv7.th.png]

5) Now also for our example, we'll be defining two different textures to be used by sloping areas, one for slopes in the lower elevation areas of the map, and another for slopes in the higher elevations:

5.1) Lower elevations:

[http://img411.imageshack.us/my.php?image=slope1on6.png http://img411.imageshack.us/img411/2153/slope1on6.th.png]

5.2) Higher elevations:

[http://img411.imageshack.us/my.php?image=slope2fk7.png http://img411.imageshack.us/img411/8908/slope2fk7.th.png]

6) Create an empty text file in your C:\Povmap folder named gen_pov_texture.pov

7) Copy the following povray scene code into the above file:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed red;background-color:white"
|
<pre>

// Setup some parameters that we will use within the script
#declare MAP_WIDTH=8192;
#declare MAP_HEIGHT=8192;
#declare MAP_EL=600; // elevation

global_settings {
// ambient light level
ambient_light rgb<1,1,1>
}

// Set a directional light
light_source {
<100,-100,100> * 20, color rgb 1
parallel
point_at <1, 0, 0>
}

// Set the background colour
background {rgb<1,1,1>}

// Define our camera position, and set it to "orthographic" (important :)
camera {
orthographic
location <0,0,MAP_EL + 90> // position & direction of view
look_at <0,0,0>
right MAP_WIDTH*x // horizontal size of view
up MAP_HEIGHT*z // vertical size of view
}

// ** Define our primary textures **

// lowest texture (512 x 512)
// Found in low lying areas of the heightfield
#declare level1_texture =
texture {
pigment {
image_map {
png "level1.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// middle texture (512 x 512)
// Found in the middle areas of the heightfield
#declare level2_texture =
texture {
pigment {
image_map {
png "level2.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// highest texture (512 x 512)
// Found in the peaks / hills / mountains of the heightfield
#declare level3_texture =
texture {
pigment {
image_map {
png "level3.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// Define a texture that blends from one level's texture to the next,
// depending on elevation:
#declare levels_elevation_texture=
texture {
gradient z

texture_map {
[0.00 level1_texture] // from 0.0 to 0.1 we have just level1.png
[0.10 level1_texture]
// from 0.1 to 0.2 we blend from level1.png to level2.png
[0.30 level2_texture] // from 0.2 to 0.5 we have just level2.png
[0.40 level2_texture]
// from 0.5 to 0.6 we blend from level2.png to level3.png
[0.60 level3_texture] // from 0.6 to 1.0 we have just level2.png
[1.00 level3_texture]
}
}

// ** Define textures used on areas of slope

// lower slope texture (512 x 512)
#declare slope1_texture =
texture {
pigment {
image_map {
png "slope1.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// upper slope texture (512 x 512)
#declare slope2_texture =
texture {
pigment {
image_map {
png "slope2.png"
}
}
finish {ambient 1 diffuse 0}
scale <512/MAP_WIDTH, 512/MAP_WIDTH, 512/MAP_WIDTH>
}

// Define a texture that blends from one slope's texture to the next,
// depending on elevation:
#declare slopes_elevation_texture=
texture {
gradient z

texture_map {
[0.00 slope1_texture]
[0.30 slope1_texture]

[0.65 slope2_texture]
[1.00 slope2_texture]
}
}

// ** Now define the final texture blending between the height textures
// and the slope textures:
#declare final_texture =
texture {
slope {
<0,0,-1>, 0, 0.5
}
texture_map {
[0.00 levels_elevation_texture]
[0.06 levels_elevation_texture]
[0.40 slopes_elevation_texture]
[1.00 slopes_elevation_texture]
}
}

// ***!! Now we declare our heightfield object that uses this texture
#declare primaryHF=
height_field {
png "povmap_height.png"
smooth // smooth the heightfield
no_shadow // you may want to remove this
translate <-.5, -.5, -.5>
rotate <90,0,0> // rotate it so that the projection of the texture is correct
scale <1,-1,1> // invert the y axis
translate <0.5, 0.5, 0.5>
texture {
final_texture
}

// now scale to the maps height x width
scale <MAP_WIDTH, MAP_HEIGHT, MAP_EL>
// and center it for the camera
translate <-MAP_WIDTH/2, -MAP_HEIGHT/2, -MAP_EL/2>
}

// ** If you're going to add the metal placement stuff
// ** described below, you need to put it here!

object {primaryHF}

</pre>
|}

What we're essentially doing above is:

* Setting up scene parameters: lighting, the orthographic camera, etc.

* Defining a set of textures to display at different elevations and different slopes; and

* Defining a heightmap that uses our png image and applies our texture to this object

8) Double click on your gen_pov_texture.pov file so that it opens up in Povray.

9) Add a new render size (8192 x 8192):

9.1) Drop down menu "Render" > "Edit Settings/Render" > Click "Edit" button

9.2) Add text at bottom of file:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed red;background-color:white"
|
<pre>
[8192x8192, No AA Spring]
Width=8192
Height=8192
Antialias=Off
</pre>
|}

9.3) Save file

10) Restart Povray so that it re-reads the ini-file

11) Select your new render size and click Render. This creates a bitmap file: gen_pov_texture.bmp

12) Convert to gen_pov_texture.bmp to a png file if you're using the new mapconv (it doesn't seem to like bitmaps). I personally use [http://www.imagemagick.org/ imagemagick] to do this as it has a simple command line program "convert.exe" that will convert an image from one format to another and it works well with the very large bitmap image that comes out of the above steps.

13) Do all the other map stuff: metal placement bitmap, feature placement bitmap, smd file

14) Compile your map with mapconv

15) Test it :)

== Advanced stuff ==
Check out your help file that came with Povray. There is a LOT that you can do!

=== Complex Texture Map Combinations ===
As you can see from the pov code above, a "texture" declaration can be an image (called an "image_map"), but it can also be a definition of a blend between any number of earlier defined textures (called a "texture_map"), which is based on a function. In the above example, it uses the "gradient" function for changes in elevation, and the "slope" function for changes in slope. It is possible to define much more complex sets of textures than those defined above, such as mixing different combination of slope mapings with combinations of elevation mapings.

Our blend function could actually be an image if you wanted finer control of a map's texture, by having sections of metal mixed with sections of wilderness, for example. To do this, you would:

1) Create a new png image the same size as your heightmap (although you could make it larger or smaller) and paint sections of the map that are to use your wilderness textures in white, and the sections that are to use your metal texture in black. For effect you could do a slight blur on the image to create grey coloured transitions where the two sections meet. For our example I created this:

[http://img185.imageshack.us/my.php?image=texturedistributionpa8.png http://img185.imageshack.us/img185/2641/texturedistributionpa8.th.png]

3) Change the "final_texture" texture name in your script to "final_nature_texture"

4) Define a set of textures in a similar manner that define your metal textures (based on heights and slopes), with the final blended metal texture named "final_metal_texture". Don't forget to give them different names than the wilderness texture names are.

5) Create a new "final_texture" that is:

{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed red;background-color:white"
|
<pre>
#declare final_texture =
texture {
image_pattern { png "texture_distribution.png" }
texture_map {
[0.00 final_metal_texture]
[1.00 final_nature_texture]
}
}
</pre>
|}

Here is a screen shot of our map using this:

[http://img341.imageshack.us/my.php?image=screen000wd0.png http://img341.imageshack.us/img341/43/screen000wd0.th.png]

=== Procedural Textures ===
It is also possible to use "procedural textures" instead of image_map textures. These can be quite useful for areas on your map that have a high slope as they can create a better looking texture, including effects such as the layered rock textures - like "Painted Rock". Unfortunately these types of textures can result in larger map sizes, but if you just use them on the high slope areas of your map it should not be too bad.

Some good examples used in terrains can be found at the [http://geomorph.sourceforge.net/povray/en/Geomorph%20-%20Predefined%20Povray%20Scripts.html Geomorph website].

The povray install also includes a number of nice example procedural textures.

=== Placing Metal Textures ===
There are quite a few posible ways to have Povray place metal textures for you. One approach that I have used is:

1) Define a function that will return the current metal locations in a pov kind of way:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed red;background-color:white"
|
<pre>
#declare getMetal = function {
pigment {
image_map {
png "metallocations.png"
}
scale <1,-1,1>
}
}
</pre>
|}
This function, when called for a given coordinate (0 to 1), returns a vector of the three colours for that point.

2) We now define a texture that we'll use for our metal (this is made up of a number of subcomponent textures):
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed red;background-color:white"
|
<pre>
// A transparent texture
#declare Transparent_Texture=
texture {
pigment {color rgbt<0,0,0,1>}
}

// A simple brownish texture
#declare dirt_Texture=
texture {
pigment { rgb <0.75,0.55,0.35>*0.7 }
normal {
granite 0.5 // for use with normal{} (0...1 or more)
//scale MAP_WIDTH
}
finish {
ambient 0.5
diffuse .9
}
}

// A shiny metalish texture
#declare metal_TextureBase =
texture {
pigment {
rgb<1,1,1>
}
normal {
granite 0.9 // for use with normal{} (0...1 or more)
scale 80/5
}
finish {
ambient 0.6
brilliance 4
diffuse 1
specular 0.90
roughness 1/80
}
}

// A combination of the metal_TextureBase, the dirt_Texture and the
// Transparent_Texture
#declare metal_Texture=
texture {
bozo // very smooth, random noise function
turbulence 0.3 // turbulence often useful

texture_map {
[0.0 metal_TextureBase] //T_Silver_3B
[0.42 metal_TextureBase]
[0.47 dirt_Texture]
[0.50 dirt_Texture]
[0.55 Transparent_Texture]
[1.0 Transparent_Texture]
}
//scale <16, 16, 16> //even
scale <7, 32, 16> //stretched
rotate z*40 //set it at an angle so it looks betterer ;)
}

#declare blob_Texture=
texture {
slope { z, 0.0, 0.5 }
texture_map {
[0.0 Transparent_Texture]
[0.6 Transparent_Texture]
[1.0 metal_Texture]
}
}
</pre>
|}
3) Finally, we define a "blob" object that adds a sphere object to the master blob object for each point in the metal map:
{| class="wikitable" style="font-style:italic; font-size:90%; border:1px dashed red;background-color:white"
|
<pre> #declare metalBlob=
blob {
#declare geos=0;
#declare ix=4.0;
#declare num=0;
#while (ix < MAP_WIDTH)
#declare iy=0.0;
#while (iy < MAP_WIDTH)
#declare metal=getMetal(ix/MAP_WIDTH, iy/MAP_WIDTH, 0);
#if (metal.red)
#declare Pos = trace(primaryHF,<ix-MAP_WIDTH/2, -iy+MAP_WIDTH/2, MAP_EL*2>,-z);
sphere {
//Pos-<0,0,5>, 8*6, 8
Pos-<0,0,5>, 8*2, 8
}
#end
#declare iy=iy+8;
#end
#declare ix=ix+8;
#end

texture {
blob_Texture
}
scale <1,1,0.5>
} //metalBlob

object {metalBlob}</pre>
|}
This all adds some time to the rendering time, but seems to work well enough (although it could be nicer).

Maps:Map Designer

2009-08-31T17:45:36Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== MapDesigner, by Hugh Perkins ==

[http://manageddreams.com/csai/MapDesigner.zip Download]

*Supports multipass texture splatting. SM3 loader.
*Heightmap editor. Left click to raise land, right click to lower
*Paint splatted texture. Left click to paint texture, right click to erase
*Export heightmap, slopemap and blend maps
*Exported slopemap color-coded by movement area, eg infantry, vehicle and extreme (configurable)

== User interface ==

[[Media:http://manageddreams.com/csai/mapdesigner3small.JPG]]

== Concepts ==

MapDesigner is optimized for creating SM3 maps, which use texture splatting to provide high detail maps.

For each texture, we need:
*the texture, which will be tiled according to the tilesize
*a blend map, which controls where the texture will be visible

The blend map is essentially an alpha map. The areas which are white will be splatted with our texture, and the other areas will be transparent.

The textures are rendered in layers, one by one. The later layers cover the earlier layers, according to each one's blend map texture. Here's some pictures that illustrate how this works. We are rendering each layer with a vertical offset so you can see each layer on its own.

[[Media:http://manageddreams.com/csai/multitextureview1.JPG]]

[[Media:http://manageddreams.com/csai/multitextureview2.JPG]]

[[Media:http://manageddreams.com/csai/multitextureview3.JPG]]

In reality, these layers are all rendered together, with no vertical offset, so they look like they are all part of the same single terrain.

You can use any DevIL-compatible texture as your splat texture. Select a texture stage and click "Load texture..." to load the texture into that texture stage. You can change the tilesize to control how it is splatted in the visible areas.

The blend texture works like an alpha texture, but the data is actually stored in the RGB channels, as a grey-level. MapDesigner lets you paint or remove to and from the blend texture, which has the effect of painting splat texture on the map, or removing it.

== Texture stages ==

Multiple texture stages can be configured. We use one texture stage for each splatted texture and set its operation to "Blend".

The first texture stage - texstage1 - should be set to "Replace", and has no blend texture. That's because it's the base texture for the map, on top of which the other textures are painted.

Advanced:
*It's possible to set other operations on the texture stages.

== Paint splatted texture ==

*select "Paint texture"
*select a texture stage
*set texture stage operation to "Blend" and load a texture if necessary
*Left click map to paint texture, right click to erase
*You can click "Save blend texture" to export the blend texture map

Note that texture stages are applied in order, first 1 then 2 then 3 etc. The later layers cover the earlier ones.

If you click the map and nothing happens, your changes may be being masked by later layers. You can edit the later layers to uncover your changes, or click "move down" to move your edited layer later in the queue.

[[Media:http://manageddreams.com/csai/mapdesignblendediting.JPG]]

== Water ==

Areas below zero height will be underwater:

[[Media:http://manageddreams.com/csai/mapdesignwater.JPG]]

== Exported Slopemap ==

You can use File | Export slopemap... to export a slopemap for your map.

Black means zero slope, green is vehicles, blue is infantry, red is extreme:

[[Media:http://manageddreams.com/csai/slopemap2.JPG]]

== Configuration ==

Configuration is stored in config.xml ,which can be opened in notepad
*You can change height and width in the display section to change the window size on next startup
*You can configure key mappings, and mouse move configuration

Map Making Guild

2009-08-31T17:44:34Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== The Map Making Guild! ==

After a Typo on aGorm's "Map Making Guide" (guess the typo), he decided that all mappers that are unfortunate enough not to have a clan should surly have one. And maybe he wanted his own...

So it was made, and there was much rejoicing! In aGorms room anyway!

Currently I havn't got of my backside and got anyone to join, but feel free to. The only requirment is that you must have made 1 (one) half decent map! (And if you add yourself to teh list I'll be sure to check you out and take you off if your not a mapper... beside's I'll knock up a homepage soon and then you'll have to go through me! Ha ha ha ha... coff)

== Current members: ==
===aGorm===
*Acid Bridge
*Acid Quadratic
*Desert Dunes
*Core Pyramid
*Volcano ISland
*Tree Screenshot (this surely counts?)

===Weaver===
*Death Valley
*PCB
*Ashaf Plateau
*Little Brook
*Hell's Teeth
*Green Fields

===WiREd===
*2 VaLLeys
*Rush Hour (OTA Port)
*more new maps in progress

Map Making Guild

2009-08-31T17:43:52Z

Aegis:

Maps:Noob Mistakes

2009-08-31T17:43:40Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

Everybody Keeps posting in the forum, and it's hard to figure out what exactly the n00b is doing wrong.

=Map n00b FAQ=

'''If The Character Combination :/ is included in the compilation batch script it doesn't work.'''

D:\TA_Editors\MapConv\MapConv.exe -c 0.5 -x 400 -n 100 -o D:\TA_Editors\MapConv\maps\metal-islands.smf -t D:\TA_Editors\MapConv\maps\metal-islands_texturemap.bmp -m D:\TA_Editors\MapConv\maps\metal-islands_metalmap.bmp -a D:\TA_Editors\MapConv\maps\metal-islands_heightmap.bmp -f D:\TA_Editors\MapConv\maps\metal-islands_featuremap.bmp -i

IS BAD

MapConv.exe -c 0.5 -x 400 -n 100 -o metal-islands.smf -t metal-islands_texturemap.bmp -m metal-islands_metalmap.bmp -a metal-islands_heightmap.bmp -f metal-islands_featuremap.bmp -i

IS GOOD

===Do Not Rename Your SMT===

MapConv takes the first part of the "-o mapname.smf" to determine the name of the smt file (namely mapname.smt), a reference to this "mapname.smt" is stored in the smf file as where to look for tile images. This means you can rename you smf and smd files, but are unable to rename the tile file.

===Put water low enough===
If you want to do a land only dry map, make sure your water isn't just below the ground, or else even the smallest crater will turn into a pond. Instead, use the '''-x''' and '''-n''' to put even your lowest ground far above water.

Water Height: Mapconv vs. Heightmap

2009-08-31T17:43:11Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

===The Problem===

It has come up as a source of confusion as to what shade of grey in your heightmap is water level. The simple answer is that there isn't a simple answer, but don't worry it really isn't all that hard. It is determined by your height input parameters to mapconv (Does none of this make sense? You probably want to stop here, go back and read some of the [http://taspring.clan-sy.com/wiki/Map_development tutorials]. ) ''Note this assumes you have both 0% and 100% grey (black and white, respectively) on your heightmap, which should be the case (this maximises the range of greys you can play with for your heightmap)''

the '''-x''' value in mapconv is the altitude (in elmos?) of a 100% white surface

the '''-n''' value is the altitude of a 0% white surface

To find the altitude of an intermediate shade of grey, do this,

'''n+(y*(x-n)) = a''' or, simplified, '''y*x + (1-y)*n = a'''

Where '''y''' is your value (in percent or in RGB value / 255)
'''x''' and '''n''' are the parameters from mapconv
and '''a''' is the altitude of that value

'''The water level is always assumed to be 0 in mapconv''', so anything with a negative '''a''' value will be underwater.

===An Example===

So to make 50% grey underwater, you could for example set your water line at 55% grey. Then, some values for mapconv that would work are:

*this would produce very low mountains
: -x 82 -n -100
*this would probably be better
: -x 205 -n -250

Tutorial:CreateMaps(Fnordia et al)

2009-08-31T17:41:47Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

'''Original by aGorm, with help from LathanStanley''' 

==The Idea==
First of all you need an idea. There is no point (OK, there is some point for test purposes) in making a map just like another one that already exists. You need to think of certain things before you make your map.
# Is this map idea different, not just a copy of someone else's?
# Does my map idea give each player a fair share of the cover and high ground?
# Is my map idea possible to make?
# Is it possible with the amount of time I'm willing to spend?

If you answered yes to the above, then you are 25% of the way towards making your map!

You should probably doodle it on a piece of paper to act as a guide later.

==The Tools==
With your idea hopefully sketched out, it's time to get the tools to make the map! (You can skip this if you already have them.)

For all your map compiling needs you should first download the [http://fileuniverse.com/?p=showitem&ID=1234 newest MapConv program].

You will also need some image editing software. Favorites are Photoshop, the [http://www.gimp.org/ GIMP], And Paintshop Pro.
The GIMP, however, is the only one that's free!
(I'm going to have to assume you know how to use the program you choose. If you can't there are loads of tutorials on the net.)

You may also want to check out [http://www.planetside.co.uk/terragen/ Terragen] for generating terrain. But as you have to pay to render anything of a good size, I won't mention it other than here.

Another tool you might find useful is the freeware tool [http://www.delphigl.de/projects/terrtexgen/eng_index.html TerrTexGen]. It's useful for previewing your heightmap before compiling, but unless your texturemap is 4096 on both sides, you might find that the texturemaps that it creates are too small.

Finally, there is tool called [http://www.bundysoft.com/L3DT/ L3DT] which you might also find useful. It seems to be a program that is specificly designed for creating large height/texture maps. The free version is capable of rendering a heightmap as big as 4096x4096, and can generate a texturemap that is proportional to the heightmap. Of the mentioned packages, this seems the most useful and complete.

==Preparing your map==
This is the fun part! And also, often, the longest part.

For a map you will need several different things:
# a texture map
# a height map
# a metal map

They all have certain needs! Read this bit carfully!

===Texture Map===
All maps are based on a texture image. This image's width and height must be an exact multiple of 1024 pixels. So, for instance, you can have a "4096 by 8192" image, but not a "4096 by 4608" image, as 4608 does not divide by 1024. It, like all three maps, must be saved as a 24 bit BMP. A 1024x1024 Texture will produce a map shown as '2x2' in the launcher.

It may look like whatever you want! Find a texture (preferably, one that you can tile seamlessly) and fill your texture map with it. You could, for instance, fill the whole image with a sand texture. This would make your whole world look like sand. You could then decide to add a few patches of grass to it by finding a suitable grass texture and adding it on patches. So you'd have a map that was mostly sand with a few patches of green.

Because of the way the map compiler works, it will '''greatly''' reduce your map filesize if you use 32x32 tiles on your texture map. So, whenever you have to fill a large area with a repeating pattern, make sure the small square you're repeating is 32x32 (or a multiple of it).

===Height Map===
Next is the height map. This must be exactly one eighth (1/8) of the size of the texture map '''+ 1 pixel!''' For instance, if the dimensions of your texture map are "4096 by 8192", divide 4096 and 8192 each by 8 and add one to the result of each. The result for this example would be "513 by 1025". The height map is a black and white BMP. Only use black and white, no colour! (well its better to work it as a greyscale image, and when saving to process, convert to rgb and save as bmp, that way you get a 24 bit bmp)

White areas are the tops of mountains; black areas are the sea floor or the bottom of valleys. The shades of grey between are the different heights between! When you draw your heightmap, make sure the white blends into the black with greys. I suggest you use the blur tool. If you have a white splodge in a patch of black you will have a very tall pillar that won't look natural at all!

===Metal Map===
Finally, you need a metal map. This is the same size as the height map, one eighth (1/8) of the size of the texture map '''+ 1 pixel.''' On this one you paint down red (in verying degrees) to represent metal. So a red spot that is RGB(50,0,0) will provide about a 5th of the metal patch of red RGB(255,0,0) will give.

On this map you can also place green pixels. Each green pixel will create 1 geothermal vent. If you put down a green splodge you will get a cluster of geo vents! Only place 1 pixel.

Ensure you have all three saved as 24 bit BMPs and you're ready to convert it all to a map!

== MapConv.exe ==

Instructions pulled from [http://fileuniverse.com/?p=showitem&ID=1234 the newest MapConv program]. If all goes well, the <code>MapConv.exe</code> should create four new files: <code>mini.bmp</code>, <code>mini.dds</code>, <code>yourmapname.smf</code>, and <code>yourmapname.smt</code>

USAGE:

mapconv [-l] [-i] [-c <compression>] -x <max height> -n <min height> [-o
<Output file>] [-e <tile file>] [-y <Typemap file>] -m <Metalmap file> -a
<Heightmap file> -t <Texture file> [--] [-v] [-h]

Where:

-l, --lowpass
Lowpass filters the heightmap

-i, --invert
Inverts the height map vertically (not the height values but the height map
(uhm someone rewrite this))

-c <compression>, --compress <compression>
(value required) How much we should try to compress the texture file.
Default value 0.8 . (lower=higher quality, larger file)

-x <max height>, --maxheight <max height>
(required) (value required) What altitude in spring the max(0xffff) level
of the height map should represent

-n <min height>, --minheight <min height>
(required) (value required) What altitude in spring the min(0) level of
the height map should represent

-o <Output file>, --outfile <Output file>
(value required) The name of the created map

-e <tile file>, --externaltilefile <tile file>
(value required) External tile file that will be used for finding tiles,
tiles not found in this will be added in a new tile file

-y <Typemap file>, --typemap <Typemap file>
(value required) Type map to use, uses the red channel to decide type,
types are defined in the .smd, if this argument is skipped the map will be
all type 0

-m <Metalmap file>, --metalmap <Metalmap file>
(required) (value required) Metal map to use, red channel is amount of
metal, green=255 is where to place geos (one pixel=one geo). Is resized to
fit the mapsize

-a <Heightmap file>, --heightmap <Heightmap file>
(required) (value required) Input heightmap to use for the map, this
should be in 16 bit raw format (.raw extension) or an image file. Must be
xsize*128+1 x ysize*128+1 in size.

-t <Texture file>, --intex <Texture file>
(required) (value required) Input bitmap to use for the map. Must be
xsize*1024 x ysize*1024 in size. (xsize,ysize integers determined from this
file)

--, --ignore_rest
Ignores the rest of the labeled arguments following this flag.

-v, --version
Displays version information and exits.

-h, --help
Displays usage information and exits.

Converts a series of .bmp/.raw files to a Spring map. This just creates the .smf file, you will also have to create a .smd file using a text editor or Maelstrom's SMD creator.

==Mothers MapConv==
The usage is the same as above, with the following exceptions:
All features (including GeoVent/Tree/Grass) are now on their own FeatureMap. This is a 24bit bmp specified with the -f <featuremapname.bmp> flag.
''It should be 1/8th the resolution of your map.'' (i.e. 1 pixel smaller in each direction then your heightmap)

Tree's and GeoVents are placed on the green layer.
*255 Places a GeoVent
*200-215 Places tree types 1-16

MapConv will try to place these features in the exact spot you place them, it will then go into crackhead mode if it cannot.

Grass is the blue layer. The blue value maps to a 'pseudo-density' of the grass. The 'grass' map in the engine is very very low resolution, so be aware that you will not get nice linear results. 255=full grass, 0=no grass.

The red layer places 'Arbitrary Features,' aka wreckages. One pixel of red equals one feature. Red '255' gives you a feature of the first arbitrary type, 254 the second, 253 the third, and so on.

===But what are these 'Arbitrary Features,' Im so confused!===
They are 'features' found in the /features/All Worlds or /features/corpses filesystems. Which feature is 'type 1' is defined on a map-by-map basis via a new file called 'fs.txt'. This file should contain <cr> delimited feature names. The first line is the feature placed when a red=255 dot is found, etc.

=== Ok, Now what do I do? ===
If you are using any custom features, and/or you want to mod-proof your map, you should include them in the sd7 that you package the map in. The tree structure should look something like:

<mapname.sd7>
-maps/
-mapname.smf
-mapname.smt
-mapname.smd
-Objects3d/
-<featurename[s]>.3do(specified in the tdf)
-features/
-All Worlds/
(and/or)
-Corpses/
-<featurename[s]>.tdf
-textures/
-tatex/
-<texname[s]>00.bmp or .tga

Without getting into modding/unit making I will say that the <code>.tdf</code> tells you the name of the <code>.3do</code> ("<code>Object=</code>"), and the name of the 'feature' is in the top brackets. The <code>.3do</code> specifies the texture names. The engine looks for those texture names + 00 in either bmp or tga format in tatex.

Examples of a built-in XTA wreckage name would be <code>armckfus_dead</code> which would be looking for a tdf (likely <code>armckfus_dead.tdf</code>) that has a <code>[armckfus_dead]</code> section which then specified something like:
<code>Object=armckfus_dead</code>
<code>armckfus_dead.3do</code> would then specify some texture like <code>wreck01b</code> which would go looking for either a <code>wreck01b00.bmp</code> or <code>wreck01b00.tga</code> file.

[http://fileuniverse.com/?p=showitem&ID=1421 Start with this version of MapConv]
or
[http://www.fileuniverse.com/?p=showitem&ID=1507 This one]
[I will clean this up and add more later --Mother]

==Making your map work==
This is the final push. Once Sharp map has finshed it will spit out a .sm2 file. This needs to be copied to the MAPS folder in Spring. But you still need one more thing: an .smd file. Basically, this file tells the game things like the maximum metal, the light colours, the clouds, etc. (All the bits you were thinking that you hadn't done yet!)

I would suggest you copy the .smd of another map and fiddle with the settings until you get what you want. smd's can be opened in notepad or similar. Look at all the .smd's so you can get a jist of what each option does. Make sure both the .sm2 and .smd have the same file name then start up Spring (not the client!) in [http://taspring.clan-sy.com/wiki/FAQ#People_talk_about_.27Single_Player.27._How_do_I_start_a_single_player_game.3F single-player mode] and run the commanders script. Choose your map and away you go!

==SMD Rundown==
What follows is all that we (aGorm and LathanStanley) have figured out in the SMD's. Its by no means the be all and end all, but it's the next best thing.

* Goto [[Maps:SMD]] for a more detailed listing

===General Map Information===
* Description is just a short description of your map. Keep it simple.
* TidalStrength determines how much energy tidal generators will produce. A normal figure is around 20.
* Gravity, as you would expect, affects ballisitcs and how far units fly after an explosion.
* MaxMetal is the maximum amount of metal you will gain from one game square in 1 second from an area of metal that had a red value of 255 in your metal map. If making an old style metal deposit map, then this will be quite high: maybe 2 or 3. If you are making a new style metal-all-over-the-place-map, then it will be low: perhaps 0.2. Also for old style maps, you'll have to fiddle with the...
* ExtractorRadius, which is the area that is harvested by 1 metal extractor. For old style maps make this very small, so as they only take from one deposit.

=== Atmosphere, Water Colours ===
Each value (it would appear this bit is by no means gospel) is a representation of the [[RGB]] values for that parameter. It would appear to be relative, i.e. you can put in what ever numbers you like and the game will work out what you want.

The best way to go about it is to look at it as percentages.
The numbers 1, 0.5, 0.2 refer to 100% red, 50% green and 20% blue. But 2, 1, 0.4, will get the same result. Using numbers below one for all the numbers will result in the colour being less bright.

This is all a bit confusing so an example will be given:

SkyColor=0.2 0.1 0.5;

In this example the sky is coloured with 20% red, 10% green, and 50% blue, approximatly RGB(51,25,127), resulting in a very deep night-time blue. Other colours are added to the initial sky colour. If you set your sun as being a pale yellow and it came out rather green, this is why.

One helpful tip is ''negative'' colour. That's right: you can type in a negative number for a colour and it will remove it from the base sky colour. Just be careful not to go below the original values or you may get a surprise.

===The Sun System/Shadow System===
The Sun System/Shadow System is quite a useful tool as well in making your maps look ''well done''.
Within the <code>.smd</code> file there is a line:

: <code>SunDir=-1 1 -.5; //direction of sun</code> (The part after the "//" is a comment)

The numbers "-1", "1", ".5" determine the angle and elevation of the sunlight system.

The first number is the X angle (East/West) (from -1 to 1) where any negative number means the sun is on the West (and therefore shadows will be cast east), and any positive number means the sun is on the East (and therefore shadows will be cast west), and if the number is 0 there are no east or west shadows, the sun is directly above you.

The second is its elevation, (0 to 1), this number is how far from the horizion the sun is, ignoring it's angle. Thus, 1 puts the sun directly overhead (while still casting angular shadows) and 0 putting it directly on the horizion.

The final number is the Z angle (North/South). (I know, I know, they wrote the engine with Y as elevation and Z as vertical. Don't blame me.) It is just like the East West positioning, where negative numbers put them on the North, and positive numbers put them on the South.

'''Example Usage:''' If you want the shadows ''in'' one of the boxes (your shadow casting surface is in the middle), use the numbers provided, or start from them and tweak the angle and sun height as seen fit.

[[Image:ShadowDirection.gif]]

'''Note:''' on the current build, it ''will'' cast the shadows in the proper direction, etc. Negative direction numbers tend to make some maps unstable and cause crashes. The best solution would be to rotate or flip your map to where the shadows point up or right (North or West). I do believe these bugs are being worked on and will be fixed soon.

We can only hope this has been helpful! Any questions, or things you think we have missed, please ask us in the maps section.

[[Category:Map making]]

Mapdev:Howto skybox

2009-08-31T17:41:22Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

==Skybox Information==
This is going to contain notes about the creation of skyboxes aka cubemaps.

Skyboxes are created with a series of 6 separate images which form what we call a cube map. Below is an example of the skybox images that I created for a map.

[[Image:Skyboxsimple.gif|center|this is what we call a cube cross]]

Despite what you will see on many sites you do not need a cube cross for the creation of your skybox. You will be using six individual images. Each image represents a different face on an imaginary cube. Each face is applied to the cube that surrounds the map.

[[Image:Sky1.gif|center|see how each side of the cube is it's own image]]

Here an image is being applied to the cubemap. See how each side of the cube is an image?

== Skybox creation ==

=== Creating your 6 textures ===
You will need six images representing each side of your skybox. I will not go into any specific method of construction. There are tutorials out there for that. Just remember you will need 6 textures, front, back, left side, right side, top and bottom.

=== Creating your dds using the nvidia dds utilities ===
You will need these utilities from Nvidia's website: [http://developer.nvidia.com/object/dds_utilities_legacy.html|NVIDIA Texture Tools]

Once you have downloaded and installed the tools you will need to created 2 files:
* '''Compiledds.bat''', and
* '''cubemapfile.lst'''

Inside of '''compiledds.bat''' type in:

nvdxt -cubeMap -list cubemapfile.lst -output cubemap.dds
pause

This will compile your skybox to the name '''cubemap.dds''', feel free to change the name. Also, the pause command will stop the the batch file and force it to wait before it closes, this will allow you to see any errors that may or may not occur.

Inside of '''cubemapfile.lst''' type in:

left.jpg
right.jpg
top.jpg
bottom.jpg
front.jpg
back.jpg

The .dds file created should be put in the '''maps/''' directory with your maps .smd, .smf and .smt files.

== Skybox notes ==

Do not do these:

Sizes that are not to the power of two. ATI cards have problems with sizes that are not a power of two. Reccomended sizes are: '''256X256''', '''512X512''' or '''1024x1024'''.

Note: the batch will export a DXT5 or something like that and spring has an issue with the newest dds stuff. I will update the command for you gents soon. I thought I already had... my bad.

--[[User:Smoth|Smoth]] 09:24, 25 Apr 2007 (CEST)

If you have problems with nvdxt:

You can also create dds textures using the Texture Tool found in the Microsoft DirectX SDK.

Although it is quite a large download it is worth while if you are serioues about making decent maps.

These instruction may not be the best however they have been proven to work with some success.

To create your cube map first open the DirectX Texture Tool. Go to File and select New Texture. Select Cubemap texture. Set the Width and Height as a power of two and leave the MipMap Levels at 1.

The Surface format should be 32bit X8R8G8B8. It may be possible to use other formats for example 24Bit and use less space. If you want to try that you will have to experiment. You can now press OK.

Go to file and select Open Onto This Cubemap Face. Select the image file you want to use for that face. You can select most common image formats such as jpg, bmp, png, etc. The image that you open should be the same width and height as you entered when creating the cubemap.

Now you have done one face and can do the next. To change face go to the View menu, the Cube Map View submenu and select the next face in the list. Open the image you want onto this face as you did before.

Keep doing this until you have opened an image onto every face, then save the file.

You now have a sky-box.

-Orakio

Map development

2009-08-31T17:41:06Z

Aegis:

[[Engine_Development|Development]] < {{FULLPAGENAME}}

=Map making: SM2=
Maps, are a complex mixture of heightmaps and textures.
Fortunately, there are several people who share their knowledge with us.
Their few tutorials will make your life as mapper a lot better. You can also use the SpringMapEdit tool to edit existing map or make new ones.

=Map making: SM3 (Experimental)=

SM3 (Spring Mapformat 3) is getting allong nicely and maps using this format can be made. The following is documented so far.

*[[SM3_Map_Format|jcnossen's brief description on how this mapformat works.]]
*[[SM3_FAQ|The first FAQ for the new mapformat.]]

'''''NOTE:''''' SM3 format is broken at the moment, do not use it. It only renders at all if sm3 shaders are disabled in springsettings, and even then with very low fps. Software rendering is corrupted on nvidia cards, but not on ati.

=Skyboxes=
*[[Skyboxcreation|Notes about skyboxes]] notes on a prerendered sky box or cube map.

= Full Guides For Map Making =

*[[Create_maps|aGorm's map creating Guide]]
*[[Map_Making_Guide|aGorms Ultimate Map Making Guide(unfinished)]]
*[[IceXuick_Map_Design_Help|IceXuicks Map creating Guide]]
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=3941 Forboding Angel's map creating Tutorial]
*[[Maps:Tutorial|Another tutorial from a designing point of view]]
*[[A_Complete_Map_Making_Tutorial|A Complete Map Making Tutorial (under construction)]]
*[[Runecrafter|Runecrafter's Map Tutorial]]
*[http://modinfo.adune.nl/map_making_guide.php Simple map making guide]
*[http://springrts.com/phpbb/viewtopic.php?f=13&t=15390 Beherith's map creating tutorial using the World in Conflict map editor]

= Specific Guides =

*[[Quanto_OTAMAP_Guide|Quanto's Guide to OTA Porting and Small Maps]]
*[[Maps:SMD|Everything about .SMD]]
*[[Maps:Compiling|Everything about Compiling your map]]
*[[MapsBalance|Some things about map balance]]
*[[MapSizes|Map sizes in pixels]] and memory information about map sizes
*[[Height Map Tutorial|RogerN's height map tutorial]]
*[[Create_map_texture_with_povray|Basic howto: create map texture with Povray]]

Features. Stones, rocks, trees, for your map can be found in [http://taspring.clan-sy.com/phpbb/viewtopic.php?t=4047 This thread] 

= Tools =

*[http://springrts.com/phpbb/viewtopic.php?f=13&t=16341 Frostregen's SpringMapEdit]. 3D editing, Compiles and import SM2 directly. Beginner friendly but still powerful.
*[http://taspring.clan-sy.com/phpbb/viewtopic.php?t=2420 Maelstrom's SMD Generator]
*[http://www.fileuniverse.com/?p=show&a=it&id=1507 Mother's Mapconv]
*[http://user.supradigital.org/jcnossen/FeaturePlacer.zip Jnossen's SM3 feature placer]
*[[Maps:Map Designer]] Hugh's 3D map designer. Splatting, heightmap editing, splat painting, SM3
*[http://modinfo.unknown-files.net/coord/mapcoords.php Online starting position creator(dead link)]: You can always find out which x/y coordinates are good while starting spring and having a look at the mouse cursor coordinates.

= Mappers Clan =
[[Map Making Guild]]: That weird fish aGorm set up a clan for poor mappers that can't get into a clan on there gaming merit... (Mainly for himself therefor...)

= Reference and FAQs =

* [[Maps:Noob Mistakes]]
* [[Water Height: Mapconv vs. Heightmap]]

----
TIPS:

A useful tip, on almost every map in a 1v1 you will start opposite your opponent unless you choose your position. this is because random order simply randomly distributes players at the default start points which in almost every map are opposite each other. One exception that I know of is flooded desert where you both start on the left hand island.
----
Make sure that your map's ideas and game-play is sound before you release it for good. Do a lot of beta testing and learn about good level design! You can learn about what makes a good map by playing on good maps, so play often and map well. -url00
----

[[Category:Map development]]

SM3 FAQ

2009-08-31T17:40:26Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

= Frequently Asked Questions on SM3 =

== What is DevIL ==
DevIL is the Image Loading library that spring uses.
http://openil.sf.net/

DevIL supports loading of bmp, dds, gif, jpg, png, pcx, psd, psp, tga, raw, pal, tif, pal, sgi, hdr among others.

== "Map Size (x) should be equal to GameAreaW and GameAreaH"? ==
For the map to load you need to add these two variables to your .sm3:
 
GameAreaW=xxx; 
GameAreaH=xxx; 
The map size(note, not the heightmap size which is map 1 pixel) width/height goes here.

== How do I use external textures? ==
Create a modinfo.tdf textfile in your mapname.sdd. It should contain:

[MOD] 
{ 
Name=mapname; 
Description=your description here; 
ModType=0; 
 
NumDependencies=1; 
Depend0=texturefilename.sd7; 
} 

This will tell Spring to look in the directory where your map is located(eg. \maps\) for the textures you have specified in the SM3. Example:

[Rock] 
{ 
TileSize=60; 
File=textures/rock/rock.jpg; 
Bumpmap=textures/rock/rock_normal.jpg; 
} 

Which would tell Spring that your texture is at texturefilename.sd7/textures/rock/rock.jpg.

[[Category:Map making]]
[[Category:SM3 map format]]

SM3 Map Format

2009-08-31T17:39:58Z

Aegis:

[[Engine_Development|Development]] < [[Map_development|Map Development]] < {{FULLPAGENAME}}

== Introduction ==

As opposed to the original SMF renderer, the SM3 map renderer allows multiple texture layers rendered on the terrain. This allows for higher texture resolutions and improved lighting such as bumpmapping/specular mapping.

Hugh Perkins has been working on a SM3 map editor:
http://taspring.clan-sy.com/phpbb/viewtopic.php?t=8094

== Map specification ==

Instead of a binary SMF file and a SMD file, all map information is now stored in a text based .SM3 file. This has the same basic layout as the original .SMD file, but it includes a [TERRAIN] section and an [INFOMAPS] section. It also has an extra tag in LIGHT (GroundSpecularColor):

[MAP]
{
// regular smd information, such as start positions,
// [WATER] and [ATMOSPHERE] sections...

[LIGHT]
{
// specular color, defaults to 0.1 0.1 0.1
GroundSpecularColor=0.3 0.3 0.3;

// other standard tags shared with SMF (such as GroundSunColor)...

}

[INFOMAPS]
{
metal=Maps/dry_data/metalmap.png;
type=Maps/dry_data/typemap.png;
}
[TERRAIN]
{
HeightScale=400.0;
HeightOffset=10.0;
Heightmap=Maps/dry_data/1026.png;

NumTextureStages=2; // all texture stages are multiplied
SpecularExponent=16; // specular exponent AKA
//shininess or polishedness. defaults to 8

[texstage0]
{
// the first texture stage operation is ignored
source=Snow;
}
[texstage1]
{
// use the incoming alpha to blend between 2 textures
operation=blend;
source=CrackedDirt;
blender=RockBlender1026;
}
/* texture definitions */
[CrackedDirt]
{
File=Maps/dry_data/dirt2.jpg;
Bumpmap=Maps/dry_data/dirt2_bm.jpg;
TileSize=50;
}
[Snow]
{
File=Maps/dry_data/Snow_Sand.jpg;
TileSize=20;
}

/* blender definition, all blenders have "Blendmap=1" */
// a rock blender loaded from file for a specific map
[RockBlender1026]
{
Blendmap=1;
File=Maps/dry_data/1026_bm_small.png;
}
}
}

== Heightmap specification ==

The heightmap is specified with 3 tags located in the [TERRAIN] section:

'''Heightmap:''' This should be either:
*An 8 or 16 bit image file readable by DevIL
*A 8 or 16 bit RAW file, such as generated by Terragen

'''HeightScale and HeightOffset:''' The actual height of a heightmap pixel is calculated scaled by HeightScale, after which HeightOffset is added to it (height = pixel * HeightScale + HeightOffset)

== Texturing method specification (how are the textures applied) ==

=== Texture stages/layers ===

Texturing of SM3 terrains works by a series of texture layers that are applied on top of eachother. These layers are called "texture stages". The stages can be added, multiplied, or alpha blended with the previous stage. This is defined by the stage operation.

The number of stages is given with the tag NumTextureStages like:

NumTextureStages=2;

Keep in mind that the stages are directly executed on your videocard. This means the more stages you make the slower the map will render.

The first stage never has an operation:

[texstage0]
{
source=Snow;
}

Following stages can have "operation=add", "operation=mul", "operation=blend"

==== Operation Add ====

The add operation needs a texture to add to the previous stage, which is specified with the "source=TextureName" tag. The texture specification is explained below.

[texstage1]
{
operation=add;
source=CrackedDirt;
}

==== Operation Multiply ====

Same as add, but with operation=mul

[texstage1]
{
operation=mul;
source=CrackedDirt;
}

==== Operation Blend ====

The blend operation does alpha blending with an extra grayscale alpha texture. Specification of these alpha textures ("Blendmaps") is explained later in this doc. The blend operation needs a "blender=BlenderName" tag to work. I'm guessing most maps will only be using this operation.

[texstage1]
{
operation=blend;
source=CrackedDirt;
blender=RockBlender1026;
}

The avaiable operations are limited to add/mul/blend for techical reasons:
This way even the most complex maps can be executed with multipass operations on any card with at least 2 textures units. It would even work on a Riva TNT I think.

Obviously because the first stage doesn't have any previous stage, the operation of the first stage is ignored

=== Textures ===

==== Tiled textures ====

The operations usually have "source=texturename" in them, which points to the name of a tiled texture.

Example:

NumTextureStages=1;
[texstage0]
{
source=Snow;
}

[Snow]
{
File=Maps/dry_data/Snow_Sand.jpg;
TileSize=20;
}

Tilesize is how big a single tile is in the 3D spring world, when the texture is tiled across the map. Imagine a heightmap of 1025x1025 (In spring world space this is 1024*8= 8192x8192 units).
When you set tilesize=4096, you will see the complete texture 4 times on the map (2 by 2). Set it to 8192 and you'll see the map completely covered.

==== Blendmap specification ====

Blendmaps can either be loaded from file or generated from the terrain. They are stretched across the full terrain, so in combination with the blend operation you can specify exactly where you want to see a specific texture on the terrain.

===== Blendmaps from file =====

Blendmaps can be loaded from any grayscale file that DevIL can load:

[RockBlender]
{
Blendmap=1;
File=Maps/dry_data/1026_bm_small.png;
}

===== Generated blendmaps =====

Blendmaps can be generated from the heightmap. The final value is computed by

blendmap_value = SlopeTerm * HeightTerm * coverage * noise

The slope of the terrain is a value between 0 and 1, with 0 being flat and 1 being completely steep. Ofcourse with a heightmap the slope can only be near 1 and not exactly 1

The height of the terrain is between 0 and 1 (the minimum and maximum height value)
If the height is between minHeight and maxHeight, HeightTerm will be 1. maxHeightFuzzy and minHeightFuzzy determine the "border" size between having a HeightTerm of 0 and a HeightTerm of 1.

GeneratorLOD indicates at which resolution the blendmap should be generated. The blendmap size will be (heightmapsize-1) / (2 ^ generatorLOD). For example with a heightmap width of 1025 and a generatorlod of 2, the blendmap size will be 1024/4=256.

(Images illustrating this will be added later)

== Infomaps ==

The infomaps section defines the metal map and typemap. Both should be 8 bit images in any format DevIL accepts.

== Image file sizes ==

* The heightmap has to be square and its dimensions have to be a power-of-two + 1, like 257x257, 513x513, 1025x1025
* The blendmaps have to be square too, with power-of-two dimensions like: 256x256, 512x512, 1024x1024. They should be smaller than the heightmap.
* The tiled textures should have power-of-two dimensions, but don't have to be square
* The minimap can be anything, but it will be resized to an image of 1024x1024. Specifying a 1024x1024 will allow faster loading because no resizing is needed.
* Typemap and metalmaps dimensions should be (heightmapsize - 1) / 2, so when the heightmap is 1025x1025, the typemap is 512x512.
* The heightmap can be any [http://openil.sourceforge.net/features.php DevIL] supported format, or RAW such as exported by terragen. All the other maps/texture files can only be a DevIL format.

== Feature placement ==

The feature specification is done with a list of feature type names in the SM3 itself, and with a binary datafile that contains all the feature positions, orientations.
Feature types are specified like this:

[FeatureTypes]
{
NumTypes=4;
type0=TreeType0; // a tree
type1=MyFeature;
type2=MyOtherFeature;
type3=GeoVent; // a geothermal
}

The feature binary file should be made with an editor. I'm hoping Maelstrom will add feature placing to his startpoint editor, but until then there's only http://user.supradigital.org/jcnossen/FeaturePlacer.zip

[[Image:Featureplacer.png]]

The "Pos:" fields are ment to enter the feature X,Y,Z. You can use zero for Y because spring will automatically put the feature on the ground when it loads.
Type is the index into the feature type list specified in the SM3 file.

The feature data file should be linked to the SM3 with:

[MAP]
{
// other map tags ...
featuredata=FeatureDataFileName;
}

== Minimap ==

The minimap is loaded from an image file that you have to set in the MAP section of the sm3 file.
Example:

[MAP]
{
// other map tags ...
minimap=maps/data/minimap.png;
}

== TODO ==

* fix bugs

[[Category:Map making]]
[[Category:SM3 map format]]

Lua ConstGame

2009-08-31T17:28:47Z

Aegis:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

= Engine =
string '''Game.version'''

number '''Game.gameID'''

number '''Game.maxUnits''' 
number '''Game.maxTeams''' 
number '''Game.maxPlayers''' 
number '''Game.squareSize''' 
number '''Game.gameSpeed'''

= Host =
number '''Game.gameMode''' 
number '''Game.startPosType'''

boolean '''Game.commEnds''' 
boolean '''Game.limitDGun''' 
boolean '''Game.diminishingMetal''' 
boolean '''Game.ghostedBuildings'''

= Checksums =
string '''Game.mapChecksum''' 
string '''Game.modChecksum'''

= Map =
string '''Game.mapName''' 
string '''Game.mapHumanName''' 
number '''Game.mapX''' 
number '''Game.mapY''' 
number '''Game.mapSizeX''' in worldspace/opengl coords 
number '''Game.mapSizeZ''' in worldspace/opengl coords 
number '''Game.gravity''' 
number '''Game.tidal''' 
number '''Game.windMin''' 
number '''Game.windMax''' 
number '''Game.extractorRadius''' 
number '''Game.waterDamage'''

= Mod =
string '''Game.modName''' 
string '''Game.modShortName''' 
string '''Game.modVersion''' 
string '''Game.modMutator''' 
string '''Game.modDesc'''

boolean '''Game.allowTeamColors''' 
number '''Game.transportAir''' 
number '''Game.transportShip''' 
number '''Game.transportHover''' 
number '''Game.transportGround''' 
number '''Game.fireAtKilled''' 
number '''Game.fireAtCrashing''' 
boolean '''Game.requireSonarUnderWater'''

= Constructor =
boolean '''Game.constructionDecay''' 
number '''Game.constructionDecayTime''' 
number '''Game.constructionDecaySpeed''' 

number '''Game.multiReclaim''' 
number '''Game.reclaimMethod''' 
number '''Game.reclaimUnitMethod''' 
number '''Game.reclaimUnitEnergyCostFactor''' 
number '''Game.reclaimUnitEfficiency''' 
number '''Game.reclaimFeatureEnergyCostFactor''' 
boolean '''Game.reclaimAllowEnemies''' 
boolean '''Game.reclaimAllowAllies''' 
number '''Game.repairEnergyCostFactor''' 
number '''Game.resurrectEnergyCostFactor''' 
number '''Game.captureEnergyCostFactor'''

= Categories =
table '''Game.springCategories'''

example: {
["vtol"] = 0, ["special"] = 1, ["noweapon"] = 2,
["notair"] = 3, ["notsub"] = 4, ["all"] = 5,
["weapon"] = 6, ["notship"] = 7, ["notland"] = 8,
["mobile"] = 9, ["kbot"] = 10, ["antigator"] = 11,
["tank"] = 12, ["plant"] = 13, ["ship"] = 14,
["antiemg"] = 15, ["antilaser"] = 16, ["antiflame"] = 17,
["underwater"] = 18, ["hover"] = 19, ["phib"] = 20,
["constr"] = 21, ["strategic"] = 22, ["commander"] = 23,
["paral"] = 24, ["jam"] = 25, ["mine"] = 26,
["kamikaze"] = 27, ["minelayer"] = 28, ["notstructure"] = 29,
["air"] = 30
}
table '''Game.armorTypes''' (bidirectional)

example: {
[1] = amphibious, [2] = anniddm, [3] = antibomber,
[4] = antifighter, [5] = antiraider, [6] = atl,
[7] = blackhydra, [8] = bombers, [9] = commanders,
[10] = crawlingbombs, ...

["amphibious"] = 1, ["anniddm"] = 2, ["antibomber"] = 3
["antifighter"] = 4, ["antiraider"] = 5, ["atl"] = 6
["blackhydra"] = 7, ["bombers"] = 8, ["commanders"] = 9
["crawlingbombs"]= 10, ...
}

= Water Visuals =
boolean '''Game.waterVoid''' 
boolean '''Game.waterPlane''' 
string '''Game.waterTexture''' 
number '''Game.waterRepeatX''' 
number '''Game.waterRepeatY''' 
string '''Game.waterFoamTexture''' 
string '''Game.waterNormalTexture''' 
table '''Game.waterCausticTextures''' = {"tex1","tex2",..} 
color '''Game.waterAbsorb''' = { number r, number g, number b} 
color '''Game.waterBaseColor''' 
color '''Game.waterMinColor''' 
color '''Game.waterSurfaceColor''' 
number '''Game.waterSurfaceAlpha''' 
color '''Game.waterSpecularColor''' 
number '''Game.waterSpecularFactor''' 
color '''Game.waterPlaneColor''' 
number '''Game.waterFresnelMin''' 
number '''Game.waterFresnelMax''' 
number '''Game.waterFresnelPower''' 
color '''Game.fogColor''' 
color '''Game.groundAmbientColor''' 
color '''Game.groundSpecularColor''' 
color '''Game.groundSunColor'''

Lua-LuaCOB

2009-08-31T17:20:12Z

Aegis:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

'''NOTE LuaCob will merged with LuaRules in 76b2'''

=Introduction=
To use Lua code in your BOS/COB files, you can either include the gadgetHandler (include it in the mod, see the CA mod or include it from the springcontent.sdz) or you create your own enviroment:
*create a mod-level directory LuaCOB/,
*make a LuaCOB/main.lua file. (Note: it's LuaRules/main.lua now)
Any additional files need to be included with a

include("LuaCOB/additional_file.lua" [, fenvTable])

If you don't know what a fenvTable is, don't worry, you probably don't need it anyway.
More information can be found on [http://www.lua.org the Lua site]. It it highly recommended to read the manual and the tutorials found there. Note that Spring 76b1 used Lua version is 5.1.2, so please take note which version of the manual you're reading.

Also note that the usual Lua functions for executing code in other files (<tt>dofiles()</tt>, <tt>require()</tt>) are disabled for technical reasons.

=Interfacing COB->Lua=
All Lua functions that are called by COB are given three parameters:
*unitID - ID of the unit calling the function,
*unitDefID - ID of the unitDef,
*teamID - self-explanatory.
You can call scripts with any (enough for all practical purpouses) amount of additional arguments.

Example functions:

function GetNearestEnemy(unitID, unitDefID, teamID, radius)
local px, py, pz = Spring.GetUnitPosition(unitID)
if (px == nil) then
return
end

local nearDist = 1.0e20
local nearUnit
local units = Spring.GetUnitsInCylinder(px, pz, radius)
for _,enemyID in ipairs(units) do
if (not Sim.IsUnitAllied(enemyID)) then
local ex, ey, ez = Spring.GetUnitPosition(enemyID)
if (ex ~= nil) then
local dx, dy, dz = (px - ex), (py - ey), (pz - ez)
local dist = (dx * dx) + (dy * dy) + (dz + dz)
if (dist < nearDist) then
nearUnit = enemyID
nearDist = dist
end
end
end
end

if (nearUnit == nil) then
return -1
else
return nearUnit
end
end

Please note that returning tables doesn't currently work as one could expect. ''(Description what it does here)'' If you want to return multiple values from a table, you need to do it like this:

function ReturnSomeValues(u, ud, t, ...)
return arg[1], arg[2], arg[3] -- instead of arg
end

==Calling Lua from BOS==
To call a Lua function from BOS code, you need to declare it first:
// BOS
lua_MyFunction() { return 0; }
Then just call this script. The <tt>lua_</tt> prefix does its magic and routes the call to Lua code instead of calling the usual BOS code. Note that arguments don't matter, they are passed anyway:
call-script lua_MyFunction(arg1, arg2);
===Getting output===
If you wish to print out some debugging info, please note that <tt>print</tt> and <tt>io.write</tt> don't quite work in Windows versions of Spring, since stdout isn't availible (or is well-hidden.) Use <tt>Spring.Echo("a string")</tt>, this will print a message to the Spring console and into the infolog.

===LUA0..9===
// the GET/SET constants
#define LUA0 110
#define LUA1 111
#define LUA2 112
#define LUA3 113
#define LUA4 114
#define LUA5 115
#define LUA6 116
#define LUA7 117
#define LUA8 118
#define LUA9 119

<tt>get LUA0</tt> is used to check whether call succeeded (1 if true, 0 otherwise.) LUA1..9 store return values, e.g. <tt>lua_ReturnSomeValues</tt> above would put its first argument into <tt>get LUA1</tt>, second into <tt>get LUA2</tt>, and so on.

==Summary==
Steps needed to call a Lua function in a BOS call-script call:
*define a Lua function <tt>MyFunction(unitID, unitDefID, teamID, ...)</tt> in LuaCOB/main.lua or a file included by it
*define a BOS/COB script <tt>lua_MyFunction() { return 0; }</tt> so the compiler knows about it
*call your function with <tt>call-script lua_MyFunction()</tt>
*return values can be found in <tt>get LUA1..9</tt>
*<tt>get LUA0</tt> returns 1 when call was successful (regardless of its return values) and 0 in case of failure.

===Examples of code===
*[http://neoteric.pl/~imbaczek/spring/messages_lua.zip Inter-unit communication] (shameless plug ;p) - a library that allows passing messages between units and reading/writing of public variables exposed by them.Included is a tech demo involving modified [[Nanoblobs]] 0.64. Patch, start the game, make a sheep and see for yourself.
* <big>Your own!</big>

=Interfacing Lua->COB=

Lua:
Spring.CallCOBScript(unitID, "CustomScript", retArgCount, arg1, ..., argN)
Spring.CallCOBScriptCB(unitID, "CustomScript", retArgCount, callbackData, arg1, ..., argN)

'''retArgCount:''' the number of arguments expected to be returned'''
'''callbackData:''' number passed to CobCallback() when the cob call completes

COB:
CustomScript(arg1, ..., argN) { ... }

One particularly useful COB script, since Lua doesn't seem to have a way of making <tt>get SOMETHING(args)</tt> requests (but it may provide other ways of getting the same information):
LuaGet(r, cmd, p1, p2, p3, p4)
{
if (r == 0) { r = get cmd; return r }
if (r == 1) { r = get cmd(p1, 0, 0, 0); return r }
if (r == 2) { r = get cmd(p1, p2, 0, 0); return r }
if (r == 3) { r = get cmd(p1, p2, p3, 0); return r }
if (r == 4) { r = get cmd(p1, p2, p3, p4); return r }

return 1234;
}

=References=
#[http://spring.clan-sy.com/phpbb/viewforum.php?f=23 Spring Lua Scripts forum]
#[http://spring.clan-sy.com/phpbb/viewtopic.php?t=9329 trepan's description of Lua-COB interface] - a little bit outdated, but still worth a read

=Thanks=
trepan for doing the hard work of integrating Lua into Spring!

NOTE from trepan:
Thanks, but there were lua startscripts before I started doing
any Spring coding. The benefits of the new LuaCob, LuaGaia, and
LuaRules scripts are that they can be loaded from map/mod archives,
and that they all use the same base libraries (as does LuaUI).
They also have significantly more features then the current
startscript code (ex: more call-ins and call-outs, the ability to
render graphics in several different modes, play sounds, etc...)

UI commands

2009-08-31T17:14:54Z

Aegis:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

select 
selectunits 
deselect 
shadows 
water 
advshading 
say 
w 
echo 
setf 
seti 
sets 
drawinmap 
drawlabel 
mouse[1-5] 
viewselection 
move[forward, back, left, right, up, down, fast, slow] 
team 
spectator 
specteam 
specfullview 
ally 
group[0-9] 
lastmsgpos 
char[, all, ally, spec] 
track 
trackoff 
trackmode 
showhealthbars 
pause 
debug 
nosound 
volume 
unitreplyvolume 
savegame 
createvideo 
updatefov 
drawtrees 
dynamicsky 
gameinfo 
hideinterface 
hardwarecursor 
[increase, decrease]viewradius 
[more, less]trees 
[more, less]clouds 
speedup 
slowdown 
controlunit 
showshadowmap 
showstandard 
showelevation 
toggleradarandjammer 
showmetalmap 
showpathmap 
yardmap4 (does nothing) 
togglelos 
sharedialog 
quitwarn 
quit 
[inc, dec]guiopacity 
screenshot 
grabinput 
clock 
cross 
fps 
info 
techlevels 
cmdcolors 
ctrlpanel 
font 
aiselect 
vsync 
safegl 
resbar 
tooltip 
console 
endgraph 
fpshud 
mapmarks 
allmapmarks 
luaui 
minimap 
grounddecals 
maxparticles 
gathermode 
pastetext 
buffertext 
inputtextgeo 
lodscale 
wiremap 
setgamma 
crash 
exception 
divbyzero 
give 
send 
save 
atm 
desync (debug only) 
resync 
take 
luarules

LuaCallinReturn

2009-08-31T17:10:48Z

Aegis:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

===Lua Call-Ins, with parameters===

''Here are the known reserved parameter values for all Lua Call-Ins. If you add new Call-Ins to Spring, please document them here.''

==Commands, general-purpose:==

Shutdown() --> none.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button"

MouseRelease() --> "x, y, button"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitCreated() --> "unitID, unitDefID, teamID" ... I hope that's self-explanatory

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> unknown, please document.

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag"

==Drawing:==

* DrawGenesis() --> none. Don't render here.

* Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

* Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

* Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GamePreload() --> none.

GameStart() --> none.

GameOver() --> none.

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID"

ProjectileDestroyed() --> "proID"

LuaCallinReturn

2009-08-31T17:10:16Z

Aegis:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

Lua Call-Ins, with parameters 

''Here are the known reserved parameter values for all Lua Call-Ins. If you add new Call-Ins to Spring, please document them here.''

==Commands, general-purpose:==

Shutdown() --> none.

LayoutButtons() --> unknown, please document.

ConfigureLayout() --> "command".

CommandNotify() --> "id, params, options", where id = the CommandID

KeyPress() --> "key, mods, isRepeat", where key = keymap, mods = SHIFT, etc.

KeyRelease() --> "key"

MouseMove() --> "x, y, dx, dy, button"

MousePress() --> "x, y, button"

MouseRelease() --> "x, y, button"

IsAbove() --> "x, y" where x,y = screen coordinates.

GetTooltip() --> "x, y" where x,y = screen coordinates. Returns WorldTooltip.

AddConsoleLine() --> "msg, priority"

AllowCommand() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"

CommandFallback() --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

CommandsChanged() --> unknown (none?)

AllowUnitCreation() --> "unitDefID, builderID, builderTeam, x, y, z"

AllowUnitTransfer() --> "unitID, unitDefID, oldTeam, newTeam, capture"

AllowUnitBuildStep() --> "builderID, builderTeam, unitID, unitDefID, part"

AllowFeatureCreation() --> "featureDefID, teamID, x, y, z"

AllowFeatureBuildStep() --> unknown, please document.

AllowResourceLevel() --> "teamID, res, level"

AllowResourceTransfer() --> "teamID, res, level"

==Unit-Specific:==

UnitPreDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitDamaged() --> "unitID, unitDefID, unitTeam, damage, paralyzer, weaponID, attackerID, attackerDefID, attackerTeam"

UnitCreated() --> "unitID, unitDefID, teamID" ... I hope that's self-explanatory

UnitFinished() --> "unitID, unitDefID, teamID"

UnitFromFactory() --> "unitID, unitDefID, unitTeam, factID, factDefID, userOrders"

UnitDestroyed() --> "unitID, unitDefID, teamID"

UnitTaken() --> "unitID, unitDefID, unitTeam, newTeam"

UnitGiven() --> "unitID, unitDefID, unitTeam, oldTeam"

UnitIdle() --> "unitID, unitDefID, teamID"

UnitCommand() --> unknown, please document.

UnitSeismicPing() --> "x, y, z, strength"

UnitEnteredRadar() --> "unitID, unitTeam"

UnitEnteredLos() --> "unitID, teamID"

UnitLeftRadar() --> "unitID, unitTeam"

UnitLeftLos() --> "unitID, unitDefID, teamID"

UnitLoaded() --> "unitID, unitDefID, unitTeam, transportID, transportTeam"

UnitUnloaded() --> "unitID, unitDefID, teamID, transportID"

UnitCloaked() --> "unitID, unitDefID, teamID"

UnitDecloaked)--> "unitID, unitDefID, teamID"

UnitMoveFailed() --> "unitID, unitDefID, unitTeam"

StockpileChanged() --> "unitID, unitDefID, unitTeam, weaponNum, oldCount, newCount"

UnitEnteredWater() --> "unitID, unitDefID, teamID"

UnitEnteredAir() --> "unitID, unitDefID, teamID"

UnitLeftWater() --> "unitID, unitDefID, teamID"

UnitLeftAir() --> "unitID, unitDefID, teamID"

==Feature-Specific:==

FeatureCreated() --> "featureID, allyTeam"

FeatureDestroyed() --> "featureID, allyTeam"

TerraformComplete() --> "unitID, unitDefID, unitTeam, buildUnitID, buildUnitDefID, buildUnitTeam"

UnitCmdDone() --> "unitID, unitDefID, unitTeam, cmdID, cmdTag"

==Drawing:==

* DrawGenesis() --> none. Don't render here.

* Spring draws the sky, the map, some water types, and unit selection.

* DrawWorldPreUnit() --> none.

* Spring draws units, features, some water types, cloaked units, and the sun.

* DrawWorld() --> none.

* Spring draws command queues, 'map stuff', and map marks.

Each unit might also have a DrawUnit call, [[Lua_UnitRendering|enabled here.]]

DrawUnit(unitID,DrawMode) 
With enum DrawMode { 
notDrawing = 0, 
normalDraw = 1, 
shadowDraw = 2, 
reflectionDraw = 3, 
refractionDraw = 4 
};

DrawScreenEffects() --> "vsx, vsy" where vsx, vsy are screen coords.

DrawScreen() --> none.

DrawInMiniMap() --> "sx, sy" where sx,sy are values relative to the minimap's position and scale.

DrawWorldShadow() --> none.

DrawWorldReflection() --> none.

DrawWorldRefraction() --> none.

==Game Events:==

Explosion() --> "weaponID, px, py, pz, ownerID"

ShockFront() --> "power, dx, dy, dz"

GameFrame() --> "frameNum"

CobCallback() --> unknown, marked FIXME.

GroupChanged() --> "groupID" where groupID is the value of Group whose table value changed.

WorldTooltip() --> "ttType, data1, data2, data3" special, should be documented in detail.

GamePreload() --> none.

GameStart() --> none.

GameOver() --> none.

TeamDied() --> "TeamID" where TeamID = the team that has been eliminated.

==Projectiles:==

ProjectileCreated() --> "proID, proOwnerID"

ProjectileDestroyed() --> "proID"

Lua BitOps

2009-08-31T17:10:07Z

Aegis:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== Bit Operators ==
'''math.bit_and'''
( int a1 [, int a2 [, ... ] ] ) -> int i

'''math.bit_or'''
( int a1 [, int a2 [, ... ] ] ) -> int i

'''math.bit_xor'''
( int a1 [, int a2 [, ... ] ] ) -> int i

'''math.bit_inv'''
( int a1 ) -> int i

'''math.bit_bits''' (result = result | (1 << aX);)
( int a1 [, int a2 [, ... ] ] ) -> int i

Lua Scream

2009-08-31T17:10:01Z

Aegis:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== Scream UserData Object ==
'''Script.CreateScream'''
( ) -> userdata scream

This creates an userdata object, which calls a special
user-defined function, when the object gets destroyed
(->garbage collector).
You use it like the follow:

'''local myScream = Script.CreateScream()'''
'''myScream.func = function() Spring.Echo("AHHHHHH") end'''

Lua VFS

2009-08-31T17:09:55Z

Aegis:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== Modes ==
'''VFS.RAW''' 
'''VFS.MOD''' (unimplemented, acts like VFS.ZIP) 
'''VFS.MAP''' (unimplemented, acts like VFS.ZIP) 
'''VFS.BASE''' (unimplemented, acts like VFS.ZIP) 
'''VFS.ZIP''' 
'''VFS.RAW_FIRST''' 
'''VFS.ZIP_FIRST''' 
'''VFS.RAW_ONLY''' (same as VFS.RAW) 
'''VFS.ZIP_ONLY''' (same as VFS.ZIP) 

== Files ==
'''VFS.Include''' (if enviroment=nil then use current one)
( string "filename" [, table enviroment [, number mode ] ] ) ->
'''VFS.LoadFile'''
( string "filename" [, number mode ] ) -> nil | lstring data
'''VFS.FileExists'''
( string "filename" [, number mode ] ) -> boolean
'''VFS.DirList'''
( string "directory" [, string "pattern" [, number mode ] ] )
-> { [1] = string filename, ... }
'''VFS.SubDirs'''
( string "directory", [, string "pattern" = "*" [, number mode ] ] )
-> { [1] = string subdir1, ... }
'''VFS.UseArchive''' unsynced only!
( string "filename" [, number mode ], lua_function [, arg1 [,arg2 ]] )
-> result1,result2,... of the given lua_function

== Packing ==
The Pack- and Unpack-functions are used to convert numbers->strings and strings->numbers.
So you can read a binary file and then convert the received strings back to numbers and the other way around. Also you can use it in combination with the SendLuaXYZMsg-functions.

'''VFS.PackU8'''

'''VFS.PackU16'''

'''VFS.PackU32'''

'''VFS.PackS8'''

'''VFS.PackS16'''

'''VFS.PackS32'''

'''VFS.PackF32'''

arguments are:

'''VFS.PackX( number arg1, number arg2, number arg3, ... )''' -> string

'''VFS.PackX( {[1]=number,[2]=number,..} )''' -> string

'''VFS.UnpackU8'''

'''VFS.UnpackU16'''

'''VFS.UnpackU32'''

'''VFS.UnpackS8'''

'''VFS.UnpackS16'''

'''VFS.UnpackS32'''

'''VFS.UnpackF32'''

arguments are:

'''VFS.UnpackX( string "binary" [, number offset ] [, number count] )'''
-> number | table { [1]=number,[2]=number,.. }

Lua PathFinder

2009-08-31T17:09:52Z

Aegis:

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== PathFinder ==
'''Spring.RequestPath'''
( string "MoveTypeName" | number moveID,
number start_x, number start_y, number start_z,
number end_x, number end_y, number end_z
[, number radius = 8 ]
) -> nil | pathObject path (see bellow)

== Path UserData Object ==
'''Path.GetEstimatedPath'''
( ) -> nil | {
[1] = { x,y,z }, ...
},{
[1] = startIdxOfDetailedPath,
[2] = startIdxOfDetailedEstimatedPath1,
[3] = startIdxOfDetailedEstimatedPath2,
}
GetUnitEstimatedPath() returns 2 tables:
1 table with the waypoints and 1 table with 3 indices (in the waypoint table)
when a new (more lazy) pathfinding algorithm begins.
So the waypoint table contains 3 different levels of details.

'''Path.Next'''
( number pos_x, number pos_y, number pos_z,
[, number radius = 0 ]
) -> nil | number x, number y, number z