Headless Client – Arma 3

Headless Client Overview

• Headless Client is used to offload AI calculations from the server
• Headless Client is integrated into game client and dedicated server executable (WIndows and Linux, use -client parameter)
• The server doesn't allow arbitrary connections from headless clients if you do not define the headless clients IPs in the server.cfg,

the below value defines accepted IP Addresses from Headless Clients.
Multiple Connections and Addresses are allowed in the case of more than one Headless Client headlessClients[]={"xxx.xxx.xxx.xxx", ...}

• Additionally to define clients with unlimited bandwidth and nearly no latency you must include theirs IPs in the server.cfg too

localClient[]={127.0.0.1, ...};

• Missions need to be changed a little to support headless clients:
  • extract AI to separate AI script
  • edit init.sqf to execute an extracted AI on headless client
  • place headless client unit
• in scripts the headless clients may be identified by its name, multiple headless clients are supported
• next sections will show you how to use Headless Client

Prerequisites

• read these tutorials (at least the first one):
  • https://www.dropbox.com/s/1n5a8entg3hvj5z/A3_hc_tutorial.pdf?dl=0
  • http://dl.dropbox.com/u/6920345/HC_tutorial/hc_tutorial.pdf
  • http://www.tacticalgamer.com/arma-mission-development/192601-headless-client-easy.html
  • http://forums.bistudio.com/showthread.php?146708-A-comprehensive-guide-to-creating-a-headless-client-compatible-mission

Spawning the AI

1. Add a Headless Client entity to the mission:
   1. Add a player unit
   2. Then you can insert a Headless Client unit:SIDE: Game Logic, CLASS: Virtual Entities, UNIT: Headless Client, CONTROL: Playable, NAME: somename
   3. Don't forget to set NAME property as the name can be used to identify Headless Clients in scripts (by checking it against player)
   4. Each Headless Client unit will add one Headless Client slot - missions may contain multiple Headless Client units
2. Create a script that will spawn AI (in the examples below we will use "init_HC.sqf"). To execute it on the Headless Client you have the two following options.

   Execute the script only on the Headless Client

   • This method will make your mission spawn the AI only if a Headless Client is present. However it is the most simple to set up.
   1. Add the following to the beginning of init.sqf:
      if !(hasInterface or isServer) then {
execVM "init_HC.sqf";
};

   Execute the script contextually on the Headless Client or Server

   • If you intend to share your mission this method is more desirable as it means players do not need a Headless Client to play it.
   1. Set up a function with the postInit attribute set to 1. (We must do this postInit since public variables don't work preInit and Event Scripts are ran in the scheduled environment which is subject to delay).
   2. Add the following to the function:if !(hasInterface or isServer) then {
HeadlessVariable = true;
publicVariable "HeadlessVariable";
execVM "init_HC.sqf";
};The code block above will run only on a Headless Client and it first sends out a variable so that other machines (most importantly the server) can detect the presence of a Headless Client. After doing so the AI spawning script is immediately executed since the Headless Client doesn't need to do anything else.
   3. Add the following to the beginning of init.sqf:if (isServer) then {
if (isNil "HeadlessVariable") then {
execVM "init_HC.sqf";
};
};The above code block runs only on the server and it first checks if a Headless Client is present. Only if a Headless Client isn't present does the server execute the AI spawning script.
3. Repeat steps 1 and 2 for the amount of Headless Clients your mission is designed to use. For multiple you must use the NAME property from step 1 to identify them individually within your script.

Server

1. add headless client IP address into server.cfg (you can use more than one address):headlessClients[]={"xxx.xxx.xxx.xxx", "xxx.xxx.xxx.xxx", "xxx.xxx.xxx.xxx"}
2. to run Arma3 Dedicated Server use one of these commands:Windows: arma3server.exe -config=server.cfg
Windows: arma3.exe -server -config=server.cfg
Linux: arma3server -config=server.cfg

Headless Client

1. to run Arma3 Headless Client use one of these commands:Windows: arma3server.exe -client -connect=xxx.xxx.xxx.xxx -password=yourpass
Windows: arma3.exe -client -connect=xxx.xxx.xxx.xxx -password=yourpass
Linux: arma3server -client -connect=xxx.xxx.xxx.xxx -password=yourpass
2. your client will be automatically connected to a free headless client slot
3. you can run arbitrary number of headless clients on the same machine

Overview of running options

• Main game executable (windows only)arma3.exe
arma3.exe -server
arma3.exe -client
• Windows server executablearma3server.exe
arma3server.exe -client
• Linux server executablearma3server
arma3server -client

GUI

• Headless clients can be seen in the Role assignment display when creating a MP game
  • If you are admin (host)
    • You will see HCs listed in the Players list on the right
    • You will see a category called Virtual (it can contain both Zeus and HCs) on the left
    • Note: HCs are automatically assigned to their slots
  • If you are normal player
    • You won't see any HCs anywhere
    • You won't see any Virtual category (if the mission contains Zeus then there will be Zeus category)
• In-game UI
  • HCs are listed with other players only if you are admin (map, tasks, kill statistics, ...)

Known issues

• what needs to be somewhat tested/determined/improved/changed is disconnect & reconnect of HC and all related to that

Feedback

http://forums.bistudio.com/showthread.php?183918-Dedicated-Client-Headless-Client-feedback-(dev-branch)

See Also

• server.cfg