Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 4.41 KB

README.md

File metadata and controls

54 lines (38 loc) · 4.41 KB

Terrain3D

An editable terrain system for Godot 4, written in C++.

Features

  • Written in C++ as a Godot gdextension plugin, which works with official engine builds
  • Geometric Clipmap mesh terrain (as used in The Witcher 3)
  • Up to 16k x 16k, sliced up in non-contiguous 1k regions (think multiple islands without paying for 16k^2 vram)
  • Up to 10 levels of detail (LODs)
  • Up to 32 textures
  • Sculpting, texture painting, texture detiling, paint colors or wetness
  • Supports importing heightmaps from HTerrain, WorldMachine, Unity, Unreal and any tool that can export a heightmap (raw/r16/exr/+)

See the Wiki for more details on project status, features, design, and usage.

Requirements

  • Supports Godot 4.0+
  • It is being developed on Windows. It should work on Windows, Linux, and OSX if you build it yourself.

Installation & Setup

  1. Download the latest release, or build the plugin from source.
  2. Close Godot, then Copy addons/terrain_3d to your project folder in addons/terrain_3d.
  3. Open Godot. Let it complain about importing errors and may even crash. Then restart Godot.
  4. In Project Settings / Plugins, ensure that Terrain3D is enabled.
  5. Open the demo scene demo/Demo.tscn, or:
  6. Create or open a scene and add a new Terrain3D node.
  7. Select Terrain3D. In the inspector, create a new Terrain3DStorage resource.
  8. Click the down arrow to the right of the storage resource and save it as a binary .res file. This is optional, but highly recommended. Otherwise it will save terrain data as text in the current scene file.

Getting Support

  1. Read through the Wiki, especially Troubleshooting.
  2. Search through the issues for known issues, or create a new one if you're sure it's not a duplicate.
  3. Join the Tokisan discord server and look for the Terrain3D section.

Credit

Developed for the Godot community by:
Architect Roope Palmroos, Outobugi Games
Project Manager Cory Petkovsek, Tokisan Games

And other contributors displayed on the right of the github page and in CONTRIBUTORS.md.

Geometry clipmap mesh code created by Mike J Savage. Blog and repository code released under the MIT license per email communication with Mike.

License

This plugin is released under the MIT license. See LICENSE.