hypercube-0.3.12
[polytopiary:hypercube.git] / README
1 hypercube -- interaction in four dimensions.
2 Copyright (C) 2006 Claude Heiland-Allen
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17
18 version:   0.3.12
19 requires:  libsdl, libpng, liblo
20 compile:   make
21 usage:     ./hypercube <width> <height> <depth1> <depth2> <savecount> <listenport> <sendport>
22 example:   ./hypercube 640 480 512 1024 1 7777 8888
23 keys:
24  ESC         -- exit (or use window close button)
25  SPACE       -- pause/unpause
26  PRINTSCREEN -- save frame to numbered PNG file(*)
27  q,w,e,r,t,y -- increase rotation speeds
28  a,s,d,f,g,h -- zero rotation speeds
29  z,x,c,v,b,n -- decrease rotation speeds
30 open sound control:
31  /hypercube/quit -- quit
32  /hypercube/rotate/inc  dim1:f dim2:f -- increment rotation speeds
33  /hypercube/rotate/zero dim1:f dim2:f -- stop rotations
34  /hypercube/rotate/dec  dim1:f dim2:f -- decrement rotation speeds
35  /hypercube/vertex2d n:i x:f y:f -- raw vertex coordinates
36  (see included Pd files for examples of control and sonification)
37
38 (*) each time you press PRINTSCREEN savecount images will be
39 saved in the current directory in PNG format, with filenames
40 like hypercube-00000000.png, hypercube-00000001.png, etc.
41 Note that the counter restarts from 0000000 each time you
42 restart hypercube, so you might want to move the previously
43 saved images out of the way to avoid overwriting them.
44 These frames can be converted to animated gif using:
45 find *.png -exec convert {} {}.gif \;
46 gifsicle --colors 256 --delay 4 --optimize --loopcount forever \
47 *.png.gif > hypercube.gif