BulkAutoTile

Godot implementation of an autotile algorithm for tilemaps with JSON configuration.

Why?

Godot's terrain implementation works well for static maps that do not change during gameplay. However, it is extremely slow for use cases like rendering chunks at runtime or generating large portions of the tilemap.

This library is designed to solve this issue for projects that require runtime autotile generation.

Features

• Ready-to-use Godot implementation
• Bulk AutoTiling
• Fully async compatible
• Multiple tile types can autotile with each other
• Much faster than Godot's terrain implementation (see benchmarks)
• Tile configuration (includes bitmasks and connections)

Benchmarks

Speed comparison between Godot's built-in terrain feature and this autotile implementation was performed using a simple benchmark (source code in the godot-example project directory).

Result for 128x128 chunk

Result for 256x256 chunk

Installation

Manual reference to .dll

# Clone repo
git clone https://github.com/ruedoux/godot-autotile
cd godot-autotile

# Compile for Linux
./compile.sh

# Compile for Windows
./compile.bat

After doing that you can copy the godot-example/addons/bulk-autotile folder from this repo into your project.

Add .csproj reference so Godot project sees the .dll's:

<ItemGroup>
  <Reference Include="BulkAutoTile">
    <HintPath>addons/bulk-autotile/bin/BulkAutoTile.dll</HintPath>
  </Reference>
</ItemGroup>

Manual reference to .csproj for git project

Add the submodule outside of your .csproj file directory, example:

# Add submodule to your project
git submodule add https://github.com/ruedoux/godot-autotile
git submodule update --init --recursive

# Go to your main project path and reference the submodule
cd /your/project/path
dotnet add reference ../path/to/godot-autotile/lib/BulkAutoTile.csproj