Merge pull request #8 from CrimsonNynja/data-restructure

Data restructure

README.md

@@ -1,17 +1,40 @@
 ## Monster Hunter DB
 
-This repo contains a database of monsters from MH3U, MH4U, MHGU, MHST and MHW (plus Iceborne), and MH Rise given in a json and ndjson file. In its current state, it contains info on each monster from the games, with the following information (if it exists for the given monster)
+This repo contains a database of monsters from MH3U, MH4U, MHGU, MHST and MHW (plus Iceborne), and MH Rise.
 
-* name (string) - the name of the monster
-* type (string) - the monsters class
-* games (array\<string\>) - an array of games the monster appeared in
-* images (array\<string\>) - the icons for the monster (matches the games list and order)
-* info (array\<string\>) - the in game info for the monster (matches the games list and order)
-* subSpecies (array\<string\>) - a list of sub-species the monster has
-* isLarge (bool) - if the monster if a major monster
-* elements (array\<string\>) - any element the monster can use
-* danger (int) - the danger rating of the monster
-* ailments (array\<string\>) - a list of ailments the monster can cause
-* weakness (array\<string\>) - a list of weaknesses the monster has
+The data is provided in both a `.json` and `.ndjson` file, with the data sorted alphabetically on the monsters name.
+
+In its current state, it contains info on each monster from the games, with the following information (if it exists for the given monster)
 
 All icons are provided in the 'icons' folder that the DB references.
+
+```json
+{
+    "_id": {
+        "$oid": "" // the id of the monster
+    },
+    "name": "", // the name of the monster
+    "type": "", // the type of the monster i.e. Brute Wyvern
+    "isLarge": true, // if the monster is classed as Large
+    "subSpecies": [
+        "", //a list of all the sub-species this monster has
+    ],
+    "elements": [
+        "" // any element the monster can have
+    ],
+    "ailments": [
+        "", // any ailment the monster can inflict
+    ],
+    "weakness": [
+        "" // any weakness the monster has
+    ],
+    "games": [
+        {
+            "game": "", // the game the monster appears in
+            "image": "", // the icon for the monster in the game, see the files in the icon folder
+            "info": "", // the info in the hunters notes for the game
+            "danger": "" // the danger rating for the monster in the hunters notes
+        },
+    ]
+},
+```