update new_city docs, describe how to get .osm files, and explain how to upstream fixes in osm. fixes and
@@ -6,22 +6,33 @@ hit problems. I'd really appreciate help and PRs to improve this.
## Quick start
-If you have a `.osm` file, you can just run `./import.sh --oneshot=map.osm`.
-This tool will generate a new file in `data/system/maps` that you can then load
-in the game. (If you can't run `import.sh`, make sure you have all
-[dependencies](dev.md#building-map-data).
+If you're using the binary release and have a `.osm` file, just do:
+`./importer/importer --oneshot=map.osm`.
-If you're using a binary release, run `./importer/importer --oneshot=map.osm`
-instead of `import.sh`.
+If you're building from source, do: `./import.sh --oneshot=map.osm`. If you
+can't run `import.sh`, make sure you have all
+[dependencies](dev.md#building-map-data).
-If you have an Osmosis polygon filter (see below), you can also pass
-`--oneshot_clip=clip.poly` to improve the result. You should first make sure
-your .osm has been clipped:
+The oneshot importer will will generate a new file in `data/system/maps` that
+you can then load in the game. If you have an Osmosis polygon filter (see
+below), you can also pass `--oneshot_clip=clip.poly` to improve the result. You
+should first make sure your .osm has been clipped:
`osmconvert large_map.osm -B=clipping.poly --complete-ways -o=smaller_map.osm`.
You can also try `--oneshot_drive_on_left`, but you'll spot some bugs. Get in
touch if you need these fixed soon or want to help.
+## How to get .osm files
+
+If the area is small enough, try the "export" tool on
+https://www.openstreetmap.org. You can download larger areas from
+https://download.bbbike.org/ or http://download.geofabrik.de/index.html, then
+clip them to a smaller area. You can draw a clipping polygon using
+http://geojson.io or https://geoman.io/geojson-editor. You have to turn the
+coordinates from that polygon into the
+[Osmosis format](https://wiki.openstreetmap.org/wiki/Osmosis/Polygon_Filter_File_Format).
+The `data/geojson_to_osmosis.py` script can help with the formatting.
+
## Including the city by default
1. Make sure you can run `import.sh` -- see
@@ -65,3 +76,11 @@ pipeline for Seattle, you'll see many more sources for parking, GTFS bus
schedules, person/trip demand data for scenarios, etc. Most of these aren't
standard between cities. If you want to make your city more realistic, we'll
have to import more data. Get in touch.
+
+You may notice issues with OSM data while using A/B Street. Some of these are
+bugs in A/B Street itself, but others are incorrectly tagged lanes. Some
+resources for fixing OSM:
+
+- https://learnosm.org
+- https://wiki.openstreetmap.org/wiki/StreetComplete
+- https://dabreegster.github.io/abstreet/map_parking.html
