# TWScript

TWScript is a collection of script modules for Thief 2. These scripts are provided under the terms of the GNU GPL v2, a full copy of which may be found in the LICENSE file in the distribution directory, along with other license information.

TWScript would not be possible without the Public Scripts package released by Telliamed (Tom N. Harris), and I would like to express my sincere thanks for his generous contribution to the community.

I'd also like to thank LarryG for his suggestions, patience, feedback, and willingness to be a guinea-pig.

## Installing

In order to use TWScript with missions, it must be made available to Thief 2 in a location it recognises.

Players can place the .osm in the Thief 2 directory and, if it is not provided with a mission, Thief 2 will use that version.

For editors, the simplest method to include TWScript is to place the .osm in your mission's directory inside the Thief2\FMs\ directory, and use FMSel to select your mission when editing it. When you distribute your mission you can simply zip up your mission directory and distribute that.1

## How to find out which version you have

It's not immediately obvious to the end user which version of the twscript.osm you may have installed. Luckily, there is a way to find out: follow the steps in CheckingVersion.html if you need to work out which version is present.

## Documentation

The documentation for the scripts consists of a number of files in addition to this one:

- Changes.html documents the changes made at each release.
- DesignNote.html describes the way in which the parameters for the scripts are specified in Dromed's `Editor -> Design Note` property.
- TWBaseTrap.html describes the standard parameters available to all TWTrap scripts. If you have used NVScript, many of these will be familiar to you.
- The remaining HTML files describe each of the script modules and the parameters they suppport.

Currently available scripts are:

- TWTrapSetSpeed.html
- TWTrapPhysStateCtrl.html

## Development information

Currently planned scripts for future versions of TWScript include:

- A `TWTweqSmooth` script to support more flexible ease-in and ease-out on joint tweqs.
- A `TWTriggerRequireMessages` script that will send a `TurnOn` when it has recieved a set of messages, and `TurnOff` when it recieves a different set.

## The source

The source code for TWScript, including supporting files and instructions for building the scripts is available at github:

https://github.com/TheWatcher/twscript

1. Note that doing this does have the downside that the version of the osm included with your mission will not get any bugfixes or updates unless you repackage your mission. Another, albeit less reliable, method is to simply state that players must install the .osm in their Thief2 directory - but if you do that, expect to run into problems if players do not follow the instructions! ↩

Version 2.0 Alpha (Blackfriars)