City Knowledge Contest

Who knows finds the streets first? A PvP online game to get to know your city better.

The Game

Set up a room with your friends and find the required street first in the map of your city! Answer fast – get more points!

The game is currently in beta version.

Requirements

In order to play, you need meet three non-technical requirements:

One or more list of streets. They must be provided in the following JSON format:
```
{
    "country": "Germany",
    "city": "Würzburg",
    "name": "Würzburg",
    "map": {
        "center": {
          "lng": 9.931641,
          "lat": 49.793621
        },
        "boundingBox": {
          "minLat": 49.752880,
          "maxLat": 49.839865,
          "minLng": 9.837742,
          "maxLng": 10.051975
        },
        "minZoom": 14,
        "maxZoom": 18
    },
    "streets":["Ingolstadter Hof","Bahnhofstraße",…]
}
```
The name property donates the name of the list as shown in the game setup.

The streets array contains the list of streets that might be asked in game: Upon every round, the app will randomly choose a street and and query Nominatim for the solution. It will use country and city to refine the query.

The map object contains:
- the center of the map: all players start playing there
- an optional boundingBox: players may only move within the bounding box. It prevents others from using the game's backend as tile server.
- minZoom and maxZoom: self-explanatory. The initial zoom is the average from both values.
Access to a Nominatim server. We recommend hosting your own Nominatim server. The Nominatim server is used to get the solution for the randomly chosen street, as well as for checking the players' answers.
Access to an Openstreet Map Tile server. Per default, the app uses the publicly available OSM tile servers, but you might run into quota limits here. We strongly recommend using your own OSM tile server or buy an API quota on one of the available public servers.

Starting the server

The easiest way to start the server quickly is to use the Dockerfile to build an image:

build.sh and then start the server:

docker run -p 8081:23123 -it -v /path/to/streetlists:/streetlists city-contest

As shown above, you have to specify the streetlists directory. You can pass the flag --help to the docker container, which will print the list of available options (e.g. how to set your own Nominatim and OSM tile servers).

The server is then available in the browser at http://localhost:8081

Contributing

We are happy for contributions. You can either send a pull request for an idea of yours, or you can browse the open issues for a suitable task.

License

MIT License

sonjafeitsch / city-knowledge-contest Goto Github PK