RKTR2Beacons by RoadKill
Readme v0.58

Install
=======
  Requires support.vl2

  Just drop RkTR2Beacons.vl2 into your GameData/Base directory!


No Beacons Left Alert
=====================

   The only feature you cannot turn off, this will audibly alert you when you place your last beacon and if you try to place a beacon with none in your inventory.
   

Spawn Announce
==============

   This feature will announce the number of beacons in your inventory every time you get up from a knockdown.

   Enabled  - Announces beacon inventory on knockdown recovery
   Disabled - Announces beacon inventory only after placing a beacon

   Pref variables
      Spawn Announce feature toggle
      $pref::RkTR2Beacons::spawnAnnounce
      default = true (enabled)


Status Announce
===============

   This feature utters the beacon inventory amount upon every depress of the beacon key.

   Enabled  - Announces beacon inventory on each beacon key press
   Disabled - Does not announce beacon inventory on each beacon key press

   Pref variables
      Status Announce feature toggle
         $pref::RkTR2Beacons::statusAnnounce 
         default = false (disabled)

      Min time between utterances
         $pref::RkTR2Beacons::spamDelta
         default = 500ms


Multi-Beacon Protection
=======================

   This handy feature keeps you from placing more than one beacon by accident. Note that this is ping dependent, but reliable.

   Enabled  - Protects against placing multiple beacons rapidly
   Disabled - Does not protect against placing multiple beacons rapidly

   Pref variables
      Multi-Beacon Protection feature toggle
         $pref::RkTR2Beacons::multiBeaconProtection
         default = true (enabled)

      Window of time after successfully placing a beacon where you cannot place a beacon
         $pref::RkTR2Beacons::multiBeaconProtectionDelta
         default = 1000ms


Auto-Beacon
===========

   This feature will attempt to place a beacon, until successful, while holding down the beacon key. Note, this function is also ping dependent.

   Enabled - Attempts to deploy a beacon while the beacon key is held
   Disabled - Attempts only one beacon deploy per beacon key press

   Pref variables
      Auto-Beacon feature Toggle
         $pref::RkTR2Beacons::autoBeacon
         default = false (disabled)

      Delay to wait before trying to place another beacon
         $pref::RkTR2Beacons::autoBeaconDelta
         default = 50ms


TR2 Only
========

   Allow the script to function only under TR2, or for all game types.

   Enabled - Script active only for TR2
   Disabled - Script active for all game types

   Pref variables
      TR2 Only feature toggle
         $pref::RkTR2Beacons::TR2Only
         default = true (enabled)


Mute Beacon Text
================

   Mutes the 'Cannot place beacon' text. Auto-enabled with Auto-Beacon.

   Enabled - Mute 'Cannot place beacon' text
   Disabled - Does not mute the beacon spam

   Pref Variables
      Mute Beacon Text feature toggle
         $pref::RkTR2Beacons::muteText
         default = true (enabled)

      Min time between 'Cannot place beacon' messages
         $pref::RkTR2Beacons::muteTextDelta
         default = -1 (never display, other valid values are time in ms)


--end--
