search

deadlykam / Duniya_Skapare

A godot tool that creates a grid world using algorithms.
MIT License
8 stars 2 forks source link
duniya godot-addon godot-plugin godot4 kamran kamran-wali skapare wali wavefunctioncollapse wfc world-generator

readme

Duniya Skapare

Introduction

A godot tool that creates a grid world using different type of algorithms.

Table of Contents:

Prerequisites

Godot Game Engine

Godot version v4.3.stable.mono.official [77dcf97d8] and above should work. Previous Godot 4 versions should work but those have not been tested.

Stable Build

Stable-v1.0.1 is the latest stable build of the project. The compressed file for this project can also be found there. If development is going to be done on this project then it is adviced to branch off of any Stable branches because they will NOT be changed or updated except for README.md. Any other branches are subjected to change including the main branch.

Installation

  1. First download the latest Duniya_Skapare-v1.0.1.zip from the latest Stable build.
  2. Once downloaded extract/unzip the file.
  3. Enter the folder and copy the folder named kamran_wali.
  4. Now paste the folder in the addons folder of your Godot project. If your Godot project does not have the addons folder then just create it in the root folder, res://, and paste the copied folder there.
  5. (Optional) To open the interface for Duniya_Skapare simply go to the menu Project -> Projct Settings. Click the Plugins tab and enable the DS Wave Function Collapse. This should open and dock the DS Wave Function Collapse.

    Features

    Wave Function Collapse:

    Let me give a brief explanation of Wave Function Collapse. Wave Function Collapse or WFC is a constraint based algorithm that can be used to procedurally generate anything from images to 2D or 3D worlds. Basically that means the algorithm uses a set of rules to generate the desired result. In this tool we are going to use WFC to generate 2D or 3D worlds.

See Wave Function Collapse Tool and Wiki documentations to understand how to use the tool.

Wave Function Collapse Examples:

Simple_WFC_Animation Tiles
Fig 1a: Simple WFC - Animation Fig 1b: Tile Sets
Expand_WFC_Animation Tiles
Fig 2a: Expand WFC - Animation Fig 2b: Tile Sets
Continuous_Tile_WFC_Animation Tiles
Fig 3a: Continuous Tile WFC - Animation Fig 3b: Tile Sets
Simple_WFC_Animation Tiles
Fig 4a: Simple WFC - Animation Fig 4b: Tile Sets

Updates

Updated the project for Godot 4.3, v4.3.stable.mono.official [77dcf97d8]. From code perspective had to change 2 lines because in Godot 4.3 you can no longer give a type return to an overridden method that has no type. So had to change some methods in child scripts and remove their return types. Everything else is working fine. Also if you are following the tutorial then it is recommended to use Godot 4.1 and plugin Stable-v1.0.0. But if you want to use Godot 4.3 then you can do so as well but must use the plugin Stable-v1.0.1 instead.

Duniya Skapare Meaning

The meaning of Duniya Skapare is World Creator. Duniya means World in Arabic/Bengali. Skapare means Creator in Swedish. As I speak the mentioned languages I thought about merging them to give a unique name.

Tutorials

  1. Tutorial Duniya Skapare - Wave Function Collapse

    Versioning

    The project uses Semantic Versioning. Available versions can be seen in tags on this repository.

    Authors