Metadata-Version: 2.1
Name: linesim
Version: 0.1.4
Summary: A package allowing testing of line following code
Author-email: Eduard Tanase <eduard.tanase1@gmail.com>
Project-URL: Homepage, https://github.com/meme8383/linesim
Project-URL: Bug Tracker, https://github.com/meme8383/linesim/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pygame (>=2.1.2) ; python_version < "3.11"
Requires-Dist: pygame (>=2.1.3-dev8) ; python_version >= "3.11"

# Linesim
[![Build status](https://img.shields.io/github/actions/workflow/status/meme8383/linesim/pylint.yml?style=for-the-badge)](https://github.com/meme8383/linesim/actions/workflows/pylint.yml)
[![PyPI version](https://img.shields.io/pypi/v/linesim?style=for-the-badge)](https://pypi.org/project/linesim/)
[![License](https://img.shields.io/github/license/meme8383/linesim?style=for-the-badge)](https://opensource.org/licenses/MIT)
[![Python versions](https://img.shields.io/pypi/pyversions/linesim?style=for-the-badge)](https://pypi.org/project/linesim/)
[![Wheel](https://img.shields.io/pypi/wheel/linesim?style=for-the-badge)](https://pypi.org/project/linesim/)

Line simulation made with pygame for testing a robot's pathfinding abilities.

Created for testing pathfinding code for Purdue University's ENGR 161 Project 3.

<p align="center">
  <img src="https://raw.githubusercontent.com/meme8383/linesim/main/assets/demo.png" width=400>
</p>

## Features
- Multiple line sensor support
- Default track with curves, broken lines, and multiple paths.

## Installation

Linesim is available on [PyPI](https://pypi.org/project/linesim/).

```
pip install linesim
```

## Usage

Read the [documentation](https://linesim.readthedocs.io/en/latest/) or follow the [Quick Start Guide](https://linesim.readthedocs.io/en/latest/usage.html#quick-start) for more information.
