Jump to content

Kilgore's Mapper Guide: FOMAP File Structure: Difference between revisions

From FOnline: Reloaded Wiki
Henry (talk | contribs)
Created page with "{{Guide | name = Kilgore's Mapper Guide | image = AWikiEditor.gif | description = A guide to using the mapper, a developer tool used to make encounter maps that can be added t..."
 
Henry (talk | contribs)
No edit summary
Line 14: Line 14:
Each '''fomap''' file consists of three sections: Headers, Tiles, and Objects.
Each '''fomap''' file consists of three sections: Headers, Tiles, and Objects.


=Headers=
[Header] - map header:<br>
[Header] - map header:<br>
Version,<br>
Version<br>
MaxHexX - map width (hexes),<br>
MaxHexX - map width (hexes)<br>
MaxHexY - map length (hexes),<br>
MaxHexY - map length (hexes)<br>
WorkHexX - map width (actually used part),<br>
WorkHexX - map width (actually used part)<br>
WorkHexY - map length (actually used part),<br>
WorkHexY - map length (actually used part)<br>
ScriptModule - specifies the name of the script in which contains map initialization function,<br>
ScriptModule - specifies the name of the script in which contains map initialization function<br>
ScriptFunc - the name of the function executed when initializing the map,<br>
ScriptFunc - the name of the function executed when initializing the map<br>
NoLogOut - if it equals 1, characters do not disappear after logging off (they are in (off) mode), and if it equals 0, characters disappear normally after the time defined in scripts / config.fos.<br>
NoLogOut - if it equals 1, characters do not disappear after logging off (they are in (off) mode), and if it equals 0, characters disappear normally after the time defined in scripts / config.fos.<br>
Time - time of day for the map. If equal to -1, map lighting will change over game time. If not, then the lighting will be permanent (useful for underground maps)<br>
Time - time of day for the map. If equal to -1, map lighting will change over game time. If not, then the lighting will be permanent (useful for underground maps)<br>
DayTime -  specifies times for which map lighting are defined below (separated by a space),<br>
DayTime -  specifies times for which map lighting are defined below (separated by a space)<br>
DayColor0 - lighting color for the first time specified in "DayTime",<br>
DayColor0 - lighting color for the first time specified in "DayTime"<br>
DayColor1 - lighting color for the second time specified in "DayTime",<br>
DayColor1 - lighting color for the second time specified in "DayTime"<br>
DayColor2 - lighting color for the third time specified in "DayTime",<br>
DayColor2 - lighting color for the third time specified in "DayTime"<br>
DayColor3 - lighting color for the fourth time specified in "DayTime",<br>
DayColor3 - lighting color for the fourth time specified in "DayTime"<br>
 
''Header Example'':<br>
<code class="bbc_code">[Header] <br>Version 4 <br>MaxHexX 400 <br>MaxHexY 400 <br>WorkHexX 126 <br>WorkHexY 127 <br>ScriptModule fo2077_map_losthills <br>ScriptFunc _MapInit <br>NoLogOut 0 <br>Time -1 <br>DayTime 300 600 1140 1380 <br>DayColor0 18 18 53 <br>DayColor1 128 128 128 <br>DayColor2 103 95 86 <br>DayColor3 51 40 29 </code>


==Other Chapters==
==Other Chapters==

Revision as of 02:40, 7 August 2017

Kilgore's Mapper Guide
A guide to using the mapper, a developer tool used to make encounter maps that can be added to the game, if they are good enough. Assembled by Reloaded's lead developer himself on the game's main forum, and copied here with minor edits.
Season {{{season}}}
Status Being translated...
Completion 60%
Authors Kilgore
This Chapter FOMAP File Structure
More Chapters README
Basic Commands
Interface
FOMAP File Structure
Notes {{{notes}}}


FOnline maps are saved in .FOMAP format. This is a text format, so you can open and edit them with Notepad. In theory, you could create whole maps from scratch using a regular notepad, without running a mapper, but in practice only a real madman would do that. Nevertheless, making some edits in Notepad might be necessary.

Each fomap file consists of three sections: Headers, Tiles, and Objects.

Headers

[Header] - map header:
Version
MaxHexX - map width (hexes)
MaxHexY - map length (hexes)
WorkHexX - map width (actually used part)
WorkHexY - map length (actually used part)
ScriptModule - specifies the name of the script in which contains map initialization function
ScriptFunc - the name of the function executed when initializing the map
NoLogOut - if it equals 1, characters do not disappear after logging off (they are in (off) mode), and if it equals 0, characters disappear normally after the time defined in scripts / config.fos.
Time - time of day for the map. If equal to -1, map lighting will change over game time. If not, then the lighting will be permanent (useful for underground maps)
DayTime - specifies times for which map lighting are defined below (separated by a space)
DayColor0 - lighting color for the first time specified in "DayTime"
DayColor1 - lighting color for the second time specified in "DayTime"
DayColor2 - lighting color for the third time specified in "DayTime"
DayColor3 - lighting color for the fourth time specified in "DayTime"

Header Example:
[Header]
Version 4
MaxHexX 400
MaxHexY 400
WorkHexX 126
WorkHexY 127
ScriptModule fo2077_map_losthills
ScriptFunc _MapInit
NoLogOut 0
Time -1
DayTime 300 600 1140 1380
DayColor0 18 18 53
DayColor1 128 128 128
DayColor2 103 95 86
DayColor3 51 40 29

Other Chapters