Metadata-Version: 2.1
Name: geks
Version: 0.0.1
Summary: Hexagonal mapmaking toolkit
Author-email: Vasily Negrebetskiy <kmiziz.com@gmail.com>
Project-URL: source, https://github.com/kompoth/geks
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Cython
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Provides-Extra: mpl
License-File: LICENSE

# Geks

Geks is a toolkit for hexagonal mapmaking. 

<p align="center">
    <img src="https://raw.githubusercontent.com/kompoth/geks/main/img/example.png" width="400">
</p>

## Installation

Currently there is no PyPI package.

To install development version from GitHub (preferably in a virtual environment):
```bash
git clone https://github.com/kompoth/geks.git
make install-mpl
```
Suffix `mpl` means that Geks will be installed with `matplotlib` that powers a
testing front-end. See other build and install commands in `Makefile`.

## Credits

- [Red Blob Games blog](https://www.redblobgames.com/)
- [Martin O'Leary article](https://mewo2.com/notes/terrain/)
- [Altitude generation for hexagonal maps](https://github.com/generesque/hexmap)
- [Planchon-Darboux method](https://www.researchgate.net/publication/240407597_A_fast_simple_and_versatile_algorithm_to_fill_the_depressions_of_digital_elevation_models)
