IrisTK

Intelligent Real-time Interactive Systems Toolkit


Installation

Requirements

Using the Installer

To install, you can download and run the basic installer (an exe-file). The installation procedure will ask you in which directory you want IrisTK to be installed. To make life easier, try to avoid paths that include spaces.

If you have problems with the installer, you can also download IrisTK as a zip file. In that case, unzip IrisTK to a folder of your choice. Then open a command window, go to the installation directory, and type:

iristk install

Upgrading from an older version

To upgrade an old version of IrisTK, you can just install the new version in the same location is the old one. This will completely replace the core, addon and apps that comes with IrisTK, but any apps or addons you have created will remain. Note that there might be compatibility issues between your old apps and addons and the updated IrisTK packages. Check the changelog for important changes to the API.

Using the GitHub repository

Instead of using the installer, it is also possible to get the IrisTK repository from GitHub. This allows you to get continuous updates to the code. If you are interested in contributing to the repository, contact Gabriel Skantze.

https://github.com/gabriel-skantze/IrisTK

Remember that if you do this, you also have to run "iristk install" as instructed above, after pulling the repository.

Test

IrisTK comes with two example applications: Chess (speech-only interaction) and Quiz (multi-party interaction with an animated agent). To test the Chess app, open a command window and type:

iristk chess

The app will use the Windows ASR and TTS, which assumes that you are running on an English version of Windows. To test the game, you are advised to use a headset. You can say commands such as "move the pawn that stands in front of the queen", "move the right knight to the left", etc. In case of ambiguity, the system will make clarification requests.

You can also test the game without ASR and TTS, using the keyboard. To do so, start the game with "iristk chess console". To interact with the game, you must first click in the text entry field in the bottom the console panel. Then you can type your command (such as "move the pawn") and press enter.

The quiz app have a few more requirements. For more information on these, see Tutorial 2.

Troubleshoot

If there are any problems during installation, or if the test doesn't work, check the following:

  1. The installation should have created a user environment variable called "IrisTK", pointing it to the root IrisTK folder
  2. The installation should have added %IrisTK% to the user's PATH environment variable
  3. If the Windows ASR and TTS doesn't work, check that you have English-US installed as input language. On Windows 8, it is not enough to change the display language, you also need to download the English-US language pack
  4. If the Face (animated agent) doesn't work, check that you have Microsoft Visual C++ 2010 Redistributable installed

If you don't know how to change or set environment variables in Windows, please check these instructions.

If these things don't help, use the iristk-users mailing list. Try first to search the list for similar problems, and if that doesn't help, you can post your problem there.

Folder structure

The IrisTK installation consists of a set of packages. Each package is self-contained in its own folder, which makes them easy to add or remove (although packages may rely on each other).

The IrisTK installation contains four main folders:

core The core package for IrisTK (no modules for ASR or TTS are included here)
addon Add-on packages that add support for input and output, or any other kinds of extensions to the core.
app Application packages built with IrisTK. Two example applications, "chess" and "quiz" are included. This is a convenient place for new applications.
doc Documentation

Each package folder has the following contents:

package.xml A description of the package
src Java source files
bin Java class files (compiled from src)
lib Java library files (mainly jar files, but also dll:s)

Command-line tool

If you have installed IrisTK properly, you can open a command window and run the iristk.exe tool from anywhere. This is a convenient command to use instead of java.exe, since it provides short names for typical actions and programs, locates the correct Java version and sets the classpath for you. To check which commands iristk.exe provides, simply run "iristk" without any parameters. The set of commands are defined in the "package.xml" files and are thus possible to extend.

Note: If the command you are running needs 32-bit Java (such as Nuance 9), and your Windows is 64-bit, you should use the command "irisk32" instead. However, if you are running 32-bit Java on a 32-bit Windows, you should just use "iristk".

Download IrisTK

Guide to IrisTK


Copyright © Gabriel Skantze, 2013-