Metadata-Version: 2.3
Name: offviewer
Version: 0.1.0
Summary: Add your description here
Author: Marcel Tünnissen
Author-email: Marcel Tünnissen <marcelteun@gmail.com>
Requires-Dist: moderngl>=5.12.0
Requires-Dist: numpy>=2.5.2
Requires-Dist: pygame>=2.6.1
Requires-Dist: windnd>=1.0.7
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# About
These scripts were written by Jim McNeill using AI tools. I decided it would be a good idea to add them to a git repo.

# Using Repository from Github

After cloning the the repository the offviewer can be run from the directory through

`uv run offviewer [dir]`

This requires that you have uv installed, see [uv](https://docs.astral.sh/uv/getting-started/installation/)


# Using a Released Version

A released version can be installed by
`pip install offviewer`

# The Off File Viewer
When you open a grid window the sort mode will be greyed out while it
calculates the metrics for the off files.  Once it has done this and you select
a sort order, duplicate values of the sort parameter are highlighted in pink.
The delete duplicates button will keep the oldest file with any one value.
Float parameters have a small tolerance built in.

- Auto rotate is fun but wait until the sort button blacks up or you'll slow it down.
- + (or =) and - will zoom the cells on the grid screen-
- Any polyhedron can be rotated by left dragging with the mouse ot=r by using the arrow keys
- Double click on an image to get to the enlarged screen.
    - The left and right arrows are previous/next file.
    - 'f' on the enlarged screen will cycle through the faces one by one.
    - 'v' does the same with the vertices
    - 'e' does some edge options
    - 'x' to return to the original view
- The grid view also has some functions if you right click.
- The offcheck.py file is also a standalone checker.  If you change the metrics that this is calculating they should flow through into offviewer automatically.
- The path and 'search' at the top of the grid screen don't work (yet) and will probably be removed
