Update README.md

- Generally cleaned it up and made it more clear what a Headless Client does.
- Added Installation Requirements
- Cleaned up, and removed spelling errors in, the Additional Settings section.
This commit is contained in:
Red-Thirten 2021-01-26 16:03:38 -08:00 committed by GitHub
parent 65645401e5
commit 03f2d20a96
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,21 +1,27 @@
# Arma 3 Headless Client # Arma 3 Headless Client
### From their [Site](https://community.bistudio.com/wiki/Arma_3_Headless_Client) ### From their [Site](https://community.bistudio.com/wiki/Arma_3_Headless_Client)
What is a Headless Client (HC) used for? What is a Headless Client (HC) used for?
* Headless Client is used to offload AI calculations from the server * Headless Client is used to offload AI calculations from the server [to improve the main server's performance].
* Headless Client is integrated into game client and dedicated server executable (WIndows and Linux, use -client parameter) * Headless Client is integrated into dedicated server executable, and uses the `-client` parameter to activate.
* The server doesn't allow arbitrary connections from headless clients if you do not define the headless clients IPs in the server.cfg, * The server doesn't allow arbitrary connections from headless clients if you do not define the headless clients' IPs in the `server.cfg`.
### But why? ### But why?
If you host an Arma 3 Server with lots of AI in it, the Server FPS will drop fast. If you host an Arma 3 Server with lots of AI in it, the Server FPS will drop fast. The headless client helps alleviate the AI's stress on the server.
Since the server files are only 32 Bit you will need some kind of magical assistant to prevent slow AI.
### Minimum RAM warning ### Installation Requirements
This server requires about 2048m to run properly. ARMA 3 is more CPU intensive though. - A valid, real Steam account, with Steam Guard turned off, is required to install the client (default "anonymous" login cannot be used). For security reasons it is recommended that you create a new Steam account just for your dedicated servers. This account *does not* need to own Arma 3.
- The Arma 3 server this client is connecting to **must** be running a properly written mission file that accepts and utilizes headless clients. If you want to know how to implement, take a look at the Wiki [here](https://community.bistudio.com/wiki/Arma_3_Headless_Client#Spawning_the_AI) or at a guide in the A3 Forums [here](https://forums.bohemia.net/forums/topic/178434-arma3-headless-client-guide/).
- For automatic Steam Workshop mod downloading to work, the Steam account *does* need to own Arma 3. This is, of course, optional functionality, and mods can be manually uploaded to the client if desired.
### Additional settings ### Minimum RAM Warning
Additional server flags can be found [here](https://community.bistudio.com/wiki/Arma_3_Startup_Parameters). This client requires about 2048 MB to run properly.
This can help is you see the server using to many cores/threads on the server.
If you want to know how to implement, take a look at the Wiki [here](https://community.bistudio.com/wiki/Arma_3_Headless_Client#Spawning_the_AI) or at a guide in the A3 Forums [here](https://forums.bohemia.net/forums/topic/178434-arma3-headless-client-guide/). ### Additional Settings
Additional client flags can be found [here](https://community.bistudio.com/wiki/Arma_3_Startup_Parameters).
These can help you fine tune how the client will behave during runtime.
*Note: The `-maxMem=` flag is currently known to cause an unknown segmentaion fault crash on startup. Other hardware related flags may cause similar behavior.*
### Server Ports ### Server Ports
Since this is basically a client, this Egg does not need a port. Since this is basically a client, this Egg does not need a port.
Therefore, the port assigned to this Egg goes unused.