==============================================================================
FILE
==============================================================================

Name    - Double Doppler's Arma 2 Taser Mod
Date    - 23/2/2013
Author  - Double Doppler (D.Doppler)
Contact - doubledoppler@live.co.uk
Version - 1.1 (Initial Release)

Copyright © 2013 Double Doppler

Visit www.youtube.com/user/TheDoubledoppler for more fantastic addons on Arma 2 and GTA IV!

==============================================================================
DESCRIPTION:
==============================================================================

Created and tested on Arma 2 Operation Arrowhead and Combined Operations v1.62
and over. Not intended for stock Arma 2 nor tested on it.

All content provided for this addon is purpose built from scratch by the author.
Designed with Life Missions/RP Mods in mind, so you no longer have to use those
Makarov 'Stun pistols'...

--------------------
Features:
--------------------

- Highly detailed and accurate 3D Models, Textures and Materials, created from
  scratch for this mod and optimized for the Arma 2 game engine.
  (No ports from other games or conversions.)

- Complete configuration. All included weapons feature native animations and most
  features that the stock weapons have. (Gear icons, working gunsights etc.)

- Realistic ammo and range for each weapon. Drive-Stun option available on handheld
  Taser models.

- Ability to incapacitate a player/unit for 30 seconds.

- Each Taser is equipped with a flashlight, as an additional policing feature.

- Red-dot cursor replacement for Tasers, to simulate aiming recticule.

- Extra media and custom special effects features - pain screens, Taser shot sparks
  and sound effects.

- Flexible Taser scripts, designed to have minimal conflict with most Life Missions.
  Scripts compatible and tested in Multi-Player with a full RP community server.
  (Comes with a userconfig file, to define your own configuration values.)

- Scripts are designed to work in all environments, on AI and human players in both
  single-player and multi-player.

- Minimal latency and load on the multiplayer dedicated-server enviroment.

- Addon files signed with the V2 signatures and server-ready, with included .bisign
  and .bikey files.

--------------------
Classnames:
--------------------

Taser X26 (Yellow)     - DDOPP_X26
Taser X26 (Black)      - DDOPP_X26_b
Taser X26 (Cartridge)  - DDOPP_1Rnd_X26

Taser X3 (Yellow)      - DDOPP_X3
Taser X3 (Black)       - DDOPP_X3_b
Taser X3 (Cartridge)   - DDOPP_3Rnd_X3

Initialization Logic   - DDOPP_TaserInit

==============================================================================
CHANGELOG:
==============================================================================

v1.1 (23 February 2013)

- Added Taser weapons/ammo box. (Editor: Empty > Ammo > Taser Box.)

- Fixed restrain bug. (Victim seemed to "ignore" restrain and reverted to normal
  animation after the stun effects were over. Animation strings are CASE SENSITIVE.)

v1.0 (17 February 2013)

- Initial public release.

==============================================================================
INSTALLATION:
==============================================================================

1. Copy the following included folders: @DDOPP_Taser and Keys to your Arma 2/OA
   folder. (CO uses Arma 2.)

2. Right click the shortcut* you use to launch Arma 2 with and select "properties"
   from the menu.

3. In the properties window, highlight the 'Target' text box and at the end of
   the directory reference (included in the double quotes ""), add the line:

   -mod=@DDOPP_Taser

*If you are installing this addon on a dedicated server, your admin remote access
 software might not give access to the shortcut (esp. if using TCAdmin), but allows
 you to add command lines to it. If it is easier, use this feature instead to carry
 out step 2 and 3.

--------------------
Server Admins:
--------------------

Make sure that the "Keys" folder was moved into your servers Arma 2 folder, this is
very IMPORTANT if you dont want players getting kicked all the time when they already
have valid signatures.

Any edits you make to the "Userconfig" folder for your server must be redistributed in your
Mod Pack so that the players will notice these effects as well.

~ You may edit the scripts and comment out the external userconfig reference or to change
  the path and redistribute in YOUR server's Mod Pack only if this makes it easier.
  (To do this you must open then repack the PBO with your edits etc.)

--------------------
IMPORTANT
--------------------

To make use of the Taser fully you must install the scripts in the mission you will use it
on or join a server that uses the mod with the scripts already setup.

If the scripts aren't setup, you will notice no effect when the Taser is fired.

~ The Userconfig installation is REQUIRED for the addon to work correctly, otherwise your
  game will crash. You may edit the PBO and repath/disable this feature/initialize the variables
  inside the scripts instead if that makes it easier for your server's mod pack.

~ If you are editing the PBO you might need to resign it again to make it work with your server.
  (Use your own server keys.)

==============================================================================
INSTALLING THE SCRIPTS
==============================================================================

The scripts included are optional, however it is recommended that you do enable them
if you want full functionality from the mod. The scripts have been designed to intergrate
into most missions and will have minimal effect on performance and latency.

