Awesome

Disclaimer • Key Features • How To Use • Support • License

Disclaimer

This project has been made mainly for my own project. I'm pretty new to gamedev so if something is not done the way it should, feel free to contact me! <br> I'm happy to share it with the community but it's possible that some features that you would expect are not there. <br> I'm gonna be happy to accept PR for new features if it fits.

Godot 4.2 and lower (4.x)

The demo scene has been updated to Godot 4.3 which makes it break with older version of Godot.

Key Features

• Sculpt - Sculpt your terrain with a heightmap
  • Increase the terrain
  • Decrease the terrain
  • Smooth the terrain
  • Flatten the terrain
  • Set height (paint to a specific height)
  • Set angle (paint from a starting point with a specific angle)
• Paint textures - Add colors to your terrain with the textures painting tool
  • Normal map and roughness texture are supported
• Foliage - Add foliage to your terrain (ex. Grass)
  • The foliage follows the main camera with a given maximum distance
• Packed scenes - Scatter packed scenes to the terrain
  • Multiple objects can be scattered with one brush
  • Random Y rotation is supported
  • The packed scenes will always follow the terrain
  • Live adjustment of the position while the terrain is sculpting
• Water - Add water to your terrain
  • The water will make the terrain go lower for the painted area
  • The packed scenes and the foliage will also get lower with the water
  • Support for custom shader
• Water flow - Paint the direction of the water
• Snow - Add thick snow to your terrain
  • The texture of the snow is configurable so it's easy to make something like sand
  • Support for custom shader
• Hole - Paint hole. Useful to create cave or juste to make a terrain that is not square.
• Multiple brushes
  • Custom brushes are also available
• Pie menu
• Shortcuts
  • The plugin has been made so it's really easy to use. A lot of shortcuts are available.
    • LShift - Reverse the tool. Usually, this option will go from "Add" to "Remove". For the sculpting option, this does the "Smooth" option.
    • V - Show the PieMenu for the current tool
    • B - Show the PieMenu for the current brush
    • N - Show the options for the current tool (ex. While painting the textures, the PieMenu will show textures)
    • G - Show a quick select for the brush size
    • H - Show a quick select for the brush strength
    • K - Toggle "Auto add zones"
    • X - Lock on X axis
    • Z - Lock on Z axis
  • Shortcuts can be Re-Assigned. To Access them, Goto 'Project->Tools->TerraBrush Key bindings' to access the keymap, and ability to re-assign keys. - Implemented by @eumario
• Settings - Some settings are available in the "ProjectSettings->TerraBrush" (ex. The decal color)
• LOD - The terrain is created using a custom clipmap mesh so less vertices are needed. https://youtu.be/BardvKC0HF0
• MultiZones - The terrain support creates multiple zones (or chunks or regions) to improve performances on bigger terrain. https://youtu.be/X_klfk-kdSE
• Heightmap based blending - Textures can be blended with heightmaps/bumpmaps with custom intensity. - Implemented by @ZaPx64
• Paint locked areas - Areas on the terrain can be locked so you don't modify completed parts

How To Use

Watch the tutorial video! https://youtu.be/n5WeAqeea1c

Note Make sure you have the .Net version of Godot Engine.

Clone this repository - If you only want to try out the demo scene, you can run this project in Godot directly. Else, copy the folder "addons/terrabrush" to your "addons" folder.

# Clone this repository
$ git clone https://github.com/spimort/TerraBrush

Add a C# Solution - To make sure that your project has C# enabled, go under "Project->Tools->C#->Create C# Solution".

Compile - It's really important to compile using this icon so Godot can run the plugin.

Enable the plugin - When the game has been compiled once, you should be able to enable the plugin. To do that, go under "Project->ProjectSettings->Plugins" and enable the checkbox next to TerraBrush.

Add the node - To add a terrain node, in the "Add node" screen, search for "Node3D->TerraBrush" ()

Update the terrain

Some properties of the node require the terrain to refresh (mainly for the shaders and stuff). If something does not refresh, hit that "UpdateTerrain" button! <br> For example, if you add a new texture, add foliage, add an object, add a water definition or add snow, you'll have to hit the "UpdateTerrain" button.

Node properties

Node Signals

Interact with the terrain

To interact with the terrain (for example, to make water ripple), you can call the function AddInteractionPoint on the TerraBrush node. This function requires an x and y position, corresponding to the x and y coordinates on the map, in meters. <br> To retrieve information from the map (for example, to get what texture the player is on), you can call the function GetPositionInformation on the TerraBrush node.

These two functions can be called from GDScript and C#.

C# Snippet

// Let's assume we have a variable called "TerraBrush" that is a TerraBrush Node.
// Let's validate that we are on the ground
if (IsOnFloor() && GetLastSlideCollision() != null) {
    // Get the current collision
    var collision = GetLastSlideCollision();

    // Let's make sure the collider is the collider of the Terrain
    if (collision?.GetCollider() == TerraBrush?.Terrain?.TerrainCollider) {
        // The variable playerX and playerZ are the variables for the global position of the player
        var result = TerraBrush.GetPositionInformation(playerX, playerZ);
        // If we don't get a result, it means we are out of the terrain
        if (result != null) {
            // The texture at position 0 is the most present one
            var mainTexture = result.Textures?.Length > 0 ? result.Textures?[0].Name : "";

            // Do something with the mainTexture information
            ...
        }
    }
}

GDScript Snippet

# Let's assume we have a variable called "%TerraBrush" that is a TerraBrush Node.
# Let's validate that we are on the ground
if is_on_floor() and get_last_slide_collision() != null:
    # Get the current collision
    var collision = get_last_slide_collision()

    # Let's make sure the collider is the collider of the Terrain
    if collision.get_collider() == %TerraBrush.Terrain.TerrainCollider:
        # The variable playerX and playerZ are the variables for the global position of the player
        var result = %TerraBrush.GetPositionInformation(playerX, playerZ)
        # If we don't get a result, it means we are out of the terrain
        if result != null:
            # The texture at position 0 is the most present one
            var mainTexture = result.Textures[0].Name if result.Textures.size() > 0 else ""
            # Do something with the mainTexture information
            ...

Navigation mesh

In order to use a navigation mesh, make sure to set the Parsed Geometry Type to Static Colliders in your navigation mesh.

Support

You want to support my work?

Demo credits

Trees: https://www.turbosquid.com/3d-models/3d-shapespark-low-poly-plants-kit-1826978 <br> Grass: https://opengameart.org/content/stylized-grass-and-bush-textures-0 <br> Textures: https://ambientcg.com/

License

MIT

Youtube @spimortdev  ·  Twitter @spimortdev