better-terrain

KO | EN

gitlite — search

#python #hacktoberfest #ai #android #machine-learning #linux #docker #cli #kubernetes #awesome-list #vue #pytorch #security #ios

(★ 739)

Terrain plugin for Godot 4

File Explorer

Download Latest Version (.zip)

- - BetterTerrain.cs
  - BetterTerrain.gd
  - BetterTerrainData.gd
  - icon.svg
  - icon.svg.import
  - plugin.cfg
  - TerrainPlugin.gd
  - Watcher.gd
.gitattributes
.gitignore
LICENSE.md
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# better-terrain
Terrain plugin for Godot 4's tilemap.

This plugin implements autotile-style terrain system with multiple connections. It works with the existing tilemaps and tilesets alongside Godot 4 features.

![Example of terrain system in use](https://github.com/Portponky/better-terrain/assets/33663279/a8399964-4595-4638-b979-fd73223a4245)

### Why?

Godot 4 has a terrain system built-in to its tilemap node. This system has some tricky behaviors and is tailored towards a very specific usage of tilemaps, rather than a more general case. It's also quite slow, and the API is difficult to use at runtime. There are very large functional gaps caused by the replacement of the Godot 3 autotile system.

### Installation

`better-terrain` is available from Godot's asset library, but the latest version is available here.

To get started with `better-terrain`, follow these steps:

1. Either:
    * Clone or download the repo, and copy the `addons` folder into your Godot project.
    * In Godot's asset library, search for `Better Terrain` and click download.

2. In `Project settings` make sure the plugin is enabled in the `Plugins` tab.
3. Restart Godot.

Now when you select a tilemap node, a new dock tab called 'Terrains' will show up. Here, you can define terrains and paint with them.

### Usage in the editor

The dock has terrain types on the left, and tiles on the right. At the bottom of the terrain types, there are buttons to add, modify, sort, or remove terrain types. A terrain type has a name, a color, a type, and an optional icon. The four types are:

* **Match tiles**: This terrain places tiles based on how well they match their neighboring tiles. It's a good replacement for '3x3' and '3x3 minimal' from Godot 3, and 'Match sides' and 'Match corners and sides' from Godot 4's built-in terrain system.
* **Match vertices**: This terrain analyses the vertices of each tile and chooses the highest neighboring terrain type (as in, highest in the terrain list, with empty/non-terrain being the highest overall). It's a replacement for '2x2' in Godot 3, or 'Match corners' in Godot 4.
* **Category**: Categories are used to create advanced matching rules. Tiles assigned to a category never modify the tilemap, but terrains can match against categories, and also belong to them.
* **Decoration**: There is always only one decoration type available at the end of your terrain list. It treats its tiles equivalent to empty cells, and is used to add supplementary tiles around the edge of other terrains. It behaves like 'Match tiles' otherwise.

Along the top, you will find the following buttons:

* Pen, line, rectangle, and fill tools. These are for drawing in the scene. Right click will erase.
* Select, change type and change peering connecting types. Note that these are unselected by default to prevent accidental alterations to the terrain settings. You can unselect them after using them.
* A zoom slider for the tiles.
* An option to control the level of randomization used.
* A layer selector for the scene. Unfortunately, the layer highlight option is not exposed to GDScript, so that is unavailable.

You may also see a "Clean data" button, which occurs when terrain has data that does not apply to the current tileset shape or offset axis (for example, you set up rectangle terrain then change the tileset to be hexagonal).

### Usage in code

The terrain system is usable via code via the `BetterTerrain` autoload, which the plugin handles. The editor dock is implemented entirely using this class, so it is fully featured.

To edit terrain at runtime, first you must set terrain into cells, and then you must run an update function for the cells to allow it to pick the best tile for each terrain. This is similar to the API for Godot 3.

To set or get terrain in cells, these functions are available. Terrain types are integer indexes into the list you see in the editor (e.g. the first terrain is 0, the second is 1, etc...)

* `func set_cell(tm: TileMapLayer, coord: Vector2i, type: int) -> bool`
* `func set_cells(tm: TileMapLayer, coords: Array, type: int) -> bool`
* `func get_cell(tm: TileMapLayer, coord: Vector2i) -> int`

Once cell(s) are set, they must be updated. Use one of these functions to run the updates. They also update the neighboring cells, though that can be switched off if desired.

* `func update_terrain_cells(tm: TileMapLayer, cells: Array, and_surrounding_cells := true) -> void`
* `func update_terrain_cell(tm: TileMapLayer, cell: Vector2i, and_surrounding_cells := true) -> void`
* `func update_terrain_area(tm: TileMapLayer, area: Rect2i, and_surrounding_cells := true) -> void`

Documentation is available in Godot's editor help system, accessed by pressing F1.

### Videos

I made some videos on how to use this plugin.

[![Tutorial videos](http://i3.ytimg.com/vi/7m3OeacBaLE/hqdefault.jpg)](https://www.youtube.com/watch?v=7m3OeacBaLE&list=PL2lDzGzxtEmeKDUQcpYx4YA1HpH3tzYqZ "Tutorial videos")

### Contact

Feel free to report bugs here, or find me (Portponky#6300) on the Godot official discord server. Have fun!

better-terrain

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

better-terrain

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README