Duniya Skapare

Introduction

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

Table of Contents:

• Prerequisites
  • Godot Game Engine
• Stable Build
• Installation
• Features
  • Wave Function Collapse
    • Wave Function Collapse Examples
• Updates
• Duniya Skapare Meaning
• Tutorials
• Versioning
• Authors
• License

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.2 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.2.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:

Fig 1a: Simple WFC - Animation	Fig 1b: Tile Sets

Fig 2a: Expand WFC - Animation	Fig 2b: Tile Sets

Fig 3a: Continuous Tile WFC - Animation	Fig 3b: Tile Sets

Fig 4a: Simple WFC - Animation	Fig 4b: Tile Sets

---

Updates

1. Added tile custom co-ordinate while generating tiles feature. This means you can now give the starting tile co-ordinates for the x and y axis tiles and the logic will use that starting value to set the co-ordinate for the rest of the tiles. This is helpful if you know where to place your tiles in the game co-ordinate. If no values are given then the default co-ordinate will be used which is 0.
2. Added a flag that checks if the grid should be setup automatically during application start. This is to give more control to the user.
3. Added tile index. This way it will help the user to sync the tile's with other array.

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

• Syed Shaiyan Kamran Waliullah
  • Kamran Wali Github
  • Kamran Wali Twitter
  • Kamran Wali Youtube
  • Kamran Wali Website

---

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

---