Crossfire Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Crossfire-Mapper ======

**Crossfire mapper** is a tool, formerly only available in the ''trunk'' Git (server/utils), that generates a catalog of maps. \\
Until tag version 1.60.0 it had not been included in official source code releases of the [[:server]] . \\
Since official release version 1.71.0 the required //templates// directory and it's around 30 to 40 HTML files is also included in the release.

The crossfire-mapper is mostly intended for map makers so they know the relationship between maps, and people wishing to figure out where is a specific map/quest.

The following information is generated:
  * a page per map
  * a page per region
  * a global map index
  * the world map, including regions information
  * the world map, with exits and blocking zones
  * the world map, with elevation information.
  * an index of maps by level
  * the list of all //slaying// fields for keys/doors/detectors
  * the list of all monsters found on maps
  * the list of quests
(note that some lists are not using the template system yet)

This program browses maps from the first map (HallOfSelection) in {prefix}/var/crossfire/maps ( not in share/crossfire/maps ); only maps linked from there will be processed.

Maps are generated as the server sees them, that is with weather effects, treasures instead of markers, and things like that, unless the ''-rawmaps'' parameter is used.

For maps, two pictures are generated, one real size and one small-size and that used on the map detailed view pages. Also generated are five different sized maps used by an optional, and not included, Zoomable world map using [[https://openseadragon.github.io/|OpenSeadragon]].

Three maps are generated for the world: raw world map, world map with region information, region information only.

Maps are always sorted, by the map name (part after the last /).

Files are generated based on templates, where tags are replaced by their runtime value.

Launching the program without any argument will make it generate the files in ''working-directory/html''.

This program is not part of the normal build process. The command to compile mapper is invoked during "./configure" command.

<code>./configure --enable-mapper && make && sudo make install</code>

To build it, you need the //GD// library (ie. install a libgd-devel package).

Since version 1.60.0 the mapper utility is optional part of the build process, available by the ''--enable-mapper'' configure option. But ''make install'' does not install the crossfire-mapper executable, the user has to manually transfer it ( probably to be found inside the hidden .lib directory of the utils folder) to the intended location; preferably where the //templates// directory with the many HTML .template files is located.

The following command line parameters are available:

| -nopics | don't generate pictures. |
| -noindex | don't generate global map index. |
| -root=<path> | destination path. Default 'html'. |
| -limit=<number> | stop processing after this number of maps, -1 to do all maps (default). |
| -showmaps | outputs the name of maps as they are processed. |
| -jpg[=quality] | generate jpg pictures, instead of default png. Quality should be 0-95, -1 for automatic. |
| -forcepics | force to regenerate pics, even if pics's date is after map's. |
| -addmap=<map> | adds a map to process. Path is relative to map's directory root. |
| -rawmaps | generates maps pics without items on random (shop, treasure) tiles. |
| -warnnopath | inform when an exit has no path set. |
| -listunusedmaps | finds all unused maps in the maps directory. |
| -noworldmap | don't write the world map in world.png. |
| -noregionslink | don't generate regions relation file. |
| -regionslink | generate regions relation file. |
| -noexitmap | don't generate map of exits. |
| -exitmap | generate map of exits. |
| -tileset=<number> | use specified tileset to generate the pictures. Default 0 (standard). |

===== Linux Distribution Specifics =====

==== Debian ====

==== Debian 10 (Buster) ====

A quick reference for Debian 10 (Buster):

  sudo apt install gcc libgd-dev
  
Instructions creation date: 2025-August-29

Last tested date: 2025-August-29
==== Debian 11 (Bullseye) ====

A quick reference for Debian 11 (Bullseye):

  sudo apt install gcc libgd-dev
  
Instructions creation date: 2025-August-29

Last tested date: 2025-August-29: 


==== Debian 12 (Bookworm) ====

A quick reference for Debian 12 (Bookworm):

  sudo apt install gcc libgd-dev
  
Instructions creation date: 2025-August-29

Last tested date: 2025-August-29

==== Debian 13 (Trixie) ====

A quick reference for Debian 13 (Trixie):

  sudo apt install gcc libgd-dev
  
Instructions creation date: 2025-August-29

Last tested date: 2025-August-29

==== Devuan ====

==== Devuan Beowulf 3.1 ====

A quick reference for Devuan Beowulf 3.1:

  sudo apt install 
  
Instructions creation date: 

Last tested date: 


==== Devuan Chimaera 4.0 ====

A quick reference for Devuan Chimaera 4.0:

  sudo apt install 
  
Instructions creation date: 

Last tested date: 

==== Devuan Daedalus 5.0 ====

A quick reference for Devuan Daedalus 5.0:

  sudo apt install 
  
Instructions creation date: 

Last tested date:

==== Fedora ====

==== Fedora 40 ====

A quick reference for Fedora 40 using the command line interface:

  sudo dnf install gd-devel

Instructions creation date: 2025-August-3

Last tested date: 2025-August-3

==== Fedora 41 ====

A quick reference for Fedora 41 using the command line interface:

  sudo dnf install gd-devel

Instructions creation date: 2025-August-3

Last tested date: 2025-August-3

==== Fedora 42 ====

A quick reference for Fedora 42 using the command line interface:

  sudo dnf install gd-devel

Instructions creation date: 2025-July-29

Last tested date: 2025-July-29

==== Linux Mint ====

==== Linux Mint 20 (Ulyana) ====

A quick reference for Linux Mint 20 (Ulyana) using command line interface:
  sudo apt install

Instructions creation date: 

Last tested date: 

==== Linux Mint 20.1 (Ulyssa) ====

A quick reference for Linux Mint 20.1 (Ulyssa) using command line interface:

  sudo apt install 

Instructions creation date: 

Last tested date: 


==== Linux Mint 20.2 (Uma) ====

A quick reference for Linux Mint 20.2 (Uma) using command line interface:

  sudo apt install 

Instructions creation date: 

Last tested date: 

==== Linux Mint 20.3 (Una) ====

A quick reference for Linux Mint 20.3 (Una) using command line interface:

  sudo apt install 

Instructions creation date: 

Last tested date: 

==== Linux Mint 21 (Vanessa) ====

A quick reference for Linux Mint 21 (Vanessa) using command line interface:

  sudo apt install 

Instructions creation date: 

Last tested date: 

==== Linux Mint 21.1 (Vera) ====

A quick reference for Linux Mint 21.1 (Vera) using command line interface:

  sudo apt install 

Instructions creation date: 

Last tested date: 


==== Linux Mint 21.2 (Victoria) ====

A quick reference for Linux Mint 21.2 (Victoria) using command line interface:

  sudo apt install 

Instructions creation date: 

Last tested date: 

==== Linux Mint 21.3 (Virginia) ====

A quick reference for Linux Mint 21.3 (Virginia) using command line interface:

  sudo apt install 

Instructions creation date: 

Last tested date: 

==== Linux Mint 22 (Wilma) ====

A quick reference for Linux Mint 22 (Wilma) using command line interface:

  sudo apt install 

Instructions creation date: 

Last tested date: 

==== Linux Mint 22.1 (Xia) ====

A quick reference for Linux Mint 22.1 (Xia) using command line interface:

  sudo apt install libgd-dev

Instructions creation date: 2025-July-31

Last tested date: 2025-July-31
==== Linux Mint Debian Debian Edition 6 ====

A quick reference for Linux Mint Debian Debian Edition 6:

  sudo apt install 
  
Instructions creation date: 

Last tested date: 

==== Manjaro ====

==== Manjaro 23.1.3 (Vulcan) ====

A quick reference for Manjaro using command line interface:

  sudo pacman -S 

Instructions creation date: 

Last tested date: 8

==== Manjaro 24 (Wynsdey) ====

A quick reference for Manjaro 24 (Wynsdey) using command line interface:

  sudo pacman -S 

Instructions creation date: 

Last tested date: 

==== OpenSUSE ====

==== OpenSUSE Leap 15.5 ====

A quick reference for OpenSUSE Leap 15.5
  sudo zypper install 

Instructions creation date: 

Last tested date: 
  
==== OpenSUSE Tumbleweed ====

A quick reference for OpenSUSE Tumbleweed
  sudo zypper install gd-devel

Instructions creation date: 2025-July-28

Last tested date: 2025-July-28

==== Pop!_OS ====

==== Pop!_OS 22.04 LTS ====

A quick reference for Pop!_OS 22.04 LTS:

  sudo apt install 

Instructions creation date: 

Last tested date: 

==== Pop!_OS 22.04 LTS (NVIDIA) ====

A quick reference for Pop!_OS 22.04 LTS (NVIDIA) 

  sudo apt install 

Instructions creation date: 

Last tested date: 

==== Ubuntu ====

The dependency and instructions for the listed versions of Ubuntu includes or applies to all eight of the different flavours including:
  * Kubuntu
  * Lubuntu
  * Ubuntu Budgie
  * Ubuntu Kylin
  * Ubuntu Mate
  * Ubuntu Studio
  * Ubuntu Unity
  * Xubuntu

==== Ubuntu 20.04 (Focal Fossa) ====

A quick reference for Ubuntu 20.04 (Focal Fossa):
  sudo apt install 
  
Instructions creation date: 

Last tested date: 
  
==== Ubuntu 22.04 (Jammy Jellyfish) ====

A quick reference for Ubuntu 22.04 (Jammy Jellyfish):
  sudo apt install 

Instructions creation date: 

Last tested date:  

==== Ubuntu 24.04 (Noble Numbat) ====

A quick reference for Ubuntu 24.04 (Noble Numbat) using the command line interface:

  sudo apt install 

Instructions creation date: 

Last tested date:

==== Ubuntu 24.10 (Oracular Oriole) ====

A quick reference for Ubuntu 24.10 (Oracular Oriole) using the command line interface:

  sudo apt install 

Instructions creation date: 

Last tested date: