Metadata-Version: 2.1
Name: birdseye-mc
Version: 0.1.1
Summary: A tool for watching players on multiplayer Minecraft servers
License: GPLv3
Author: Evan Pratten
Author-email: ewpratten@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: pytest
Requires-Dist: pydantic (>=1.7.2,<2.0.0)
Requires-Dist: pygame (>=2.0.0,<3.0.0)
Requires-Dist: requests (>=2.25.0,<3.0.0)
Description-Content-Type: text/markdown

# Bird's-Eye [![PyPI version](https://img.shields.io/pypi/v/birdseye_mc.svg)](https://pypi.python.org/pypi/birdseye_mc/) ![Poetry Build Suite](https://github.com/Ewpratten/birdseye/workflows/Poetry%20Build%20Suite/badge.svg)

`birdseye_mc` is a GUI application for providing a multi-user bird's-eye view of players on Minecraft servers that have the [Dynmap](https://github.com/webbukkit/dynmap) plugin installed.

## Installation

To install, ensure your system has `python3` and `python3-pip`, then run:

```sh
python3 -m pip install birdseye_mc
```

## Usage

To run `birdseye_mc`, use:

```sh
python3 -m birdseye_mc [dynmap url]
```

Full usage is as follows:

```text
usage: birdseye [-h] [-t] dynmap_url

A tool for watching players on multiplayer Minecraft servers

positional arguments:
  dynmap_url  URL to a dynmap server

optional arguments:
  -h, --help  show this help message and exit
  -t, --test  Show a testing player
```

## Screenshots

![Screenshot](assets/screenshot.png)