To initialize the included scripts:

1. Add the initialization logic to your mission, found under:

   Side  > Game Logic
   Class > D.Doppler Taser Mod
   Unit  > Initialize Taser Scripts

   (Classname is 'DDOPP_TaserInit')

2. Make sure all the units in your mission that will use the Taser or will be
   tased are named.

Scripts work in MP and SP, on players and AI alike, however if you are dynamically spawning
new units in your mission (like in warfare/domination/AI etc.), you must make sure that:

~ They are named

~ They have the following code added to their init field on creation:

     /////////////// Code! cOde! coDe! codE! ///////////////

     this setVariable ["isTazed",false,true];
     this addEventHandler ["HandleDamage",{_this call DDOPP_taser_handleHit}];

     /////////////// Code! cOde! coDe! codE! ///////////////

--------------------
IMPORTANT
--------------------

If your mission already features a "HandleDamage" EH then you may need to merge the
included EH with your mission's EH to prevent them conflicting in-game.

To do this, you must follow these steps (provided that you know what you are doing):

1. Disable the automatic adding of the EH to all units triggered on script initialization.
   To do this you must set the variable "DDOPP_taser_enableEH" to false in the userconfig file.

   (Userconfig file found in Arma 2\Userconfig\DDOPP_TaserMod\DDOPP_TaserConfig.hpp after installation.)

2. Locate YOUR mission's HandleDamage EH and merge it with the following code:

   (You may replace the "_this select x" with the local variable names you use in your mission's
    EH if you want.)

   /////////////// Code! cOde! coDe! codE! ///////////////


   if ((_this select 4) in DDOPP_taser_arrBullet) then {
       [(_this select 0), (_this select 3), DDOPP_taser_koTime] spawn DDOPP_taser_victimFx;
   };

   /////////////// Code! cOde! coDe! codE! ///////////////

   The above EH is what triggers off the Taser script effects on each unit. If you
   want each unit to be affected by the Taser scripts in your mission, you must ensure
   each unit gets your EH added to it.

   Note the following values passed by the "HandleDamage" EH are used in the code:

       _this select 0 = Victim hit by Taser
       _this select 3 = Shooter who fired the Taser
       _this select 4 = Taser projectile/bullet

--------------------
Editing the scripts:
--------------------

You may edit the included scripts to increase compatibility with your mission/server, however
these edits MUST stay on YOUR server and you may not redistribute your edits elsewhere.

~ If you want to edit the scripts you will need a tool like BinPBO to open up the PBO, then repack
  it again. Make sure the binarize option is unchecked - re-binarizing the PBO might damage some of
  the included features.

All edits you make must feature a comment above the code, with your name followed by the date that
your code was added, like in the following example:

    // Your Name DD/MM/YY
    CODE THAT YOU ADDED;

E.g. "Double Doppler" edited the "HandleDamage" EH to delete bullet when hit on 5 February 2013:

    // Double Doppler 5/Feb/2013
    deleteVehicle _bullet; // Generic code add or edit

Month should be in text format to avoid confusion if International date format is used. (MM/DD/YY.)

==============================================================================
LICENSE
==============================================================================

Effective since 5 February 2013.

THE AUTHOR RESERVES THE RIGHT TO DISTRIBUTE THE ADDON WITH THEIR OWN SET OF TERMS AND CONDITIONS FOR
USAGE, AS STATED IN THE BI TOOLS END USER LICENSE AGREEMENT, AND TO MAKE CLEAR THAT WORKS INTEGRATED INTO
FILES GENERATED BY THE BI TOOLS ARE THE PROPERTY OF THE ORIGINAL AUTHOR, NOT BOHEMIA INTERACTIVE STUDIOS.

BI TOOLS EULA LINK: http://community.bistudio.com/wiki/End_User_License_Agreement_for_BI%27s_Tools

THE ABOVE STATEMENT IS INTENDED TO PREVENT CONFUSION IN IP RIGHTS TO MODELS, TEXTURES AND OTHER THIRD PARTY MATERIAL
INCORPORATED INTO BIS GAME FILES, AND PLAGIARIZING USERS STATING THAT THE AUTHOR HAS NO LEGAL CONTROL OVER THEIR
OWN CONTENT.

******************************************************************************

YOU ARE FREE TO USE THIS ADDON AS LONG AS YOU AGREE AND ABIDE BY THE FOLLOWING TERMS:

(Please scroll down to the bottom for the definitions.)

§1) Redistribution:

     ~ You may only redistribute this Addon in your server's mod pack. (E.g. AddonSync or SixUpdater.)

     ~ You may NOT redistribute this Addon anywhere else. (E.g. Armaholic, Mediafire.)

     ~ You may NOT externally redistribute individual contents of the Game File (PBO), including but not
       limited to: Models (.p3d), Textures (.paa, .pac), Scripts (.sqf), Sound (.wav, .ogg, .wss).

     ~ You must ensure that the LICENSE.txt is distributed, unedited, inside the .PBO

