Metadata-Version: 2.3
Name: offviewer
Version: 0.4.0
Summary: Add your description here
Author: Jim McNeill, Marcel Tünnissen
Author-email: Marcel Tünnissen <marcelteun@gmail.com>
Requires-Dist: moderngl>=5.12.0
Requires-Dist: numba>=0.67.0
Requires-Dist: numpy>=2.5.2
Requires-Dist: pillow>=12.3.0
Requires-Dist: pygame>=2.6.1
Requires-Dist: scipy>=1.18.0
Requires-Dist: tkinterdnd2>=0.6.2
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. These files come as is and without any
guaratees and I cannot promise that any problems will be solved any time soon.

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

It is wise to use a virtual Python environment, e.g. on Linux:
```
python -m venv path_to_venv
. path_to_venv/bin/activate
```

Then the script can be run by:
`offviewer [path-to-folder]`

There is also the scripts
- `offchecker`
- `facetings`

# 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 face types one by one.
    - 'v' cycles through the vertices
    - 'e' does some edge options (also on the grid view)
    - 'x' to return to the original view
- The grid view also has some functions if you right click: delete, rename, view source, open in Stella.
- 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
