Discovery-Zones.md

@@ -0,0 +1,81 @@
+# Discovery Zones
+
+All About Discovery Zone Configuration! Theres a few interesting parts to them. First things first, here is a general config with all the bits from the Official server:
+
+```json
+{
+  "name": "The Hopeless Reef",
+  "sizeX": 110222.2,
+  "sizeY": 110222.2,
+  "sizeZ": 40000.0,
+  "id": 1140,
+  "xp": 0.0,
+  "bIsManuallyPlaced": false,
+  "explorerNoteIndex": 0,
+  "allowSea": false,
+  "worldX": 389333.3,
+  "worldY": 375111.1,
+  "rotation": 0.0
+}
+```
+
+This is actually the discovery zone for A1 `The Hopeless Reef`.
+
+## Options
+
+A lot of this is quite self explanatory, but lets go through them:
+
+### id
+
+This is a unique ID for each discovery zone or island.
+
+### name
+
+Obvious one, the name to be shown in game of the discovery zone.
+
+### sizeX, sizeY, sizeZ
+
+These are the specific size of the discovery zone in game. Note that sizeZ, if any of the others are set, seems to be set at 40,000 for some reason.
+
+### rotation
+
+Fairly obvious one, is the rotation of the discovery point.
+
+### worldX, worldY
+
+This is the centre position of the discovery zone in the main world.
+
+### allowSea
+
+Assumed to allow activating the discovery zone while on a ship. Unconfirmed, needs testing on non-production server.
+
+### xp
+
+Amount of max XP bonus you receive for finding the discovery point
+
+### explorerNoteIndex
+
+Used for pointing to the in game notebook. There are a number of specific ones, see Note Index later on.
+
+### bIsManuallyPlaced
+
+true/false value. If false, will be included on the map on official server editor. If true, will need ManualVolumeName set.
+
+### ManualVolumeName
+
+Required if `bIsManuallyPlaced` is true. This points to a specific mesh in the map, which is part of one of the Island models. For example:
+
+```json
+{
+  ...
+  "bIsManuallyPlaced": true,
+  "ManualVolumeName": "Mnt_A_Near_06B-MaraudersBeach",
+  ...
+}
+```
+
+Defines a discovery zone attached to `Mnt_A_Near_06B-MaraudersBeach`. Note that the worldX and worldY for these is set to the centre of the grid. The physical size seems to be irellevant.
+
+## Note Index
+
+TODO