See the structure of the guifi.net network in Google Earth.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
model
.gitignore
LICENSE
README.md
TODO.md
compile.coffee
package.json

README.md

guifi-earth

guifi-earth is a simple tool which is able to represent the nodes, links and zone structure of the guifi.net network in the Keyhole Markup Language, for viewing in Google Earth, Google Maps or any other KML-capable program. You can customize it easily, see the Tweaking section.

To try it, you can download a standard, pre-built KML file from here and open it in Google Earth. Make sure to read some [use recommendations] use-googleearth! You can also use it offline (but the links to the official site won't work, of course).

Google Earth screenshots

With VILCastellRistol and its coverage: Perspective view  •  Normal view
With western Terrassa and TRSATorrePalau description: Side view
With TRSAJll330 and its links: Street view
With TRSAnordBonAire: Street view  •  Surface view

Setting up

You need to have Node.JS installed. Then, clone the repo and do:

$ npm install

This will install any dependencies for you.

Usage

Parsing

You can download data.pak from here and skip to the next section. (there's no guarantee that the data will be up-to-date, however)

First, you need to download the following input data:

As of v0.2.0, you can dump individual zones other than World, allowing you to quickly see your zone's changes with a partial KML. Just make sure the CNML and the GML are of the same zone!

Now you can parse those two files into an efficient MSGPack archive:

# Replace `nodes.cnml` and `links.gml` with the files you downloaded
$ ./compile.coffee nodes.cnml links.gml > data.pak

Now you can remove the original XML files, they are no longer needed.

Converting

To produce the final KML, just do:

# Adjust `data.pak` if you have downloaded it somewhere else.
$ ./compile.coffee data.pak > guifi.kml

The output will be stored in guifi.kml. Just open it in Google Earth.

Tip: you may want to keep or distribute data.pak to experiment with your own KMLs. Keep reading.

Tweaking

Want to customize your KML a bit? No worries, it's simple and straightforward.

The model folder contains the files which are used to produce the KML. It can be intimidating at first, and you should learn the basics of KML and Jade to do more things. There are four templates:

  • root.jade: It produces the "root" folder, the one which gets added when you open the KML. You normally don't want to modify this.
  • zone.jade: It produces every zone folder and sorts his contents (to put supernodes first, and other nodes later). You normally don't want to modify this.
  • node.jade: It produces every node placemark. It styles that placemark (icon, color, description) according to the node's properties.
  • links.jade: It produces a folder, and puts lines representing links inside of that folder.

Take the appropiate one depending on what you want to customize, open it in the editor and play with it. There are some annotations to guide you (lines that start with // or //-).

Once you have made some modifications, just call compile.coffee again. And if you made a nice change, I encourage you to contribute it so everyone can have it too. :)

Implementation

The two-step process is done to keep the processing operation fast, so you can hack on the template and see your changes quickly. It also makes it easier for others to build their own KML; just give them the data.pak which is a lot smaller than its respective XML files.