Metadata-Version: 2.3
Name: mc_diag_boat
Version: 0.3.0
Summary: A set of functions for building diagonal boat roads in Minecraft
License: GPL-3.0-or-later
Author: Ribqah
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: litemapy (>=0.10.0b0,<0.11.0)
Requires-Dist: matplotlib (>=3.10.0,<4.0.0)
Requires-Dist: numpy (>=2.0.0,<3.0.0)
Requires-Dist: scikit-image (>=0.25.0,<0.26.0)
Project-URL: Repository, https://github.com/ribqahisabsent/mc-diag-boat.git
Description-Content-Type: text/markdown

# MC Diag Boat

A set of functions for building diagonal boat roads in Minecraft

## Run in Google Colab:

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ribqahisabsent/mc-diag-boat/blob/main/examples/mc_diag_boat.ipynb)

## Watch the Video

Notebook tutorial included at *timestamp*

[![Diagonal Boat Roads](https://img.youtube.com/vi/88TybxATxiw/0.jpg)](https://www.youtube.com/watch?v=88TybxATxiw)

## Installation

### Install Conda

[Instructions for installing Conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)

### Create a Conda environment

In a terminal window, run the following command:

```
conda create -n mcdboat -y python=3.11
```

### Activate your Conda environment

In a terminal window, run the following command:

```
conda activate mcdboat
```

### Install MC Diag Boat and dependencies

In a terminal window, run the following command:

```
pip install git+https://github.com/ribqahisabsent/mc-diag-boat.git@main
```

Alternatively, if you have git installed and want to clone this repository and install
an editable version, run the following commands in the directory you want this
repository to be added to:

```
git clone https://github.com/ribqahisabsent/mc-diag-boat.git
pip install -e mc-diag-boat/.
```


