Thief 2 - Small Gas Lamp v2
---------------------------

This gas lamp is an alternative to the gas lamps supplied with Thief 2
and it should fit mansion missions rather better than the original. The
lamp itself is intended to look somewhat like the lamps in Undying
while having rather lower polycounts than the Undying object. It 
functions exactly like a standard gaslight and should act as a drop-in
replacement.


Contents
--------

This archive should contain the following files:

readme.txt                  - this file
bitmap/corball.tga          - corona graphic
       txt/corball.tga      - see bug 1
       txt16/corball.tga    - see bug 1
obj/smallgas.bin            - object file
    txt16/twgldet.gif       - burner texture  
          twgldet.gif       - tube and base texture
          wgasgl.gif        - glass texture
src/smallgas.lwo            - source lightwave object
    smallgas.E              - slightly edited .e file

The contents of the src folder are not required to use this object,
if you are not interested in the source objects, ignore the src 
directory.


Installing
----------

Unpack the archive somewhere, then copy the bitmap and obj directories
into your Thief2 directory. In theory, nothing should be overwritten,
if there is a name clash, contact me at the addess below!

Now start dromed. To use the object you'll have to modify your 
gamesys:

 1. Open the Object Hierarchy (Editors menu)
 2. Open SFX -> FireFX -> FireParticleFX -> TorchFX -> TorchFlameYellow
 3. Select TorchFlameYellow
 4. Click Add
       New Object Name: SmallGasFlame
       Click OK
 5. Select SmallGasFlame
 6. Click Edit
 7. Add: SFX -> Particles
       Size of particle: 0.10
       Leave all other settings as they are
       Click OK
 8. Click Done
 9. Open Physical -> Lights -> Extinguishable
10. Select Extinguishable  [see note 1]
11. Click Add 
       New Object Name: SmallGasLight
       Click OK
12. Select SmallGasLight
13. Click Edit
14. Add: Engine Features -> FrobInfo
       World Action: Script
       Inv Action: None
       Tool Action: None
       Click OK
15. Add: Renderer -> Corona
       Radius up close: 1.00
       Radius at max dist: 4.00
       Max dist visible: 40.0
       Alpha: 0.6
       Texture: corball.tga
       Click OK
16. Add: Renderer -> Light Color
       hue: 0.10
       saturation: 0.30
       Click OK
17. Add: Shape -> Model Name
       smallgas
       Click OK
18. Add: Tweq -> Models
       Halt: Continue
       AnimC: NoLimit
       MiscC: Anchor, Random
       rate: 125
       Model 0: smallgas
       Model 1:
       Model 2:
       Model 3:
       Model 4:
       Model 5: smallgas
       Click OK
19. Add: S -> Scripts
       Script 0: GasLight
       Script 1:
       Script 2:
       Script 3:
       Set Do Not Inherit to ticked
       Click OK
20. Add: Links -> ~ParticleAttachment
       Add
           Flavour: ~ParticleAttachment
           From: SmallGasLight
           To: SmallGasFlame
       Select Link
       Data
           Type: Vhot
           vhot #: 3
           Click OK
       Click OK
       Click OK  [see note 2]
21. Add: A -> AmbientHacked
       Radius: 12
       Override Volume: 0
       Flags: None
       Schema Name: gaslight_lp
       Click OK
22. Click Done
23. Click Close

Now save your gamesys (don't overwrite dark.mis!). If you were not using
a custom gamesys before, remember to use set_gamesys and save your .mis

[1] Do not add the gaslight to the existing gaslight hierarchy. If you do
    it will inherit gaslight's particleattachment link. It'd save a bit
    of work if it was possible to extend gaslight, but I'm not sure
    if it'd work properly...
[2] The link dialog needs OK clicked twice. I guess this is a Feature.


Known Bugs
----------

1. the corona texture is provided in triplicate. I could never get it to
   work reliably with the texture in just one place. If anyone knows
   The Secret to make this work, please tell me.
2. When the light has been extinguished and then relit the particle effect
   splutters. No idea why because, other than its size, it uses the standard 
   settings O.o


Contact Information
-------------------

Author: Chris <chris@starforge.co.uk>
The Watcher on the ttlg forums.

Email or PM me if you have problems, want an enhancement or find this 
useful :)


Thanks
------

Thanks go to Yandros and Eshaktaar for their help, without it this model
wouldn't be usable!


Legal Blurb
-----------

This object and the associated original graphics are copyright (c) 2004 
Chris Page and released under the Creative Commons Attribution-ShareAlike
License. To view a copy of this license, visit 

http://creativecommons.org/licenses/by-sa/1.0/ 

or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, 
California 94305, USA.

Essentially this means you can do what you want with it as long as you
include credit and don't try to prevent anyone else from using it or
any derivative of it.
