Skip to content

How to add new locations?

Jonas Friedmann edited this page Aug 8, 2014 · 3 revisions

If you want to add locations to the official map, make sure to read the article below. There are several steps, which are required for that:

1. Find the coordinations

To find out about the actual coordinates for your new location, you can use the coordinate/debug mode on the productional map:

  1. Go to the official map or clone the repository and run it locally.
  2. Find the location where you want to add content to.
  3. Right click on that location, to create a debug marker that shows you the actual coordinates (latitude and longitude)
  4. You can also move the marker to update your position. The coordinates will update while you drag.
2. Create the markup for the "database"

The "database" is actually just a flat file in a JSON format that stores all the breach locations. So, once you have the coordinations, you can prepare that markup:

  1. Read this article, to understand the syntax of the locations.json
  2. Open a plain text editor and paste in one of the template out of the wiki article
  3. Adjust the template as you wish, add the actual descriptions, images, videos and credits and of course the coordinations that you looked up in the first step
  4. Once you finished "designing" the element, you can proceed with the step
3. Send me adjusted locations.json element

Now you have your location in a correct and valid format, but you still have to send it over to me, so i can review and eventually add it in the productional map if everything looks good. To do this you have two options. You can either:

  • fork this repository, add and commit your changes and then create a pull request. This method is the most comfortable one for me because, i don't have to do anything except clicking one button to review and add your content. Downside: you have to mess with git and GitHub.
  • just send me the locations.json element, via:
4. Wait till i reviewed, merged / added your content

Once you sent me over the new location configuration, you'll need to be patient until i reviewed it and either merged your pull request, or implemented your part of the locations.json into the official one.

I'll let you know as soon as I approved your addition :)