~ubuntu-branches/ubuntu/oneiric/toonloop/oneiric

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Jean-Louis Dupond
  • Date: 2011-05-03 10:30:43 UTC
  • mfrom: (2.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20110503103043-4kwpbs1a9o2d7wu0
Tags: 2.0.6-1ubuntu1
* Merge toonloop (2.0.6-1) from Debian unstable (LP: #775588).
* Remaining changes:
  - debian/patches/fix-depend.patch: replace libclutter-gst-0.10-dev with
    libclutter-gst-dev
  - debian/rules: add CPPFLAGS to build correctly

Show diffs side-by-side

added added

removed removed

Lines of Context:
5
5
  |_|\___/ \___/|_| |_|_|\___/ \___/| .__/ 
6
6
                                    |_|    
7
7
 
8
 
Toonloop is a live stop motion animation software. It aims to show the creation process to the audience as well as the result of the creation. The frame by frame animation is made by adding frames one by one to a clip made of many frames. Clips are displayed in a never ending loop. Toonloop can also grab video images continuously.
 
8
Toonloop is a live animation software. It aims to show the creation process to the audience as well as the result of the creation. Frame by frame animation clips can made by adding images one by one. Clips are displayed in a never ending loop. Toonloop can also grab video images continuously.
9
9
 
10
10
Toonloop is a great tool for teaching new medias to children. It can also be used as a professionnal software for movie creators, though it is mainly intended to be used in a live kiosk of show. In the left window, you can see what is seen by the live camera. In the right window, it is the result of the stop motion loop.
11
11
 
12
12
Toonloop can be controlled using MIDI input, or the Open Sound Control protocol. Images are saved to the disk in the JPEG format, and the clips are saved using the photo-JPEG video codec. (using mencoder)
13
13
 
14
 
See the RELEASE file for up-to-date information about this version of Toonloop.
 
14
See the RELEASE file for up-to-date information about this version of Toonloop. See the NEWS file for its history.
15
15
 
16
16
Most of the information on how to use it is in the toonloop(1) man page.
17
17
 
 
18
 
18
19
How to use Toonloop
19
20
-------------------
20
21
 
32
33
Tab                : changes the playback direction
33
34
r                  : clear the current clip
34
35
Caps Lock          : toggle video grabbing
35
 
a                  : Toggles on/off the intervalometer
36
 
k                  : increase intervalometer interval by 1 second
37
 
j                  : decrease intervalometer interval by 1 second
38
36
period             : Toggles the layout
39
 
right              : move writehead to the next image
40
 
left               : move writehead to the previous image
41
 
return             : move writehead to the last image
42
 
semicolon          : move writehead to the first image
 
37
F1                 : show help
 
38
 
 
39
See the toonloop(1) man page, or press F1 for all the key controls.
43
40
 
44
41
Toonloop saves the clip in its project directory. The default project directory is the ~/Documents/toonloop/default/ directory, where "~" is your HOME directory. 
45
42
 
 
43
Versioning
 
44
----------
 
45
 
 
46
Toonloop uses the common "Linux kernel" versioning system, where even-numbered minor versions are stable and odd-numbered minor versions are development snapshots.
 
47
 
 
48
The micro version indicates the origin of the release: even micro numbers are only used for released archives; odd micro numbers are only used on the Git repository.
 
49
 
 
50
A stable series means that the command-line options and the interactive keyboard controls should not change much for all tags whose version number start with the same major-minor numbers. Some new features might be developped in that branch, but each release should be backward-compatible with their ancestor. Releases from a stable series should be use for production. 
 
51
 
 
52
In contrast, unstable branches consist of tags which are developer snapshots. They are not expected to be compatible with any other version. Some features might change between different stable branches.
 
53
 
 
54
 
 
55
Known Bugs
 
56
----------
 
57
 
 
58
Here is a list of known bugs. See also the TODO file. That is what we mainly use to manage issues, rather than a Web application. Please read and write on the mailing list if you encounter some issues with Toonloop.
 
59
 
 
60
 * The portrait layout doesn't look nice: both images overlap when not in 4:3 ratio.
 
61
 
46
62
 
47
63
Basic Tools for Compiling
48
64
-------------------------
67
83
 
68
84
 ffmpeg,
69
85
 gettext,
70
 
 gstreamer0.10-alsa,
71
86
 gstreamer0.10-ffmpeg,
72
87
 gstreamer0.10-plugins-bad,
73
88
 gstreamer0.10-plugins-base,
74
89
 gstreamer0.10-plugins-good,
75
90
 gstreamer0.10-plugins-ugly (>= 0.10.14),
76
 
 gstreamer0.10-pulseaudio,
77
91
 gstreamer0.10-x,
78
92
 help2man,
79
93
 libasound-dev,
85
99
 libboost-system-dev,
86
100
 liblo-dev,
87
101
 libclutter-1.0-dev,
88
 
 libclutter-gst-0.10-dev,
 
102
 libclutter-gst-dev,
89
103
 libclutter-gtk-0.10-dev,
90
104
 libglew1.5-dev,
91
105
 libglib2.0-dev,
98
112
 libxv-dev,
99
113
 mencoder
100
114
 
101
 
The packages listed below are not used yet, but we plan to use them 
102
 
soon.
103
 
 
104
 
 libxml++2.6-2,
105
 
 libxml++2.6-dev,
106
115
 
107
116
How to build Toonloop
108
117
---------------------
114
123
 
115
124
There is also the handy ./one_click_build.sh that does it in a single script. (except the `sudo make install`)
116
125
 
 
126
If you want to install the bash completion script, you should set the sysconfdir command-line option given to ./configure to "/etc". Here is an example:
 
127
 
 
128
 ./configure --sysconfdir=/etc
 
129
 
 
130
Be warned that the command above would overwrite the default Toonloop config files installed by your package manager, if any. 
117
131
 
118
132
How to run Toonloop
119
133
-------------------