Metadata-Version: 2.1
Name: linesim
Version: 0.2.2
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

# 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 robot pathfinding algorithms.

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

## Features
- Configurable line sensors (color sensors) and ultrasonic sensors.
- Default tracks with different types of lines and a maze.
- Custom track support

## 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.
