Skip to content

Home

Jump to bottom Edit New page
Valentin Simonov edited this page Jan 26, 2016 · 38 revisions

TouchScript — multitouch library for Unity

TouchScript is a multitouch library for Unity. Inspired by iOS, TouchScript makes handling complex gesture interactions on any touch surface much easier.

Warning! Please read before upgrading.
Please ask all questions on the Forum.

Features

  • Supports many touch input methods starting from smartphones to giant touch surfaces: Windows 7/8 touch, mobile (iOS, Android, Windows Store/Windows Phone), TUIO, mouse.
  • Abstracts touch and gesture logic from input methods and platforms. Your touch-related code will be the same everywhere.
  • Manages simultaneous gesture recognition within scene hierarchy.
  • Is infinitely extensible. You can add custom input methods, gestures and hit test logic in a matter of minutes.
  • Comes with many commonly used gestures.
  • Supports all available platforms.
  • Highly efficient and optimized.
  • Has very easy and intuitive API.
  • Uses events in C# and SendMessage in UnityScript.
  • Takes into account DPI differences between a large touch surface and an iPad.
  • Comes with many examples and is heavily documented.
  • Groups touch points into clusters on big touch surfaces.
  • Easy to test multitouch gestures without actual multitouch device using built-in second touch simulator (activated with ALT+CLICK), TUIOPad on iOS or TUIODroid on Android. Read more.
  • It's free and open-source. Licensed under MIT license.

Developed by Valentin Simonov.

Getting started

The library comes as a Unity project. The best way to install it is to download the latest version from Releases on Github or from Asset Store. If you want to work with the source make sure to read this first.

If you want to test multi-touch examples but don't have a touch enabled device, here is how you can do it.

  • Upgrading Guide
    Please read this document if you are upgrading from an earlier version of TouchScript.
  • Examples
    Learn how to use TouchScript and its various features.
  • TouchScript Internals
    If you want to know more about how TouchScript is structured and how to extend it you can read all about it here.

Need help?

If you got a problem using TouchScript or running examples please check the FAQ before submitting issues.

  • FAQ
    Some of the questions have been already asked multiple times. Check if yours is in the list.
  • Documentation
    Complete up-to-date generated docs with all public API annotated.
  • Official Forum
    Want to ask a question about TouchScript? Use the official Forum.
  • Issues
    Found a bug? Got a feature request? Feel free to post it in Issues.

TOC

How to contribute?

TouchScript is an open source project, like all the other open source projects out there it needs your support!
You can contribute in several ways:

  • Fix bugs in code — if you found a bug and know how to fix it, it will be very helpful for the project if you fixed it and submitted a pull request;
  • Add features — if you need a specific feature for your project and think that it could be useful for others, feel free to submit a pull request;
  • Write tutorials — if you are not a developer or are not experienced enough to read TouchScript's code, you can still help by updating the docs and writing tutorials. Because good documentation is what makes an open source project alive;
  • Test it on devices — TouchScript can be used on various devices but we don't have all of them nor we have time to test the library everywhere, so we would be really glad if you could run examples or test your project using TouchScript on devices you have.

If you want to contribute to TouchScript please read this document.

Add a custom footer
Add a custom sidebar

Clone this wiki locally