Map scripting

The map scripting feature of OpenRA allows you to create custom shellmaps, minigames, single player/co-op missions and more.

The Lua scripting language is used in OpenRA for scripting maps. There is no need to download Lua from the website; a custom build of Lua is included with recent versions of the game.

IDE support

You can use any programmers text editor or Lua supporting IDE (integrated development environment). A convenient way is to also use MonoDevelop for both the C# editing and Lua scripting. Go to Tools - Add-In-Manager and install the MonoDevelop Lua bindings.

You will then get syntax highlighting and basic code completion for the .lua files referenced in the OpenRA.sln main project file.

Setting up Lua for your map

This guide assumes you have knowledge of creating and editing OpenRA maps (See Mapping).

Lua script code is to be contained in one or more .lua files within the map archive, next to map.yaml and map.bin. All script files for a particular map must be within the map's archive.

See Lua-API for more details.

Examples

• Single-Player Missions
• Tiberian Dawn Shellmap

See also

• Mapping
• Creating a single player map
• Custom Paradrops on a Map
• Triggers
• Setting a patrol
• Making Production Buildings on a Map