Metadata-Version: 2.2
Name: SK8plotlib
Version: 0.0.4
Summary: Turn any matplotlib line chart into a line skateboarding game.
Author-email: Emily Hunt <emily.hunt.physics@gmail.com>
Maintainer-email: Emily Hunt <emily.hunt.physics@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Emily Hunt
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/emilyhunt/SK8plotlib
Project-URL: Bug Reports, https://github.com/emilyhunt/SK8plotlib/issues
Project-URL: Source, https://github.com/emilyhunt/SK8plotlib
Keywords: matplotlib
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: ipython
Requires-Dist: pyqt6
Requires-Dist: shapely
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"

# SK8plotlib

<p align="center">
<img src="https://github.com/user-attachments/assets/60e1ec11-69f4-4ef1-ae99-c7efe587ac24" width="500" />
</p>


Turn any matplotlib line chart into a line skateboarding game.

> [!CAUTION]
> SK8plotlib is in pre-alpha. Expect bugs. Software provided without warranty, yada yada.

## Installation

Install from PyPI with:

```bash
pip install sk8plotlib
```

## Use

Turn any matplotlib line chart into a skatepark with:

```python
import sk8plotlib.sk8plot as sk8

# ... create a matplotlib figure

sk8(fig)
```

Alternatively, you can load example maps by running SK8plotlib on the command line, such as by doing:

```bash
python -m sk8plotlib
```

## Controls

While on a surface, you can use the `left`/`right` arrow keys to go left or right.

While in the air, you can use `up`/`down` to rotate your skateboard.

## Roadmap

Planned features before v0.1:

- ~~Automatic detection of lines in plot~~
- ~~Basic physics simulation (single accelerating point)~~
- ~~Basic collision detection (skateboard only)~~
- ~~Skateboard rotation on surfaces~~
- ~~User control input~~
- Smooth camera
- Automatic map scaling
- Auto-initialize in correct location

Planned future features:

- Improved player character
- ~~Improved collisions~~ (had to be done sooner than planned...)
- Improved graphics
- Music
- Support for log plots
- Scoring system?
