README.md

# Projekt Paintropy
- [Projekt Paintropy](#projekt-paintropy)
  - [Was ist Paintropy](#was-ist-paintropy)
  - [Wie benutzt man Paintropy](#wie-benutzt-man-paintropy)
    - [Starten des Spiels](#starten-des-spiels)
    - [Spielen des Spiels](#spielen-des-spiels)
    - [Der *Collagen-maker*](#der-collagen-maker)
    - [Videos selber hinzufügen (experimentell)](#videos-selber-hinzufügen-experimentell)
  - [Installationshinweise](#installationshinweise)
  - [Verwendete Medien](#verwendete-medien)

## Was ist Paintropy
Mit Paintropy, einer Pythonanwendung, werden *Youtube-typische* Videos zu Spielfiguren eines lokalen two-player games. Die Informationen von den auswählbaren *short-videos* und *normalen* Videos wurden unter dem Gesichtspunkt des Begriffes Entropy extrahiert[^1]
[^1]Die Bewegung in den Videos wurden mittels [optical flow analysis](https://docs.opencv.org/3.4/d4/dee/tutorial_optical_flow.html) ermittelt. Außerdem wurde die mittlere Standardabweichung des Kontrates als Faktor herbeigezogen um die Kreise wachsen oder schrumpfen zu lassen.
## Wie benutzt man Paintropy
### Starten des Spiels
Um das Spiel zu starten muss das Script `main.py` über die Kommandozeile mit Python aufgerufen werden. Das Script erwartet zusätzlich einen Dateinamen, welcher später genutzt wird um das Endresultat der Spielrunde unter `PROJEKTORDNER/_out/Dateiname.png` zu speichern.
### Spielen des Spiels
Ist Spiel gestartet müssen Spieler eins und zwei zunächst jeweils drei Videos und können wenn gewünscht eine Farbe auswählen. Spieler eins wählt ein Video aus, indem dieser mit der **linken** Maustaste auf eines der angezeigten Thumbmails klickt und Spieler zwei indem dieser mit der **rechten** Maustaste klickt. Die Spielerfarben können mit der gleichen Tastenbelegung ausgewählt werden, indem auf eine Stelle auf dem Farbstreifen geklickt wird.
### Der *Collagen-maker*
TBC
### Videos selber hinzufügen (experimentell)
TBC
## Installationshinweise
Zum Spielen von Paintropy müssen folgende Packages installiert sein:
- numpy
- pygame
- pygame_gui
- opencv-contrib-python

Diese können mit dem [PIP](https://pip.pypa.io/en/stable/installation/)-Installer installiert werden.

Alternativ kann das Script `paintropy_installer.py` über die Konsole aufgerufen werden. Mit diesem Script kann je nach Eingabe entweder überprüft werden, ob alle benötigten Packages installiert sind und ebenfalls installiert werden. Dieses Script funktioniert btw. mit PIP!

*Edit: Die Überprüfung ob open-cv installiert ist, funktioniert aus mir unerkenntlichen Gründen nicht. Wenn das install-Script auch für die Installation verwendet wurde sollte opencv aber eig. korrekt installiert sein.*
## Verwendete Medien
Alle Verwendeten Videos können in der Datei `data/videos/ressources.txt` eingesehen werden.