Thorough documentation is still missing. Here's an example configuration file which shows the available layer types, options and some default values.

Configuring Data Sources

Think of it as defining two sets of layers. Each layer is in a named section, whose name will be displayed as such the freimap GUI.

• backgrounds is a list of static background layers. Usually you will want to have openstreetmap, with optionally a number of image files overlayed. The blank layer is legacy, you might just as well not specify any backgrounds.
• datasources is a list of your data sources. That's more interesting. Available sources are:
  • net.relet.freimap.OlsrdDataSource? - for live olsrd data from the dot_draw plugin.
  • net.relet.freimap.LatLonJsDataSource? - to specify a .js file (local or remote URL) generated by the nameservice plugin of the olsr daemon. It should be called latlon.js and contain data in the form of JavaScript? method calls. Whatever.
  • net.relet.freimap.FreifunkMapDataSource? - to specify a xml file (local or remote URL) which contains node coordinates in the freifunkmap(sic!) xml format at layereight.de
  • net.relet.freimap.MysqlDataSource - reads node and link information from a database
• even more experimental data sources:
  • net.relet.freimap.FlowDataSource? - reads flow information from a database
• incomplete / broken data sources:
  • net.relet.freimap.YamlDataSource? - reads lots of information from the ffsomething YAML interface.
• Note: you may combine some layers providing link data with others providing node coordinates using the parameter nodesource.

---

# freimap configuration file. Please refer to http://www.yaml.org/start.html or http://www.yaml.org/refcard.html for syntax info.
# this is a working configuration for olsrd on localhost 
# node positions are available for freifunk nodes in berlin.
--- 
version: svn
subversion: 60

backgrounds:
  openstreetmap: 
    type: openstreetmap
    # use blank, images or openstreetmap
    delay: 0
    filter: dark
    cachedir: ./gfx/cache

  bcc-a:
    type: images
    images:
     - gfx:   gfx/bcc-a-uni.png  
       lat:   52.52089531804967
       lon:   13.416420177909853
       scale: 1500000  

datasources:
  nodes-in-berlin:
    class: net.relet.freimap.FreifunkMapDataSource
    url: "file:data/ffmap.xml"

  olsrd-localhost:
    class: net.relet.freimap.OlsrdDataSource
    host: localhost
    port: 2004
    nodesource: nodes-in-berlin 

---

Another useful data source for node coordinates would be:

  nameserver-plugin:
    class: net.relet.freimap.LatLonJsDataSource
    url: "file:data/latlon.js"
    fetchlinks: true

Configuring Color Schemes

Customizing the application colors is supported, but not available for all elements yet. Expect the following list of settings to grow or be renamed with more sensible choices. All settings are currently expected to be contained in the main section colorscheme. The values are an integer, preferably in hexadecimal ARGB syntax for improved readability. For example:

colorscheme:
  menu: 0xFF000000

defines an opaque black for the main menu background. The highest byte is alpha (opacity). The other three are red, green and blue in that order.

The following settings are available for now:

background	main window background (will often be drawn over by individual layers)
menu	main menu background
foreground	most elements, such as structuring and connecting lines, box borders (usually greenish)
foreground2	the same for link (secondary) information elements (usually blueish)
boxes	transparent backgrounds for status bars and boxes (dark greenish transparent)
boxes2	the same for secondary information elements (dark blueish transparent)

Other options

Display filters will be configured in the section "display". Currently, a single filter is settable from config file:

display:
  hideUnlocated: true

which will disable the interpolation and display of unlocated nodes.