-------------------
GENERAL INFORMATION
-------------------

Authors:  Joseph 'Jackrabbit' James Jacklin Jr.
Email:  quadj130@gmail.com
Website:  http://www.UDHQ.org
Last Update:  3/21/14
Archive Filename:  UBS.zip
Modification Filename:  UBS.u
Modification Size:  272KB
Version:  Beta
Build Number:  1.0


------------------------
MODIFICATION INFORMATION
------------------------

Botmatch:  No
Teamplay:  Yes
Single Player:  Yes
Multiplayer:  Yes.
Difficulty:  None
Dependencies:  None
New Textures:  No
New Sounds:  No
New Music:  No
New Weapons:  No
New UnrealScript:  Yes
New Meshes:  No
External DLLs:  None


-------------------------
COMPATIBILITY INFORMATION
-------------------------

Direct3D:  Yes
OpenGL:  Yes
Glide:  Yes
3DFX:  Yes
Software Rendering:  Yes

------------
CONSTRUCTION
------------

Build Time:  ~1 month coding/testing
Editors Used:  Unreal Gold Editor


------------
INSTALLATION
------------

ZIP/GZIP/TGZ/TAR/GZ (Universal):

Unzip UBS.zip by following the guide below. Make sure you choose the correct guide corresponding to your game(s).

Guide (Unreal, Unreal II, XMP, UT, UT2003, UT2004, UER & UE2R):
*.unr, *.un2, *.ut2, *.uer and *.ur2 files go in Maps\
*.utx files go in Textures\
*.umx, *.con and *.ogg files go in Music\
*.uax files go in Sounds\
*.u, *.ucl, *.int and *.ini files go in System\

-----------
DESCRIPTION
-----------

Unreal Buddy System is a mod which currently allows for one Male companion to fight along side you in any
stock/custom map(s).  This mod was inspired by the companion system in Fallout 3 and Fallout: New Vegas.
Without those games this mod would not exist.  


-----
USAGE
-----

-Hit the tab or ~ key to open console and type "summon ubs.maletwobuddy"
-Mutator is "UBS.UBSMut".  You either can use the "open nyleve?mutator=ubs.ubsmut" command in tab or the "add mutator" menu.
  it uses a custom HUD called BuddyHUD.  Not Required.

-all commands can be send to the buddy via the "say" command the (press t to talk) button

List of Commands:
=================

"say Wait Here" - tells the Buddy to wait at the current spot until you tell him to follow again
"say Follow Me" 
"say Teleport to me"
"say ThrowWeapon" - buddy will throw out his current weapon
"say Use <Weapon>" - buddy will switch to this weapon (if he has it) and sets it as his new "favorite weapon" Example: "say use ASMD"
"say Give <Ammo>" - Gives the buddy ammo from your own inventory only if you have it first.
"say Give <Armor/Suit/ShieldBelt>" - Takes the current charge of the same item in your inventory removes it and gives it to your Buddy.

cheats:
"say God" - cheat: god mode. can toggle on/off
"say AllAmmo" - cheat: infinite ammo for all weapons
"say AllWeapons" - cheat: spawns all default unreal 1 weapons for your buddy



-----
NOTES
-----

-Unreal's stock bot/scriptedpawn AI isn't really all that badly scripted afterall...
 Thanks Steve Polge!

-If your buddy gets you stuck in a corner for whatever reason and you can't escape,
 switch to your DispersionPistol and shoot him once to turn him around and get out of the
 way to set you free :)

-Buddies will automatically collect nearby reachable inventory while in their Waiting state.


-------
TESTERS
-------

Just me so far.


-------
CREDITS
-------

Just me so far.


---------
CHANGELOG
---------
3/21/14:
+ Network Support
^ Enhanced 'Roaming' state code.  Better pathfinding support
+ Added a new BuddyHUD which can be toggled on with the UBS Mutator.
  Features: Displays all your buddies weapons ammo and health on your HUD only when you look directly at him (with fade time).
+ UBS.ini with configurable "GiveBuddyItem" array, "StartupHealth" and "FavoriteWeapon" for when you first spawn your Buddy.
+ New RateWeapon() function which will tell the Buddy to overwrite the use of his "favorite weapon" in certain cases. 
* Countless scriptwarning, infinite loop recursions, access nones and other nasty bugs including animation issues.

2/27/14:
^ Changed overall Buddy AI functionality in the Tactical, Charging and Hunting states to better suite fighting Unreal's Scripted Pawns.
+ Buddies now dodge enemy projectiles and can actually fight Titans now :)
+ A New Inventory item "Buddy Armor" is automatically spawned which will teleport him out of harms way when he falls into any damage zone.   


2/25/14:
! Buddies can keep picking up health packs in levels without reaching a MaxHealth.  A buddies health also travels between levels. 
  Default HP value is still 200.  Adjusted for harder difficulties and/or harder campaigns with extra health packs.
+ Buddies now do a trace to their Target/Enemy before they fire their weapon to see if their Master is in the way before they shoot.
  It doesn't work 100%, but it's pretty damn close.


2/22/14:

+ Added Wandering state for Buddies that have no Master set yet.  This means mappers can now place buddies in their map without any issues.
! You can now directly summon "UBS.MaleTwoBuddy" to get your buddy instead of summoning the inventory item first.  Either way works though.
! JumpFromWallAdjust has been tested more thoroughly and now is a Byte datatype instead of a Bool.
* Some random access-nones.  Still more to deal with though.
! Buddies don't shoot Nali anymore.
* If your Buddy dies, you can now replace him without issues.
+ Added mutator UBS.UBSMut as per requested by Dr.Flay.  Hasn't been tested in mutator menu of UT99 yet as I don't have a working copy.

2/20/14:

! Buddies will now teleport to the player when they missed a lift ride.
* Fixed obscure telefrags when Buddies setLocation to their master in special cases.
+ Added "StuckAtWallLoc" vector to speed up teleporting to a player when a buddy gets stuck at a wall.
+ Added "bJumpFromWallAdjust" (experimental) to prevent infinite wall adjust loops with also
  the added benefit of a Buddy "unstucking" himself in many cases.  *Further testing required*

----------------
CHANGELOG LEGEND
----------------

* Fixed
+ New
- Deleted
! Changed
@ Renamed
# Restored
^ Remastered


-----------
PERMISSIONS
-----------

YOU MAY use this modification as a base with my explicit permission.

YOU MAY NOT put this modification on a commercial CD/DVD/Blu-Ray/HVD/Floppy/ZIP Disk/Storage Cassette/USB Thumb Drive/Memory Card without Epic Games, Inc. permission!

YOU MAY convert this modification to another game other than Unreal/Unreal Tournament/Gears of War/Unreal Development Kit without my explicit permission.

YOU MAY NOT bundle this modification in your mod without my explicit permission.


---------
COPYRIGHT
---------

UnrealBuddySystem is Copyright  2014 by Jackrabbit.


------------
LEGAL NOTICE
------------

Unreal, Unreal: Return To NaPali Mission Pack and Unreal: Gold Edition  1998-2003, 2006, 2008 Epic MegaGames, Inc. and Digital Extremes.  All Rights Reserved.  Published by GT Interactive Software, Inc., Infogrames, Inc. and Atari, Inc. under license.  Distributed by Valve, Stardock and GOG.com.  Unreal, UnrealEd and the Unreal logo are registered trademarks of Epic MegaGames, Inc.  All other trademarks and trade names are properties of their respective owners.

