XMod Beta 0.3b Readme

** This package is not for general distribution **

This is only a test build of the plugin XMod. If you choose to install this beta, instead of waiting
for the fully tested product, then any risks to you and your computer lie solely with you. I won't be
held responsible for any damage caused to your system by you installing and running this plugin for
the game Vampire:TM Redemption.

There is no installer in this version as this is a internal test of our plugin, so if you have this,
you should be able to install and uninstall this plugin. If you have recieved this and you are not 
a beta tester for this mod, we advise that you check the vampire web sites, looking for the public 
version. This will have an installer, and contain fixes to any bugs, and will have been tested on 
many more configurations and setups of the game.



To install and run:

Just unzip to your vampire directory, then to run vampire with this mod, create a short cut for vampire
(by right clicking on vampire.exe and selecting create shortcut) and then right clicking on the new 
shortcut icon and right clicking on it then selecting properties and adding '-user XMod' to the end of 
the target string after the last speech mark, remembering to add a space before the -user and not 
including the ' at the start or finish of -user XMod. If you can`t do that, you shouldn`t have this
beta test ;).



Updates/News:
-------------

Add script for sitting, 2 inital chairs are tested, Allesandro`s Chair, and RedChair (both end in X).
Player nms files changed, added Special25 to each standard mulptiplayer model montion set and referenced 
Allesandros sitting animation. This isn`t perfect but we can sit (sort of) for now. Advise only using
Allesandro`s Chair for now.






Problems:
---------

Sitting in red chair is too low...see ThingsToDo

Can get distracted on way to chair. If you never collide with the chair, it is left vacant, so that
isn`t a problem, but if you collide with the chair, and then run off, the chair pulls you back. Maybe
it should just wait so long for you to get to the chair and then give up and release you and free the
chair.

*FIXED* Sometimes the sit animation slows down, or goes too quickly, and the timer misses the sit action pause.
We really need to be able to use the endtag callback on motion playback, but as of yet, I am unsure how
this works. For now we use EndPause, and force a standmotion to return the character to his normal 
position. With a custom sit animation, we could cause a KeyTag callback into script when we are in
the sitting position. This would work much better than using timers. *FIXED*

 The above problem has been worked around, and now you always finish the sit in the correct position. It
is only a work around, and not the best solution, but until the endtag callback works, there is nothing
I can do. It looks okay for now anyway, there are other more important things to do.

Possibly things could be bad if you quit, or the server quits in multiplayer while sitting down..you 
might be stuck sitting down for life!! Needs testing! (Along with spells..effects on a sitting player). For
the moment, a player is invunerable to any kind of attack, this will be changed in the future, but is just
there to stop things like you dying in the chair and things that could mess up the chair script.

The female characters and probably the ghoul character look very odd when they sit, the females have their
arms out wide, and heads rotated in a stange kind of the exorcist kind of way. This would be fix by a correct
anim for female characters.



ThingsToDo:
-----------

Making the sit down motion smoother, turning the player around rather than just jumping him, and
making the stand up action more visible. This should probably be down with frames, but I`m not 100%
sure how to use these yet, but they should work (and this may fix the wandering off problem).

Need real sit animations for atleast all player characters, would be nice to be able to seat npc`s
too, but mostly less important than the players. This gets rid of most of the problems with the
players model looking funny as they are seated (maybe we could lose the cape somehow?).

Check to see what happens upon summoned to a place by the st, save and load when you are sitting
in a chair, or a begin scene/end scene is activated when your sitting down.

When we have correct sitting animations, need to position player in chair better, this is already
in place, but we probably need different scripts for different chairs, or maybe there is a way to
have or use a custom tag to set the set bottom height to pass for higher/lower seats. This would be
better than having a script for every type of chair!

Sofas, this can be easy added, as you would divide the sofa up into X chair seats, and leave the sofa
clickable till it`s full. This follows on from the last todo thing.

Yibble suggested adding a mouse chair cursor when you go to sit down, kinda like the talk icon. Not sure
if we could do this, but I bet someone could be pestered at NSI to add that in the next patch, if we can`t 
change the cursor from the script!






Please do not modify, disassemble, reassemble any source or redistribute this package in anyway
without my permission. 

If you alter the script to make it better, please send it me, and explain what you have done. You 
probably should check that the script hasn`t already been updated, and that I haven`t already 
changed what you have :). I`m releasing this in good faith that there won`t be 50 different chair
scripts floating around...it would cause some serious trouble, with client/server problems occuring
with different scripts.


Bug reports from recogonised beta testers only to flay_sepulcrast@libertysurf.co.uk.



Dave Newton (AKA Flay_Sepulcrast)