World map in mods

pre-OSE

Official versions do not support world maps in mods. There used to be a script hack to implement world maps in mods but those links have gone defunct long ago. If there is anyone out there who still has those files please speak up!

OSE

The open source version supports world maps natively. Place a worldmap.txt file in the root directory of your mod. Each line is one map tile; the fields are separated by spaces:

Index StringbankIndex FileName Layer Scale X Y Prerevealed Scale2

Index is just a running number

StringbankIndex is an index of a string in stringbank.txt. The map name is shown on the map screen.

FileName is the name of the XML file without extension (always in uppercase for some reason)

Layer: 0 if the map is considered an "overworld" map, 1 if it's an "inside" map (small caves, etc)

Scale: Scale factor by which to scale each map tile's width/height in relation to the size of the source image file. Influences the resulting width/height.

X and Y is where to place the tile on the map

Prerevealed: Usually 0; set this to 1 to show the tile on the map even when the player has not visited that map yet.

Scale2: This scale factor is applied when rendering and can be used to fine-tune the draw size of the tile.

For an example, see Labyrinth/worldmap.txt

If you want to create map tile graphics from map templates easily and automatically, try aqmapgen

Map editor controls

Open the world map, then press Tab. It should display Editing... followed by some coordinates in the top left.

The keys available in editor mode are as follows:

Click a tile to mark it
F2: Save worldmap.txt
Arrow keys: Move the marked tile around. Hold Ctrl to move faster.
Hold Shift + Up/Down arrow keys: Change Scale2. Also hold Ctrl to speed up.
Hold Alt + Up/Down arrow keys: Change Scale. Also hold Ctrl to speed up.