Metadata-Version: 2.5
Name: diamond_square
Version: 0.1.9
Summary: A package which can implement and draw terrains using the Diamond Square Algorithm in pgzero and pygame. Uses C for fast rendering.
Project-URL: Homepage, https://github.com/gootyboy/diamond_square
Project-URL: Issues, https://github.com/gootyboy/diamond_square/issues
Author-email: Gautam Pulugurta <gootyboy@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.5
Requires-Dist: pgzero
Requires-Dist: pillow
Requires-Dist: pygame
Description-Content-Type: text/markdown

# Diamond Square

Implementation of the [Diamond–Square Algorithm](https://en.wikipedia.org/wiki/Diamond-square_algorithm). This package can draw terrain on pgzero and pygame, and can also set up interactive mode.

---

## Sample Generations

![Sample Default Terrain](https://gootyboy.github.io/project_details/diamond-square/default_terrain.png)
![Sample Desert Terrain](https://gootyboy.github.io/project_details/diamond-square/desert_terrain.png)
![Sample Tundra Terrain](https://gootyboy.github.io/project_details/diamond-square/tundra_terrain.png)
![Sample Tropical Terrain](https://gootyboy.github.io/project_details/diamond-square/tropical_terrain.png)
![Sample Volcanic Terrain](https://gootyboy.github.io/project_details/diamond-square/volcanic_terrain.png)
![Sample Swamp Terrain](https://gootyboy.github.io/project_details/diamond-square/swamp_terrain.png)
![Sample Ocean Terrain](https://gootyboy.github.io/project_details/diamond-square/ocean_terrain.png)
![Sample Mars Terrain](https://gootyboy.github.io/project_details/diamond-square/mars_terrain.png)
![Sample Crazy Mars Terrain](https://gootyboy.github.io/project_details/diamond-square/mars_crazy.png)

---

> ### ⚠️ ***You MUST include all four interactive functions for pgzero interactive***
>
> Missing even one will cause failures or unpredictable behavior.

---

## Table of Contents

- Why Use Diamond Square?
- Usage
  - Pgzero Terrain Example
  - Pgzero Interactive Terrain Example
  - Pygame Terrain Example
  - Pygame Interactive Terrain Example
  - Image Saving Examples
  - Custom Biome Examples
- Requirements for Pgzero Interactive
- Versions
- Coming Soon

---

## Why Use diamond-square?

This package provides a complete implementation of the Diamond–Square algorithm with:

- Fast rendering of the Diamond-Square algorithm written in C.

- Multiple built‑in biomes.

- Adjustable roughness and scale.

- Support for pgzero and pygame.

- Optional interactive mode.

- The ability to save generated terrain as an image.

- Functions to add or remove biomes dynamically.

It is designed for both experimentation and game development, making terrain generation simple and customizable.

---

## Usage

### Pgzero Terrain Example

Go to [/sample_codes/pgzero_terrain.py](https://github.com/gootyboy/diamond_square/blob/main/sample_codes/pgzero_terrain.py)

### Pgzero Interactive Terrain Example

Go to [/sample_codes/pgzero_interactive_terrain.py](https://github.com/gootyboy/diamond_square/blob/main/sample_codes/pgzero_interactive_terrain.py)

### Pygame Terrain Example

Go to [/sample_codes/pygame_terrain.py](https://github.com/gootyboy/diamond_square/blob/main/sample_codes/pygame_terrain.py)

### Pygame Interactive Terrain Example

Go to [/sample_codes/pygame_interactive_terrain.py](https://github.com/gootyboy/diamond_square/blob/main/sample_codes/pygame_interactive_terrain.py)

### Image Saving Examples

Go to [/sample_codes/save_terrain.py](https://github.com/gootyboy/diamond_square/blob/main/sample_codes/save_terrain.py)

### Custom Biome Examples

Go to [/sample_code/custom_biome.py](https://github.com/gootyboy/diamond_square/blob/main/sample_codes/custom_biome.py)

---

## Requirements for Pgzero Interactive

For Pgzero Interative Mode, it requires **all four** of the following functions to be placed in their corresponding pgzero event handlers:

```python
terrain.draw_func(screen)
terrain.on_mouse_down_func(pos)
terrain.on_mouse_up_func()
terrain.on_mouse_move_func(pos)
```

If **any one** of these is missing, the interactive mode will:

- fail to update correctly

- behave unpredictably

- or stop working entirely

These must be placed in these functions in pgzero:

- `def draw():` → `terrain.draw_func(screen)`

- `on_mouse_down(pos):` → `terrain.on_mouse_down_func(pos)`

- `on_mouse_up():` → `terrain.on_mouse_up_func()`

- `on_mouse_move(pos):` → `terrain.on_mouse_move_func(pos)`  

---

## Versions

**(Latest) Version 0.1.9**: Improve speed in C file and fix bugs.

Version 0.1.8: Add remake terrain button for interactive mode in pgzero.

Version 0.1.7: Fix terrain generation and README updates.

*To view previous versions, go to [versions.txt](https://github.com/gootyboy/diamond_square/blob/main/versions.txt)*

---

## Coming Soon

Version 0.2.0: Add re-generate button for interactive mode in pygame.
