diff --git a/README.md b/README.md new file mode 100644 index 0000000..6327e9b --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# geogame +[Play it here!](https://geogame.peakdistrictwalks.org.uk) + +**What is this?** + +This is a game that uses Geoguessr as inspiration. + +**Why does this exist?** + +Sadly, because of Google's predatory pricing strategy for their Maps api, geoguessr have had to modify their game in a detrimental way to cut costs. + +I created this project to allow people to play the game how it used to be (or as close to it). + +**What does the "Broken Streetview" button do?** + +Sometimes a coordinate with no valid streetview is selected for you, you will just get a black screen. + +If this occurs please click the "Broken Streetview" button and you will be provided with a new scene and the faulty coordinate will be removed from the database. + + + + +Todo: + +validate user api key on input + +validate coordinates on input + +change contribution page so you contribute a whole game + +implement list of previous games on your profile + +implement list of contributed games on your profile + +ingest more coordinates for more countries + +country based games (e.g UK only (I have made a start by linking each coordinate to a country))