§2) Editing:

    ~ You may edit the included SCRIPTS to increase compatibility with your mission/server, however
      these edits MUST stay on YOUR server and you may not redistribute your edits elsewhere, and in the
      manner stated in the installation instructions.

    ~ You may not make edits to files which are locked such as but not limited to: ODOL .p3d files, by
      means of 'tool-using' or illegal 'cracking'.

    ~ ANY EDITS YOU MAKE MUST STAY ON YOUR OWN SERVER/COMMUNITY FOR COMPATABILITY REASONS ONLY AND MAY
      ONLY BE DISTRIBUTED IN YOUR GAME SERVER MOD PACK. YOU MAY NOT MAKE EDITS TO FILES WHICH ARE ALREADY
      'LOCKED' SUCH AS ODOL .P3D FILES BY MEANS OF ILLEGAL 'CRACKING'.

§3) Non Profit:

    You must distribute this Addon free of charge. You may not use this addon in any way to gain profit.
    (E.g. using in a project that charges consumers cash for membership or use of included content).

§4) Attribution:

    You may not claim this Addon as your own. When asked, you must refer to the original Author(s).

§5) Usage in other games:

    Using this Addon or any of its included components in other games is prohibited.

§6) Trademarks:

    The "DOUBLE DOPPLER" and "DD" trademark is property of Double Doppler.

    All other trademarks listed in the used trademarks section (but not limited to) are property of their
    respective owners. The use of these trademarks in this Addon serve only as representation of the
    actual/real items where indicated and used on a good faith basis with no benefit or profit.

§7) Damages:

    The Author may be not held responsible for the unlikely event that any damages are caused to your
    computer or other posessions. You downloaded this Addon free of charge out of your own will therefore
    the Author is not responsible for any technical damages or any other damages caused.

§8) Sensitive Information:

    Any information or images depicting possible sensitive information is purely of fiction and imagination
    and in no way at all represents any classified information.  This Addon, regardless of statement of
    accuracy, is no where based off real sensitive information and anything remotely resembling
    sensitive material is completely of coincidence and shall not be held accountable by any party.

§9) Waiver:

    Users may waive either of these terms (excluding §7 and §8) IF GIVEN PERMISSION BY THE AUTHOR.

THIS ADDON IS PROVIDED WITHOUT COST AND IS FREE AND IS DOWNLOADED AT YOUR OWN FREE WILL, THEREFORE THE
AUTHOR WILL NOT BE HELD ACCOUNTABLE FOR ANY COMPLICATIONS OR LIABILITIES, REGARDLESS.

Definitions:

a. "Addon" An addon (also reffered to as "Mod") is a user made modification designed to modify (within
   legal and practical boundaries) a computer game. The content in this folder or compressed file are
   considered components of an addon. The main addon resides in the combination of game files created
   in order to coordinate it.

b. "Author" The author is the person in the who created and coordinated this addon and holds copyright
   for the contents of this addon.

c. "Redistribute" means to make available to the public the original and copies of the Addon through sale,
   file upload or other transfer of ownership after the original Author.

d. "Game File" The main content. These files may include but are not limited to: 3D Meshes, Coordinates,
   Scripts, 2D Graphics and so forth. All copyright laws apply to these files. An example of a game file
   would be a .PBO file (Arma 2) or .WTD and .WFT files (GTA IV).

e. "Licensor" means the individual, individuals, entity or entities that offer(s) the Work under the
   terms of this License. In this case the licensor is the same person as the author.

f. "You" means an individual or entity exercising rights under this License who has not previously
   violated the terms of this License with respect to the Work, or who has received express permission
   from the Licensor to exercise rights under this License despite a previous violation.

g. "Reproduce" means to make copies of the Work by any means including without limitation by sound or
   visual recordings and the right of fixation and reproducing fixations of the Work, including storage
   of a protected performance or phonogram in digital form or other electronic medium.

h. "Addon Pack" is your clan/community/server's addon pack that contains all the 3rd-party content that is required
   to run the game properly. Usually consists of .pbo Addon files and their respective .bisigns, which commonly contain
   extra content such as scripts and models.

Copyright © 2013 Double Doppler. All rights reserved.

==============================================================================
CREDITS
==============================================================================

This modification and its components were created from scratch by Double Doppler Modding.

- 3D Models created and UV Mapped by Double Doppler and ported to Arma 2 via O2.
- Textures created and mapped by Double Doppler.
- RVMATs created by Double Doppler (NOHQ, SMDI etc.).
- Scripts and config created by Double Doppler.
- Special effects ported over by Double Doppler.

© 2013 Double Doppler Modding