PyMT - A Multitouch UI Toolkit for Pyglet
=========================================

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


About 0.3.1
-----------

This is beta, so keep in mind that it might not work as intended at all times.
You can post bug reports, feature requests on 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 have also 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 pyglet toolkit.


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

Run the setup script as follows to install pymt systemwide for python:

  python setup.py install


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

  * python (>= 2.5, < 3.0) - http://python.org
  * pyglet (== 1.1.2) - http://www.pyglet.org
  * csound (audio, optional) - http://www.csound.com
  * ounk (audio, optional) - http://code.google.com/p/ounk/
  * avbin (video, optional) - http://code.google.com/p/avbin/


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

There is an API reference included in doc/build/html/.
There is some simple example apps in the examples folder that should get
you started for now.

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
  double_tap_time = <integer>

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

  [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)

  # display number (use -1 for current display)
  display = <integer>

  # opengl line smooth
  line_smooth = (0|1)

  # opengl polygon smooth (1 can lead to artifac)
  polygon_smooth = (0|1)

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

  [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:
  closeapp=
  feedback=



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

pyglet.org
^^^^^^^^^^

PyMT is for use with pyglet only at the moment. It provides MT events in
a way that is consistent to other pyglet events (the pyglet team has a
great section about their event system in their documentaion)

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

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