HIPSTER WSO/RIO v1.0
(Please do not redistribute)


**INTRODUCTION ************************************
Hipster is a script that allows you to enhance an existing single player mission.
It simulates a WSO/RIO AI that will give you information about possible contacts in the radar or inside visual range.

Hipster uses a simple algorithm that simulates an IA WSO/RIO using a virtual radar, his own field of view and his hability to search for other aircrafts in range.
This algorithm has into acount factors as distance and size of the target, altitude difference, azimuth position, notching, etc.
It can be added to any aircraft configured as Client or Player in the mission. (usually a two seater aircraft mod) 
Will work only on missions with only one human player at the same time, so forget about use it in multiplayer missions/servers)

You can configure Hipster independly for any aircraft (see below) and once in mission you can give commands to Hipster throw F10 radio menu.

IN NO CASE HIPSTER IS ABLE TO PILOT THE AIRCRAFT OR MANAGE THE WEAPONS/SENSOR SYSTEMS OF A MOD OR MODULE AIRCRAFT. It is imposible for this type of scripting to manage ED or 3rd parties source code as such.


Check the videos and to subscribe Dummy Pilot YT channel for tutorials about Hipster and other good stuff.
https://www.youtube.com/channel/UCVzC9MRQJ3JylDw-cPQSdnQ


**KNOWN ISSUES ************************************
Because the mess of the sound api that DCS uses, the sounds played by hipster script will interfere with other sound files played during the mission.
(If Hipster speaks, it will interrupt any other sound played in the mission at that same moment. The opposite is also true)

Using radio transmission trigger for Hipster communications, to avoid the above problem, at this moment is not possible:
https://forum.dcs.world/topic/320242-radio-transmision-script-not-playing-short-audiofiles

Hipster hasn't into account if an enemy is jamming or using electroinic warfare. So he will give you information he shouldn't now.
There is no way, using this type of scripting, to know if an enemy is jamming, so it isn't possible to fix this.


