From 0fc1f7cad7aa33b822295fd846e2bbc1152e8257 Mon Sep 17 00:00:00 2001 From: Mister_Nebula <41904486+misternebula@users.noreply.github.com> Date: Sun, 12 Apr 2020 16:02:19 +0100 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 3d371654..b6b2d638 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,22 @@ A planet creator for Outer Wilds. ## List of available options : +### Required : +- name - The name of the planet. +- position - The Vector3 positon of the planet in world space. Write as \[x, y, z]. +- orbitAngle - The angle of the orbit. + +### Optional : +- hasClouds - Set to "true" if you want Giant's Deep-type clouds. + - topCloudSize - The size of the outer sphere of the clouds. + - 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. +- hasRain - Set to "true" if you want it to be raining. +- hasGravity - Set to "true" if you want gravity. + - surfaceAcelleration - Strength of gravity. +- hasMapMarker - Set to "true" if you want the planet name on the map. +- hasFog - Set to "true" if you want fog. + - fogTint - The color of the fog. Write as \[r, g, b, a] in byte form. (0-255) + - fogDensity - The thickness of the fog. \[0-1]