front_idill/extern/fajran-npTuioClient/README.md
changeset 30 45c889eae324
parent 29 fcf435874395
child 31 2c7fc855eba8
equal deleted inserted replaced
29:fcf435874395 30:45c889eae324
     1 npTuioClient
       
     2 ============
       
     3 
       
     4 npTuioClient is a TUIO Client implemented as an NPAPI-based browser
       
     5 plugin. It uses [reacTIVision's](http://reactivision.sourceforge.net/)
       
     6 TUIO Client as a base.
       
     7 
       
     8 The plugin constantly calls a javascript function `tuio_callback`
       
     9 whenever a new touch event arrives. Having this function called, you
       
    10 can start using javascript to manipulate HTML, Canvas, SVG, etc in
       
    11 order to create a multi-touch application!
       
    12 
       
    13 Check the included examples to see how to use this plugin. Check also
       
    14 [TUIOjs](http://github.com/fajran/tuiojs/tree/master) to see more
       
    15 examples.
       
    16 
       
    17 The plugin has been tested and works on
       
    18 
       
    19 * Windows XP: Firefox 3.0.10, Google Chrome 2.0.172.33, and Safari 4.0.
       
    20 * Linux (Ubuntu 8.04): Firefox 3.0.11
       
    21 * Mac OS X 10.4.11: Firefox 3.5rc3 and Safari 4.0
       
    22 
       
    23 It doesn't work on Opera 9.64 on Windows XP nor Internet Explorer.
       
    24 
       
    25 To make the plugin works on Internet Explorer, the plugin has to be
       
    26 ported (or wrapped) to an ActiveX-based plugin first. This is needed
       
    27 since Internet Explorer doesn't support NPAPI-based plugin.
       
    28 
       
    29 Download
       
    30 --------
       
    31 
       
    32 * [Windows](http://cloud.github.com/downloads/fajran/npTuioClient/npTuioClient-0.2-win.zip)
       
    33 * [Linux](http://cloud.github.com/downloads/fajran/npTuioClient/npTuioClient-0.2-linux.tar.gz) (Ubuntu 8.04 i386)
       
    34 * [Mac OS X](http://cloud.github.com/downloads/fajran/npTuioClient/npTuioClient-0.2-mac.zip)
       
    35 
       
    36 Compilation
       
    37 -----------
       
    38 
       
    39 ### Windows
       
    40 
       
    41 Open the Visual C++ project/solution file and build. I use Visual C++
       
    42 2008 Express Edition.
       
    43 
       
    44 ### Linux
       
    45 
       
    46 Go to the project directory and type `make`.
       
    47 
       
    48 ### Mac OS X
       
    49 
       
    50 Open the Xcode project and build. I use Xcode 2.5 under Mac OS X 10.4.11.
       
    51 
       
    52 Installation
       
    53 ------------
       
    54 
       
    55 ### Windows
       
    56 
       
    57 Put the plugin file `npTuioClient.dll` under Firefox'/Mozilla's
       
    58 `plugin` directory. Mine is `C:\Program Files\Mozilla
       
    59 Firefox\Plugins`.
       
    60 
       
    61 If you are using Google Chrome, put the plugin under
       
    62 `C:\Users\<user>\AppData\Local\Google\Chrome\Application\Plugins`. Create the
       
    63 directory if necessary.
       
    64 
       
    65 ### Linux
       
    66 
       
    67 Put the plugin file `npTuioClient.so` under `~/.mozilla/plugins`.
       
    68 
       
    69 ### Mac OS X
       
    70 
       
    71 Put the plugin bundle `npTuioClient.plugin` under `~/Library/Internet Plug-Ins/`.
       
    72 
       
    73 Usage
       
    74 -----
       
    75 
       
    76 Install the plugin, open one of the example files on your browser and
       
    77 start using your multi-touch display!
       
    78 
       
    79 You can open multiple tabs or windows as long as they belong to the
       
    80 same browser instance. The plugin can't be used from multiple browsers
       
    81 at a time. This is because the TUIO Client library can only be started
       
    82 once at a time.
       
    83 
       
    84 Issues
       
    85 ------
       
    86 
       
    87 * Firefox on Mac OS X crashes when the plugin is unloaded (all pages
       
    88   that use the plugin are closed). This doesn't happen on Safari 4.0.
       
    89   
       
    90   TODO: check plugin's shutfown and bundle unloading.
       
    91 
       
    92 * Firefox on Linux can't cleanly close the TUIO connection. So, the
       
    93   browser has to be restarted if the plugin want to be loaded again.
       
    94   
       
    95   TODO: check TUIO Client's stop function.
       
    96 
       
    97 
       
    98