**HOW TO ADD HIPSTER TO A MISSION ************************************
	The "install process" is quite the same as M.E.P v2.0. (https://youtu.be/XAuhhYY4YkA)
	You can add HIPSTER to ANY mission you have the physical .miz file in your computer.
	NOTE: If it is a new mission created from scratch, you must save it first in the DCS Mission Editor to create the correspondent .miz file. After that, close Mission editor.	
	
	STEPS:	
	1. I MEAN IT, close in DCS Mission Editor the mission you are going to add HIPSTER. Otherwise the changes done outside of Mission Editor could not be applied or could be overwritten!!! ^_^
	2. Unzip HIPSTER zip file to your hard drive. You'll find "soundsHipster" subfolder and a .lua file.
	3. Open your .miz file (mission file) where you want to add HIPSTER. Use winrar, or other program able to manage zipped files without need to decompress the content into the hard drive.
		(NOTE: DCS .miz files are zipped files and can be opened with most of zip programs)
	4. Add the HIPSTER's "soundsHipster" folder to the root of the .miz file
			IMPORTANT: do not unzip to the hard drive and re-zip again the content of .miz file. Add "soundsHipster" folder directly in the window opened in winrar.
	5. Close the .miz file in winrar window		
	6. Open the mission in DCS Mission Editor and create a trigger:
		Name: as you wish
		Type: 4 MISSION START
		Conditions: empty
		Actions: DO SCRIPT FILE
			File: look for for ../HipsterAI.lua (the .lua file you found when unzipped HIPSTER zip file)
	7. Configure HIPSTER for any Client or Player aircraft you want in the mission editor (see below)		
	8. Save the mission and enjoy!
	
	(NOTE: you can do step 6 and 7 before of after step 3 and 4, as you wish. What is important is that during steps 3 and 4 you must close the mission in the DCS mission editor)

**HOW TO CONFIGURE A CLIENT/PLAYER SLOT TO USE HIPSTER ************************************
	Once the Hipster script is ready, you can configure any aircraft in the mission to use Hipster (only for SKILL: "player" or "client")
	Open in Mission Editor the MISSION START trigger you create before and add a new action.
		Type: DO SCRIPT FILE.
		Text:	In the textbox, FOR EACH AIRCRAFT YOU WANT IT TO USE HIPSTER, you must add a line:
		
			hipsterConf.setAircraft("NameOfThePilot", "RadType", hasIFF)
					
			NameOfThePilot: It is the name that appears in the mission editor, when you select an existing group. In the AIRPLANE GROUP panel, in the PILOT textbox (below SKILL and above TAIL#)
			RadType: it is the power of Hipster's "radar". THIS VALUE IS COMPLETELY AT YOUR DISCRECTION. The possible values are:
					"NO": no radar -->hispter will not inform about BVR contacts.
					"G1", "G2", "G3","G4" --> the more the number, the more powerful Hipster's "radar" is. That means: more efective founding targets, more effective range, better IFF (if available)
												This have not any correlation with real live, and is only a way to try to match hipster with the aircraft real radar power.
												I'm not a radar ingenier, but we can say:
												- G1 are the first radar generation mounted on airplanes (first prototypes)
												- G2 are old radar (vietnam, early Cold War era)
												- G3 are modern radars (late and post Cold War era)
												- G4 the most modern radars (last generations fighters)
			hasIFF: (THIS VALUES ARE NOT QUOTED). If the aircraft has IFF or not.
					true: Hipster's radar is able to IFF contacts (depending on the distance and power of the radar)
					false: Hipster's radar is not able to IFF contacts.
					
	Example: let's say that in my mission I have 3 client slots (F-4 mod, F-15c, F-35 mod). 
					The names of the pilots are playerSlot1, playerSlot2 and playerSlot3, and the player can choose to fly the mission using anyone.
				In the text of the DO SCRIPT FILE action I must put this:
		
			hipsterConf.setAircraft("playerSlot1", "G2", false)
			hipsterConf.setAircraft("playerSlot2", "G3", true)
			hipsterConf.setAircraft("playerSlot3", "G4", true)

	
**HOW TO USE ************************************
	Once a player/client aircraft has HIPSTER configured, you will receive information automatically from Hipster from time to time, just as he was a real WSO/RIO.
		
	Please note that Hipster IS NOT ACTUALLY USING THE ACTUAL RADAR OF THE AIRCRAFT, programmed by the developers of the mod or module. So you can see different information in the MFDs, and he is not able at all to lock targets.
	This is the closest to have an "integrated" RIO/WSO AI in the module (like George, Petrovich or Jester), using this type of scripting.(Think of it as if Hipster was operating his own radar).
	
	With this information, Hipster helps you to search for those contacts using the actual radar (or look for contacts in Visual Range).
	
	(BVR)
	Hipster will search for BVR contacts and inform about them, provided they are detected by him (having into account distance, size, notching, etc)
	From then on, it will continue providing information about the closest unknown/hostile target (if the target is clasified as friendly, he will inform only the first time it is detect, but it will not be followed)
	If new contacts are found later, he will inform again about them, and continue "tracking" the closest unknown/hostile contact.
	
	(DOGFIGHT)
	Once an unknown/hostile contact is in Visual Range (~10nm), he will ignore all BVR contacts and provide information only about this target.
	When Hipster pick up a target for Dogfight, he will stay on that target (even if someother is nearest at other some point). Otherwise he will crazy you if he jumps from one target to another every 20 seconds.
	Hipster will stay with this target and continue providing information about him, until he is dead (or you order to follow the current nearest target)
		
	You can give some commands to HIPSTER during the mission using the F10 radio menu, in order to change Hipster's behaviour.
	
**LIST OF COMMANDS************************************	

	F1. HIPSTER VERBOSE... --> Open Hipster verbose submenu
		Ignore BVR contacts --> Order Hipster to ignore all Beyond Visual Range contacts, and give information only about contacts in Visual Range (Dogfight)
									(Could be useful if you want Hipster to don't bother you constantly about far targets, but want him to help you in dogfight if they come closer)
		
		Ignore enemies in Dogfight --> Order Hipster to ignore contacts in visual range, and give information only about VBR targets	
									(Just the opposite of the above option)
									
		Only new targets --> Hipster will inform only about new targets on BVR mode, not continually tracking anyone of them. He will continue providing information about targets in Dogfight.							
		
		Complete silence --> Hipster will not provide any information from now on.
		
		Say all --> reset the Hipster verbose behaviour, and he will provide all information again.
		
		
	F2. SET BVR... --> open Hispter BVR submenu.
		- Options to set the Area Of Interest where hipster is looking for targets, using his "radar" in BVR.
		- Take into account that Hipster's "radar" can only "see" targets inside a cone infront the aircraft nose (Same as the actual radar works).
		- You can combine horizontal an vertical options.
						I.E: you can request Hipster to "focus center-left" and "focus low" in order to look for targets at 10-11 o'clock and below your altitude.
			SET HORIZONTAL SEARCH --> open horizontal search submenu (Azimut)
				- Hipster will narrow and move his Area Of Interest horizontally. This will increment the posibility to find targets in that area, but the targets on the other horizontal areas will be not found.
					MAX AMPLITUDE --> option by default. No particular AOI regarding azimut. 
										He will scan all the available horizontal azimut (-60º to 60º), but no increment of the posibility of find target will be applied.
					FOCUS LEFT	-->	Hipster will narrow the radar cone and focus his interest to the left
					FOCUS CENTER-LEFT	-->	Hipster will narrow the radar cone and focus his interest to the front-left
					FOCUS CENTER	-->	Hipster will narrow the radar cone and focus his interest to the front of the aircraft
					FOCUS CENTER-RIGHT	-->	Hipster will narrow the radar cone and focus his interest to the front-right
					FOCUS RIGHT	--> Hipster will narrow the radar and focus his interest cone to the right

			SET VERTICAL SEARCH --> open vertical search submenu (Elevation)
				- Hipster will narrow and move his Area Of Interest vertically. This will increment the posibility to find targets in that area, but the targets on the other vertical areas will be not found.
					MAX AMPLITUDE --> option by default. No particular AOI regarding elevation. 
										He will scan all the available horizontal elevation (-10º to 20º), but no increment of the posibility of find target will be applied.					
					FOCUS LOW	-->	Hipster will narrow the radar cone and focus his interest finding targets below 
					FOCUS CENTER-LOW	-->	Hipster will narrow the radar cone and focus his interest finding targets slightly below 
					FOCUS CENTER	-->	Hipster will narrow the radar cone and focus his interest finding targets at similar level 
					FOCUS CENTER-UP	-->	Hipster will narrow the radar cone and focus his interest finding targets slightly above 
					FOCUS UP	--> Hipster will narrow the radar cone and focus his interest finding above targets

	F3. IGNORE CURRENT TARGET FROM NOW ON --> order hipster to ignore his current tracked target from now on.
		- Useful in case the current tracked target in BVR or Dogfight is not of your interest (A civil/neutral aircraft, an enemy AWACS or whatever)
		
	F4.	CHANGE TO NEAREST TARGET FOR DOGFIGHT --> order hispter to track the CURRENT nearest target for dogfight.
		- Useful if the current Dogfight target is running away and you want to recommit Hipster to the CURRENT nearest target.