Metadata-Version: 2.4
Name: jelkasim
Version: 1.2.0
Summary: Simulation for running Jelka FMF patterns
Project-URL: Homepage, https://github.com/Jelka-FMF/JelkaSim
Project-URL: Issues, https://github.com/Jelka-FMF/JelkaSim/issues
Author-email: Jošt Smrtnik <jost.smrtnik@gmail.com>, Filip Štamcar <projects@filips.si>
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: jelka-validator
Requires-Dist: pygame
Description-Content-Type: text/markdown

# Jelka Simulation

Simulation for running Jelka FMF patterns.

## Note

If you want to contribute your own Jelka FMF patterns, you should check out the [Storži](https://github.com/Jelka-FMF/Storzi) repository for full instructions about developing and contributing patterns.

## Installation

```sh
pip install jelkasim
```

## Usage

```
usage: jelkasim.exe [-h] [--positions POSITIONS] run [run ...]

Run Jelka FMF simulation.

positional arguments:
  run                   How to run your program.

options:
  -h, --help            show this help message and exit
  --positions POSITIONS
                        File with LED positions. Leave empty for automatic detection or random.
```

Examples:

```sh
jelkasim moj_vzorec.py
jelkasim moj_vzorec.exe
jelkasim node moj_vzorec.js
jelkasim ocaml moj_vzorec.ml
```

For OCaml inside Docker, something like this should be used (probably):

```sh
jelkasim docker exec container-name "ocaml moj_vzorec.ml"
```

You should also figure out the container name using:

```sh
docker ps
```
