Difference between revisions of "FA Forever Map Editor"

From FA Forever Wiki
Jump to: navigation, search
(Heightmap brush)
(Improved some english.)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
 
[[File:faf_mapeditor_logo.png|300px|thumb|right|FAF Map Editor]]
 
[[File:faf_mapeditor_logo.png|300px|thumb|right|FAF Map Editor]]
'''FA Forever Map Editor''' is a new map editor developed for FAF by ozonex. It is currently in '''alpha''', which means the editor is in testing phase, and some features are still lacking. However, ozonex expects to release a beta version soon.  
+
'''FA Forever Map Editor''' is a new map editor developed for FAF by ozonex. It is currently in '''alpha''', which means the editor is in its testing phase, and some features are still lacking. However, ozonex expects to release a beta version soon.  
  
Read all about FA Forever Map Editor in this [http://forums.faforever.com/viewtopic.php?f=45&t=10647 forum topic].
+
Read all about the FA Forever Map Editor in this [http://forums.faforever.com/viewtopic.php?f=45&t=10647 forum topic].
  
 
FA Forever Map Editor - [https://docs.google.com/document/d/1EXtj6WiSJHvw2E01DfRpsId6Tpe5epccDW_jBXFcLEM/edit to do and changelog].
 
FA Forever Map Editor - [https://docs.google.com/document/d/1EXtj6WiSJHvw2E01DfRpsId6Tpe5epccDW_jBXFcLEM/edit to do and changelog].
Line 10: Line 10:
 
You can download the current version [https://github.com/ozonexo3/FAForeverMapEditor/releases here].
 
You can download the current version [https://github.com/ozonexo3/FAForeverMapEditor/releases here].
  
== Setting up editor ==
+
== Setting up the editor ==
Before you start using editor you first need to set values in preferences.  
+
Before using the editor you need to set up your preferences.  
  
 
=== Preferences ===
 
=== Preferences ===
 
[[File:faf_mapeditor_preferences.png|300px|thumb|right|Preferences window]]
 
[[File:faf_mapeditor_preferences.png|300px|thumb|right|Preferences window]]
Before you use map editor and load any map you must specify the paths to game and used maps folder.
+
Before loading any map you must specify the paths to your game and maps folder.
  
* '''Sup Com Forged Alliance installation path''' - Path to where game is installed. It will also work with vanilla Supreme Commander, but always use Forged Alliance to get access to all new assets. Use '''"..."''' to open folder browser. When using '''Default''' button editor will try to find path in Windows register.
+
* '''Sup Com Forged Alliance installation path''' - Path to where the game is installed. It will also work with vanilla Supreme Commander, but always use Forged Alliance to get access to all the new assets. Use '''"..."''' to open folder browser. When using '''Default''' button editor will try to find the path by itself.
* '''Maps folder path''' - Path to where all maps are stored. Alpha version can only load maps from that folder, so if you have map in other folder, you need to change this path or move map to used folder.
+
* '''Maps folder path''' - Path to where all maps are stored. The Alpha version can only load maps from that folder, so if you have maps in a different folder, you need to change this path or move the maps to the specified folder.
* '''Backup folder''' - Path where backup of old maps files will be moved. If empty backup will be saved in ''FAForeverMapEditor_Data/MapsBackup/''.
+
* '''Backup folder''' - Path where backups of old maps files will be moved. If empty, backups will be saved in ''FAForeverMapEditor_Data/MapsBackup/''.
* '''Undo steps''' - Maximum steps saved in memory for Undo and Redo.
+
* '''Undo steps''' - Maximum number of steps saved in memory for Undo and Redo.
* '''Play map''' - Settings for using ''File/Play map''. You can select faction and disable '''Fog of war'''.
+
* '''Play map''' - Settings for using ''File/Play map''. You can select a faction and disable '''Fog of war'''.
  
 
=== Editor LOG ===
 
=== Editor LOG ===
When editor crash or behave in strange way it's may be useful to send log to developer. You can find it here:
+
When the editor crashes or behaves in strange way it may be useful to send log to the developer. You can find them here:
 
     C:/Users/[user]/AppData/LocalLow/ozonexo3/FAF Map Editor/
 
     C:/Users/[user]/AppData/LocalLow/ozonexo3/FAF Map Editor/
  
 
=== Custom brushes ===
 
=== Custom brushes ===
You can create or modify existing brushes used by FAF Map Editor.
+
You can create or modify existing brushes used by the FAF Map Editor.
Brushes need to be 512px x 512px grayscale PNG without alpha channel. When we open editor it will load all brushes from that folder. Brushes are sorted by name.
+
Brushes need to be 512px x 512px grayscale PNG without an alpha channel. When opened, the editor will load all brushes from that folder. Brushes are sorted alphabetically.
 
   
 
   
 
You can find them in:
 
You can find them in:
Line 35: Line 35:
  
 
=== Symmetry ===
 
=== Symmetry ===
Editor supports few symmetry options for editing map. You need to select proper one before making changes to the map, because everything you do will be symmetrical based on selected settings.
+
The editor supports several symmetry options for editing maps. You need to select the right one before making changes to the map, because everything you do will be symmetrical based on selected settings.
 
To open symmetry settings go to ''Symmetry/Symmetry settings...''.
 
To open symmetry settings go to ''Symmetry/Symmetry settings...''.
  
Tolerance is how far in game units editor will search for symmetrical objects when selected. Matching objects will be selected as orange. If it can't find matching one it will display gray selection where it should be.
+
Tolerance is how far in game units the editor will search for symmetrical objects when selected. Matching objects will be selected as orange. If it can't find a matching object it will display a gray selection where it should be.
  
  
Line 101: Line 101:
 
* '''Name''' - Map name displayed in game
 
* '''Name''' - Map name displayed in game
 
* '''Description''' - Long description of the map. You can describe the history of the map here. Displayed in game when selecting maps.
 
* '''Description''' - Long description of the map. You can describe the history of the map here. Displayed in game when selecting maps.
* '''Version''' - Version of the map. Increase this value by 1 when you want to upload new version of existing map. If name is the same and version is higher, then map will be replaced with new version.
+
* '''Version''' - Version of the map. Increase this value by 1 when you want to upload a new version of an existing map. If the name is the same and version is higher, then the map will be replaced with the new version.
  
 
=== Edit Armys Spawn IDs ===
 
=== Edit Armys Spawn IDs ===
Line 109: Line 109:
 
=== File version ===
 
=== File version ===
 
Scmap file format exist in 2 versions:
 
Scmap file format exist in 2 versions:
* '''v56''' - Vanilla Supreme Commander map. Most of old maps are in this format, because it is how official map editor saves them.
+
* '''v56''' - Vanilla Supreme Commander map. Most old maps are in this format, because this is how the official map editor saves them.
* '''v60''' - Forged Alliance map. This is new format version containing additional procedural skybox. Can't be open by old tools or by vanilla Supreme Commander game.
+
* '''v60''' - Forged Alliance map. This is a new format version containing additional procedural skybox. Can't be opened by old tools or by the vanilla Supreme Commander game.
  
If you need to open '''v60''' map in vanilla or old tools, you can export skybox data to file and save it as '''v56'''. When done, you can import skybox again and save as '''v60'''.
+
If you need to open '''v60''' map in vanilla or old tools, you can export skybox data to file and save it as '''v56'''. When done, you can import the skybox again and save as '''v60'''.
  
 
== Terrain Heightmap ==
 
== Terrain Heightmap ==
Heightmap is base of whole terrain. It defines height for every place on the map. You can use build-in tools to edit it or export/import to work with other software.
+
The heightmap is the base of whole terrain. It defines height for every place on the map. You can use built-in tools to edit it, or export/import to work with other software.
  
  
 
=== Heightmap brush ===
 
=== Heightmap brush ===
* '''Brush size''' - Size of the brush that we want to paint with. You can change size by holding '''B''' key and dragging over ''gameplay''.
+
* '''Brush size''' - Size of the brush that we want to paint with. You can change it by holding down the '''B''' key and dragging over ''gameplay''.
* '''Brush strenght''' - Strength with witch brush changes are aplayed to terrain. You can change strength by holding '''M''' key and dragging over ''gameplay''.
+
* '''Brush strenght''' - Strength with witch brush changes are aplayed to terrain. You can change it by holding down the '''M''' key and dragging over ''gameplay''.
  
 
There are 4 types of brush
 
There are 4 types of brush
 
* '''Standard''' - Simple brush for increasing or decreasing terrain height
 
* '''Standard''' - Simple brush for increasing or decreasing terrain height
* '''Flatten''' - Finds avarage height under brush and move terrain into that height. Its best as strong blur
+
* '''Flatten''' - Finds the average height under brush and moves terrain to that height. Best uses as a strong blur.
 
* '''Blur''' - Smoothen the terrain. Good for removing sharp edges and softening the terrain.
 
* '''Blur''' - Smoothen the terrain. Good for removing sharp edges and softening the terrain.
 
* '''Sharpen''' - Increase difference in height
 
* '''Sharpen''' - Increase difference in height
Line 130: Line 130:
  
 
Additional values
 
Additional values
* '''Target height''' - Target terrain height for Standard brush. When painting it will change height into target height
+
* '''Target height''' - Target terrain height for Standard brush. When painting it will change height to the target height.
* '''Min height''' - Minimum terrain height allowed by the brush. Terrain will be clipped when its under that value.
+
* '''Min height''' - Minimum terrain height allowed by the brush. Terrain will be clipped when it's under that value.
* '''Max height''' - Maxumin terrain height allowed by the brush. Terrain will be clipped when its under that value.
+
* '''Max height''' - Maximum terrain height allowed by the brush. Terrain will be clipped when it's above that value.
* '''Rotation''' - Rotation of brush texture. Its useful for some custom brushes like mountains.
+
* '''Rotation''' - Rotation of brush texture. Useful for some custom brushes like mountains.
  
 
=== Heightmap tools ===
 
=== Heightmap tools ===

Revision as of 15:07, 4 January 2018

Introduction

FAF Map Editor

FA Forever Map Editor is a new map editor developed for FAF by ozonex. It is currently in alpha, which means the editor is in its testing phase, and some features are still lacking. However, ozonex expects to release a beta version soon.

Read all about the FA Forever Map Editor in this forum topic.

FA Forever Map Editor - to do and changelog.

Download

You can download the current version here.

Setting up the editor

Before using the editor you need to set up your preferences.

Preferences

Preferences window

Before loading any map you must specify the paths to your game and maps folder.

  • Sup Com Forged Alliance installation path - Path to where the game is installed. It will also work with vanilla Supreme Commander, but always use Forged Alliance to get access to all the new assets. Use "..." to open folder browser. When using Default button editor will try to find the path by itself.
  • Maps folder path - Path to where all maps are stored. The Alpha version can only load maps from that folder, so if you have maps in a different folder, you need to change this path or move the maps to the specified folder.
  • Backup folder - Path where backups of old maps files will be moved. If empty, backups will be saved in FAForeverMapEditor_Data/MapsBackup/.
  • Undo steps - Maximum number of steps saved in memory for Undo and Redo.
  • Play map - Settings for using File/Play map. You can select a faction and disable Fog of war.

Editor LOG

When the editor crashes or behaves in strange way it may be useful to send log to the developer. You can find them here:

   C:/Users/[user]/AppData/LocalLow/ozonexo3/FAF Map Editor/

Custom brushes

You can create or modify existing brushes used by the FAF Map Editor. Brushes need to be 512px x 512px grayscale PNG without an alpha channel. When opened, the editor will load all brushes from that folder. Brushes are sorted alphabetically.

You can find them in:

   [FAForeverMapEditor.exe path]/FAForeverMapEditor_Data/Structure/brush/

Symmetry

The editor supports several symmetry options for editing maps. You need to select the right one before making changes to the map, because everything you do will be symmetrical based on selected settings. To open symmetry settings go to Symmetry/Symmetry settings....

Tolerance is how far in game units the editor will search for symmetrical objects when selected. Matching objects will be selected as orange. If it can't find a matching object it will display a gray selection where it should be.


Useful shortuts

Key Function
W FAF mapeditor MoveTool.png Switch to Move tool
E FAF mapeditor RotateTool.png Switch to Rotate tool
R FAF mapeditor ScaleTool.png Switch to Scale tool
T FAF mapeditor SnapToGrid.png Toggle snap to grid
Left Alt Invert brush
B + LMB Dragging over terrain will change brush size
M + LMB Dragging over terrain will change brush strength
Shift + Select Add to selection
Left Alt + Select Remove from selection
Home Restart camera
Delete Remove seleted objects
C Connect selected AI Markers
D Disconnect selected AI Markers
H Hide selected decal types
Shift + H Unhide selected decal types
Left alt + V/H button Toggle visibility of other layer/decal

Create a new map

New map window

To create new map use File/New Map.

  • Name - Name of the map. This will be also used to name folders and files.
  • Description - Long description of the map. You can describe the history of the map here.
  • Texture set - Set of stratum textures loaded to new map. If you know how do you want your map to look like, then select best set.
  • Type - Type of map. Use Skirmish for Multiplayer maps
  • Width / Height - Size of the map. When selected sizes are not square editor will create square map and clip it using Area.
  • Initial height - Initial height of whole heightmap. Try to use the lowest value possible, but remember to leave some space if you want to have water on the map.
  • Water - Toggle it on if you want to have water on your map. This can be changed later if you change your mind.
    • Water Elevation - the height at which the water level is.
    • Depth Elevation - the height at which the water is darker.
    • Abyss Elevation - the height at which the water is very dark.


New map created in FAF Map Editor will be saved as:

[MapsFolder]/[MapName].v0001/[files]

Basic map settings

  • Name - Map name displayed in game
  • Description - Long description of the map. You can describe the history of the map here. Displayed in game when selecting maps.
  • Version - Version of the map. Increase this value by 1 when you want to upload a new version of an existing map. If the name is the same and version is higher, then the map will be replaced with the new version.

Edit Armys Spawn IDs

Tool for changing order of existing armies. Army order is also order of spawn points. Tool also have Auto-Team preview. To switch armies click on box with army number and then select other army from dropdown list.

File version

Scmap file format exist in 2 versions:

  • v56 - Vanilla Supreme Commander map. Most old maps are in this format, because this is how the official map editor saves them.
  • v60 - Forged Alliance map. This is a new format version containing additional procedural skybox. Can't be opened by old tools or by the vanilla Supreme Commander game.

If you need to open v60 map in vanilla or old tools, you can export skybox data to file and save it as v56. When done, you can import the skybox again and save as v60.

Terrain Heightmap

The heightmap is the base of whole terrain. It defines height for every place on the map. You can use built-in tools to edit it, or export/import to work with other software.


Heightmap brush

  • Brush size - Size of the brush that we want to paint with. You can change it by holding down the B key and dragging over gameplay.
  • Brush strenght - Strength with witch brush changes are aplayed to terrain. You can change it by holding down the M key and dragging over gameplay.

There are 4 types of brush

  • Standard - Simple brush for increasing or decreasing terrain height
  • Flatten - Finds the average height under brush and moves terrain to that height. Best uses as a strong blur.
  • Blur - Smoothen the terrain. Good for removing sharp edges and softening the terrain.
  • Sharpen - Increase difference in height


Additional values

  • Target height - Target terrain height for Standard brush. When painting it will change height to the target height.
  • Min height - Minimum terrain height allowed by the brush. Terrain will be clipped when it's under that value.
  • Max height - Maximum terrain height allowed by the brush. Terrain will be clipped when it's above that value.
  • Rotation - Rotation of brush texture. Useful for some custom brushes like mountains.

Heightmap tools

Water

[TODO]

Terrain Textures

[TODO]

Texture layers

[TODO]

Painting

[TODO]

Layers tools

[TODO]

Lighting

[TODO]

Sun, shadow and ambient

[TODO]

Procedural skybox

[TODO]


Armies

[TODO]


Areas

[TODO]


Markers

[TODO]

Spawn points

[TODO]

Resources

[TODO]

AI

[TODO]

Chains

[TODO]

Adaptive map

[TODO]

Layers

[TODO]


Props

[TODO]


Decals

[TODO]


Units

Units are not yet implemented in FAF Map Editor. Use official Map Editor to add or edit units on map.