updated README with new terrain generation parameters and included mo…

…re falloff map textures

README.md

@@ -18,15 +18,38 @@
 
 - [📦 Installation](#-installation)
 - [Getting started 📝](#getting-started-)
-  - [Parameters 🗻](#parameters-)
+  - [Terrain parameters 🗻](#terrain-parameters-)
     - [Mesh resolution](#mesh-resolution)
     - [Size depth](#size-depth)
     - [Size width](#size-width)
     - [Max terrain height](#max-terrain-height)
     - [Target Mesh](#target-mesh)
     - [Terrain Material](#terrain-material)
+  - [Water parameters 🌊](#water-parameters-)
+    - [Water Material](#water-material)
+      - [Simple water](#simple-water)
+      - [Realistic water](#realistic-water)
+    - [Water Mesh](#water-mesh)
+    - [Underwater Mesh](#underwater-mesh)
+    - [Water level](#water-level)
+    - [Water size width \& depth extension](#water-size-width--depth-extension)
+    - [Water scale](#water-scale)
+  - [Noise parameters](#noise-parameters)
+    - [Randomize noise seed](#randomize-noise-seed)
     - [Noise](#noise)
     - [Noise texture](#noise-texture)
+    - [Elevation curve](#elevation-curve)
+    - [Fallof map texture](#fallof-map-texture)
+      - [Smooth edges](#smooth-edges)
+      - [Abstract Curve](#abstract-curve)
+      - [Black Holes](#black-holes)
+      - [Center Line](#center-line)
+      - [Center Soft](#center-soft)
+      - [Circle](#circle)
+      - [Inverted Circle](#inverted-circle)
+      - [Tiny Circle](#tiny-circle)
+      - [Circle Irregular](#circle-irregular)
+      - [Vertical](#vertical)
 - [Shader materials 🏞️](#shader-materials-️)
   - [Albedo terrain mix](#albedo-terrain-mix)
 
@@ -54,10 +77,16 @@ This node will warn you in the editor that it needs:
 
 **_If you try to generate a terrain without this values a warning will be pushed to the output window but it does not interrupt the execution of your game._**
 
-## Parameters 🗻
-
 ![terrainy_parameters](images/terrainy_parameters.png)
 
+---
+
+![terrainy_parameters_2](images/terrainy_parameters_2.png)
+
+## Terrain parameters 🗻
+
+This section contains information on parameters that affects the terrain generation. Each time one of this is change in the editor, a new terrain is generated.
+
 ### Mesh resolution
 
 More resolution means more detail _(more dense vertex)_ in the terrain generation, this increases the mesh subdivisions and could reduce the performance in low-spec pcs.
@@ -86,6 +115,54 @@ It only supports `PlaneMesh` `QuadMesh`, `BoxMesh` and `PrismMesh`, otherwise, t
 
 This is the material that will be applied to the Terrain. Take a look on [Shader material](#shader-material) examples to get a detailed terrain surface mixing textures.
 
+## Water parameters 🌊
+
+This section contains information about parameters that affect the water generation for this terrain. This part is optional as it is possible that the water is generated separately in your game.
+
+![island_example](images/falloff_examples/island_example.png)
+
+---
+
+### Water Material
+
+This is the material that will be applied to the water. Both `water_mesh` and `underwater_mesh` will use the same material. We provide two premade materials that to get started:
+
+#### Simple water
+
+A custom shader that provides a simple water with wave movement, available on this addon within the path `res://addons/ninetailsrabbit.terrainy/assets/water/simple/simple_water.tres`
+
+#### Realistic water
+
+A port to Godot 4 of the shader [Godot-Realistic-Water](https://github.com/godot-extended-libraries/godot-realistic-water)
+
+Available on this addon within the path `res://addons/ninetailsrabbit.terrainy/assets/water/realistic/realistic_water.tres`
+
+### Water Mesh
+
+The mesh where the water will be set
+
+### Underwater Mesh
+
+The underwater mesh where the water will be set. This is the same as water mesh but the plugin will change the `flip_faces` to `true` so that when diving you can see the water underneath as well.
+
+### Water level
+
+The water level percent _(0 ~ 1.0)_ about the lowest point of this terrain, this takes into account the terrain `max_height` so a `water_level` of `0.5` adjust the height of the water to the midpoint of the terrain
+
+### Water size width & depth extension
+
+By default the size of the water will be the same as `size_width` and `size_depth` of the terrain. This values can be expanded on `water_size_width_extension` and `water_size_depth_extension`
+
+### Water scale
+
+The scale of the water meshes.
+
+## Noise parameters
+
+### Randomize noise seed
+
+When enabled, in each generation the seed of the selected noise will be randomized. Disable it to do it manually and keep the same seed for the generated land and not lose the structure.
+
 ### Noise
 
 This is a [FastNoiseLite](https://docs.godotengine.org/en/stable/classes/class_fastnoiselite.html#fastnoiselite) instance. Noise values are perfect to generate a variety of surfaces, higher frequencies tend to generate more mountainous terrain.
@@ -119,6 +196,82 @@ This textures are divided into categories:
 - Vein
 - Voronoi
 
+### Elevation curve
+
+This curve is powerful that you can adjust what the maximum height on the ground will be according to the graph from left to right in the generated noise image. This allows you to create flat mountains or holes in the generated terrain
+
+Here you can see an example:
+
+![elevation_curve](images/elevation_curve.png)
+
+### Fallof map texture
+
+Use an image to smooth the edges on the terrain. We provide a few images to get some extra shapes in the generated terrains by being able to create islands, cliffs and so on.
+
+Below I will show the images and the result of the generated plots.
+
+---
+
+#### Smooth edges
+
+![smooth_edges_texture](addons/ninetailsrabbit.terrainy/assets/falloff_images/TerrainFalloff.png)
+
+![smooth_edges](images/falloff_examples/smooth_edge_example.png)
+
+#### Abstract Curve
+
+![smooth_edges_texture](addons/ninetailsrabbit.terrainy/assets/falloff_images/TerrainFallofAbstractCurve.jpg)
+
+![abstract_curve](images/falloff_examples/abstract_curve_example.png)
+
+#### Black Holes
+
+![black_holes_texture](addons/ninetailsrabbit.terrainy/assets/falloff_images/TerrainFallofBlackHoles.webp)
+
+![black_holes](images/falloff_examples/black_holes_example.png)
+
+#### Center Line
+
+![center_line_texture](addons/ninetailsrabbit.terrainy/assets/falloff_images/TerrainFallOfCenterLine.jpg)
+
+![center_line](images/falloff_examples/center_line_example.png)
+
+#### Center Soft
+
+![center_soft_texture](addons/ninetailsrabbit.terrainy/assets/falloff_images/TerrainFallOfCenterSoft.png)
+
+![center_soft](images/falloff_examples/center_soft_example.png)
+
+#### Circle
+
+![circle_texture](addons/ninetailsrabbit.terrainy/assets/falloff_images/TerrainFalloffCircle.png)
+
+![circle](images/falloff_examples/falloff_circle_example.png)
+
+#### Inverted Circle
+
+![inverted_circle_texture](addons/ninetailsrabbit.terrainy/assets/falloff_images/TerrainFallofInvertedCircle.jpg)
+
+![inverted_circle](images/falloff_examples/inverted_circle_example.png)
+
+#### Tiny Circle
+
+![tiny_circle_texture](addons/ninetailsrabbit.terrainy/assets/falloff_images/TerrainFalloffCircleTiny.png)
+
+![tiny_circle](images/falloff_examples/falloff_circle_tiny_example.png)
+
+#### Circle Irregular
+
+![irregular_circle_texture](addons/ninetailsrabbit.terrainy/assets/falloff_images/TerrainFallofCircleIrregular.png)
+
+![circle_irregular](images/falloff_examples/circle_irregular_example.png)
+
+#### Vertical
+
+![vertical_texture](addons/ninetailsrabbit.terrainy/assets/falloff_images/TerrainFalloffVertical.jpg)
+
+![vertical](images/falloff_examples/falloff_vertical_example.png)
+
 # Shader materials 🏞️
 
 When you generate the terrain with a `StandardMaterial3D` the result will be simple and with a single colour unless you use gradients.

addons/ninetailsrabbit.terrainy/assets/water/realistic/Caustic.png.import

@@ -0,0 +1,34 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://kipsnyhb0d7g"
+path="res://.godot/imported/Caustic.png-902dcfc437b3b432b1b713e1b4a772ab.ctex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://addons/ninetailsrabbit.terrainy/assets/water/realistic/Caustic.png"
+dest_files=["res://.godot/imported/Caustic.png-902dcfc437b3b432b1b713e1b4a772ab.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=false
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=1

addons/ninetailsrabbit.terrainy/assets/water/realistic/Foam.png.import

@@ -0,0 +1,35 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://hc2sn3ehmlna"
+path.s3tc="res://.godot/imported/Foam.png-5da10b61431af3709a319ef8df74d1cb.s3tc.ctex"
+metadata={
+"imported_formats": ["s3tc_bptc"],
+"vram_texture": true
+}
+
+[deps]
+
+source_file="res://addons/ninetailsrabbit.terrainy/assets/water/realistic/Foam.png"
+dest_files=["res://.godot/imported/Foam.png-5da10b61431af3709a319ef8df74d1cb.s3tc.ctex"]
+
+[params]
+
+compress/mode=2
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=true
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=0

addons/ninetailsrabbit.terrainy/assets/water/realistic/Water_N_A.png.import

@@ -0,0 +1,35 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://dd0dvo6yaom0n"
+path.s3tc="res://.godot/imported/Water_N_A.png-eb1b67eddb174179838d5cc69f91170c.s3tc.ctex"
+metadata={
+"imported_formats": ["s3tc_bptc"],
+"vram_texture": true
+}
+
+[deps]
+
+source_file="res://addons/ninetailsrabbit.terrainy/assets/water/realistic/Water_N_A.png"
+dest_files=["res://.godot/imported/Water_N_A.png-eb1b67eddb174179838d5cc69f91170c.s3tc.ctex"]
+
+[params]
+
+compress/mode=2
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=1
+compress/channel_pack=0
+mipmaps/generate=true
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=0

addons/ninetailsrabbit.terrainy/assets/water/realistic/Water_N_B.png.import

@@ -0,0 +1,35 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://di18j8qnv7dx"
+path.s3tc="res://.godot/imported/Water_N_B.png-5122f1fa235d09afd12265c5c3aa1a01.s3tc.ctex"
+metadata={
+"imported_formats": ["s3tc_bptc"],
+"vram_texture": true
+}
+
+[deps]
+
+source_file="res://addons/ninetailsrabbit.terrainy/assets/water/realistic/Water_N_B.png"
+dest_files=["res://.godot/imported/Water_N_B.png-5122f1fa235d09afd12265c5c3aa1a01.s3tc.ctex"]
+
+[params]
+
+compress/mode=2
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=1
+compress/channel_pack=0
+mipmaps/generate=true
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=0

addons/ninetailsrabbit.terrainy/assets/water/realistic/Water_UV.png.import

@@ -0,0 +1,35 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://c453bi8lycujo"
+path.s3tc="res://.godot/imported/Water_UV.png-83a8f7459733b13b33330080f0004288.s3tc.ctex"
+metadata={
+"imported_formats": ["s3tc_bptc"],
+"vram_texture": true
+}
+
+[deps]
+
+source_file="res://addons/ninetailsrabbit.terrainy/assets/water/realistic/Water_UV.png"
+dest_files=["res://.godot/imported/Water_UV.png-83a8f7459733b13b33330080f0004288.s3tc.ctex"]
+
+[params]
+
+compress/mode=2
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=true
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=0