README

PyMT - A Multitouch Framework for Python
========================================

Website: http://pymt.txzone.net/
Planet: http://pymt.txzone.net/planet/


About 0.4
---------

This is beta, so keep in mind that it might not work as intended at all times.
You can post bug reports and feature requests on our Google Project page :

  http://code.google.com/p/pymt/issues/list

If you need more help, you can discuss on mailing list :

  * Google Group : http://groups.google.com/group/pymt-dev
  * Email        : pymt-dev@googlegroups.com

We also have an IRC channel :

  * Server  : irc.freenode.net
  * Channel : #pymt


Introduction
------------

PyMT is a python module for developing multi-touch enabled media rich
applications. Currently the aim is to allow for quick and easy interaction
design and rapid prototype development.

PyMT is written in python, based on OpenGL and supports different input methods
like Mouse, Dual Mouse, TUIO, WiiMote, WM_TOUCH, etc.

PyMT is actively being developed by a community and free to use. It operates on
all major platforms (Linux, OSX, Windows).


Installation
------------

Depending on your operating system you can follow one of the following guides
to install PyMT and the dependencies:

 * http://pymt.txzone.net/wiki/index.php/DevGuide/InstallPymtUbuntu
 * http://pymt.txzone.net/wiki/index.php/DevGuide/InstallPymtMacOSX
 * http://pymt.txzone.net/wiki/index.php/DevGuide/InstallPymtWindows

If you chose to install all the dependencies (see below) yourself, you can invoke
the setup script as follows to install pymt systemwide for python:

  python setup.py install


Dependencies
------------

Since we abstract from the libraries that we use, some dependencies are
optional and may be used instead of others. A list of dependencies and what
we use them for is http://pymt.txzone.net/wiki/index.php/Devel/FeaturesByLibraries

Here is what works best:

  * python (>= 2.6, < 3.0) - http://python.org
  * PyOpenGL
  * Pygame
  * PIL
  * GST + PyGST


Dcoumentation, Examples & Tutorials
-----------------------------------

There is an API reference included in doc. Check the doc/README about how
to build the documentation. It's also available online at :

	http://pymt.txzone.net/docs/api/

There is some simple example apps in the examples folder that should get
you started for now. Additionally you may want to take a look at our wiki
at :

	http://pymt.txzone.net/wiki/


Configuration
-------------

  [pymt]

  # show/hide fps
  show_fps = (0|1)

  # display event stats at end
  show_eventstats = (0|1)

  # set log level
  log_level = (debug|info|warning|error|critical)

  # detection time of double tap (in milliseconds)
  double_tap_time = <integer>

  # max distance allowed for double tap
  double_tap_distance = <integer>

  # detection time of retain touch (in milliseconds)
  retain_time = <integer>

  # max distance allowed for retain touch
  retain_distance = <integer>

  # log directory
  log_dir = <string>

  # log name (can use format string from strftime)
  log_name = <string>

  # activate logging on file
  log_enable = (0|1)

  # fix ccv bug when touch go outside 0-1 coordinates
  fixccv = (0|1)

  # GL error check (disable to have more speed)
  gl_error_check = (0|1)

  # INTERNAL, NEVER TOUCH TO config_version !!
  config_version = <integer>

  [keyboard]

  # default layout of keyboard
  layout = (azerty|qwerty)

  [graphics]

  # activate fullscreen
  fullscreen = (0|1)

  # width of window
  width = <integer>

  # height of window
  height = <integer>

  # force vsync
  vsync = (0|1)

  # force fbo type
  fbo = (hardware|software|force-hardware)

  # opengl line smooth
  line_smooth = (0|1)

  # ignore list
  ignore = [(xmin, ymin, xmax, ymax), ...]

  # show cursor on fullscreen
  show_cursor = (0|1)

  [input]

  # example of input provider instance
  yourid = providerid,parameters

  # example for tuio provider
  default = tuio,127.0.0.1:3333
  mytable = tuio,192.168.0.1:3334

  [dump]

  # activate record of frames
  enabled = (0|1)

  # prefix to use for dump
  prefix = <string>

  # format of dump image
  format = <jpeg|png>

  [modules]

  # modulename= to activate a module
  # you can have a list of module with :
  # python example.py -m list
  # example:
  keybinding=
  closeapp=
  feedback=



Other python/MT resources
-------------------------

nuigroup.com
^^^^^^^^^^^^

THE resource and research community for open source multi touch and other
natural user interfaces.