From f97fa7a1e3d2189b44ed1c115a30fbf3b58db5ee Mon Sep 17 00:00:00 2001 From: Mister_Nebula <41904486+misternebula@users.noreply.github.com> Date: Sun, 12 Apr 2020 16:05:40 +0100 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b6b2d638..489cb3dd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,19 @@ A planet creator for Outer Wilds. ## List of available options : +This list will update as more options are added. Structure JSON file like so : +``` +{ + "settings": { + "name" : "Test Planet", + "position" : [0, 0, 20000], + "orbitAngle" : 0, + "hasFog" : true, + "fogTint" : [0, 75, 15, 128], + "fogDensity" : 0.5 + } +} +``` ### Required : - name - The name of the planet. - position - The Vector3 positon of the planet in world space. Write as \[x, y, z]. @@ -13,7 +26,7 @@ A planet creator for Outer Wilds. - bottomCloudSize - The size of the bumpy clouds underneath the top. *(Check that the bottom clouds are not poking through the top!)* - cloudTint - The color of the clouds. Write as \[r, g, b, a] in byte form. (0-255) - hasWater - Set to "true" if you want water. - - WaterSize - Size of the water sphere. + - waterSize - Size of the water sphere. - hasRain - Set to "true" if you want it to be raining. - hasGravity - Set to "true" if you want gravity. - surfaceAcelleration - Strength of gravity.