Skip to content

Commit 8130f27

Browse files
committed
readme complete
1 parent 1ff0daa commit 8130f27

3 files changed

Lines changed: 50 additions & 5 deletions

File tree

README.md

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,20 @@
44

55
![alt](https://raw.githubusercontent.com/faltastic/pixelSortLive/master/screenshots/main.jpg)
66

7-
### What is this?
7+
## What is this?
8+
89
This sketch performs pixel sorting on a collection of photo sets. It was built to be used in live performances.
910

10-
* It runs on [Processing](https://processing.org/).
11+
* It runs on [Processing](https://processing.org/) (2).
1112
* For the GUI, I use [controlP5](http://www.sojamo.de/libraries/controlP5/) which works ok on Processing 2 but not 3.
1213
* The sorting algorithim used is [this sketch](https://github.com/phillipdavidstearns/aYearInCode/blob/master/Processing%202.2.1/cellSort/cellSort.pde) written by Phillip Davis Stearns.
1314

1415
## How to Use It?
1516

16-
To add your own photo sets, place them in the data folder and add their names to the photoSets string array at the top of the main sketch
17+
18+
Install the [controlP5 library](http://www.sojamo.de/libraries/controlP5/) and open the sketch in Processing 2.
19+
20+
To add your own photo sets, place them in the data folder and add them to photoSets at the top of the main sketch
1721

1822
```processing
1923
String[] photoSets = {
@@ -29,10 +33,51 @@ That's it!
2933

3034
![alt](https://raw.githubusercontent.com/faltastic/pixelSortLive/master/screenshots/gui.jpg)
3135

36+
Let's go through what the control window let's you do:
37+
38+
* Play = play/pause
39+
* Reload = restart the sorting on the current image
40+
* Wrap = toggle wrapping pixels on image edges on/off (default: on)
41+
42+
43+
* Sort Matrix = the direction in which the sorting is to be done
44+
* Mode = choose between 6 sorting algorithims
45+
46+
47+
* Range = lower and upper brightness thersholds of which pixels to be sorted
48+
* Sort Flip = flip the sorting thersholds
49+
50+
51+
* Frate = speed control, it really changes the sketch's framerate
52+
53+
54+
* No Flip = toggle flipping image in the photoset (default: on)
55+
* Next Image = load next image in the photoset
56+
* Flip Time = set how long it takes between image flips, the higher the value the slower the flip
57+
58+
* Albums = load another album
59+
60+
### Hidden Controls
61+
62+
You can control the size of the display window in the first line in the setup() function
63+
64+
```processing
65+
size(1080, 720);
66+
```
67+
68+
If you want to print out the frames of your animation, press **P** while playing, and the files will be saved in a **prints** folder in *tif* format.
69+
70+
71+
## Thanks
72+
73+
To [Kareem Osman](https://vimeo.com/kafkube) for the help testing this code in the wild.
3274

3375
## License
3476

35-
MIT
77+
MIT 2017
78+
79+
Basically, you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.
80+
81+
If you use this code in a live show or to make a video, I would love to hear from you. Email me at youssef.faltas@gmail.com
3682

37-
[![N|Solid](https://cldup.com/dTxpPi9lDf.thumb.png)](https://nodesource.com/products/nsolid)
3883

screenshots/gui.jpg

-19.9 KB
Loading

screenshots/main.jpg

105 KB
Loading

0 commit comments

Comments
 (0)