Skip to content
kyrreso edited this page Oct 23, 2011 · 142 revisions

---Under construction, first add codes and examples, then clean up---

Mapping

Table of contents

  1. Introduction
  2. Getting Started
  3. Advanced

1. Introduction

OpenRA comes with a easy understandable map editor. With this tool you can create or edit maps that already exist. Though there is a limit of what you can do in this program, we'll try to cover the most things in this document.

2. Getting started

You will find the editor inside the OpenRA folder. You can start the editor by lunching the executable named 'OpenRA.Editor'. Note that you will need .NET framework installed to run the editor or the game.

Navigation

When you start up the editor you will find 3 major areas. The middle area is where the map is represented.

3. Advanced

File format

Maps are created in a '.oramap' extension, these files basically work as a '.zip' archive. You can open these files with a archive program such as WinZip, WinRAR, and more. Each map contains a 'map.ya* ````````> > ml' and 'map.bin'. The 'map.yaml' which contains basic information about the map. You can open the '.yaml' file with just a normal text editor as it only contains text. You can change the data in this file to your own liking.

  • Standard information
    • Selectable
      info: if the map should be listed in-game. type: boolean
    • MapFormat
      info: unknown. type: integer
    • Title
      info: title of the map. type: string
    • PlayerCount
      info: number of players. type: integer
    • Tileset
      info: which tileset the map use. type: enum (TEMPERAT, INTERIOR, SNOW)
    • MapSize
      info: size of the map. type: integer. format: int, int
    • TopLeft
      info: where the map start. type: 2d-location
    • BottomRight
      info: where the map end. type: 2d-location
    • UserAsShellmap
      info: if you want the map to appear in the main menu background of the game. type: boolean
    • Type
      info: what type the map is. type: enum (Conquest, ...)
  • Players
    • PlayerReference
      • Name
        info: name of the player (have nothing to do with in-game). type: string
      • Palette
        Name of a palette to use -- see system.yaml for world-defined palettes.
      • OwnsWorld
        Whether this player owns the world (trees, etc). This is used just for the Neutral player. type: boolean
      • NonCombatant
        Whether this player should be considered for victory conditions, player listing, etc. type: boolean
      • Playable
        info: if these player is playable or not. type: boolean
      • DefaultStartingUnits
        info: if this player will start with a MCV or not. type: boolean
      • AllowBots
        Whether this player can be played by a bot. type: boolean
      • LockRace
        info: if the race is locked for this player. type: boolean
      • Race
        info: what race that is default selected. enum (allies, soviet)
      • LockColor
        info: if the color for this player is locked or not. type: boolean
      • Color, Color2 -- defunct, use an HSLR ColorRamp instead.
      • ColorRamp
        info: default color for this player. type: integer. format: int,int,int,int. H,S,L,R
      • InitialCash
        info: starting cash for this player. format: integer
      • Allies
        info: the allies the player have. type: string (list of player names)
      • Enemies
        info: the enemies the player have. type: string (list of player names)
    • Actors
      • ActorID
        • Location
        • Owner
    • Waypoints -- defunct. Use actors of type 'mpspawn'.
    • Smudges
    • Rules
    • Sequences
    • Weapons
    • Voices

Tutorials

  • Create your first map -Open Openraeditor, file new,
  • Change ownership of units and structures (need to be done)
  • Create a simple script (need to be done)

Examples

Setting units and building

WEAP:
	Building:
		Power: 0  -> means how much power it uses
	Health:
		HP: 3000  ->makes it harder to destroy
	Valued: 
		Cost: 8000 
AFLD:
	Health:
		HP: 1000
	RevealsShroud:
		Range: 99999    -> This setting for the building/unit to reveal all map

##setting players

Type: Minigame

Players: PlayerReference@Neutral: ->The default user if you want buildings to capture Name: Neutral OwnsWorld: True NonCombatant: True Race: allies PlayerReference@Creeps: ->Not sure what that means Name: Creeps NonCombatant: True Race: allies PlayerReference@Multi0: ->Do this for all players, like Multi-0-7=8players Name: Multi0 Playable: True LockRace: True -> If only one race is to be selected Race: soviet Enemies: Multi1,Multi2,Multi3,Multi4,Multi5,Multi6,Multi17

Other

-Waypoint is just a way to help the scripters find a spot -Coordinates is first horizontal then vertical from upper left corner

Questions

Feel free to ask us in IRC and the forum

Players ๐ŸŽฒ

Modders โœ๏ธ

Developers ๐Ÿ”ง

Clone this wiki locally