feat(newserver): DayZ

[Marcin648]

Description

This PR add support for DayZ.
For now only DayZ Experimental supports linux.
DayZ Experimental server it self it's not fully stable for now, can crash time to time.

Linux support is added in DayZ Experimental v1.14. This does not mean it will be included in next release. When that happens appid need to be change to stable version.

Fixes #3556

Type of change

• Bug fix (a change which fixes an issue).
• New feature (change which adds functionality).
• New Server (new server added).
• Refactor (restructures existing code).
• Comment update (typo, spelling, explanation, examples, etc).

Checklist

PR will not be merged until all steps are complete.

• This pull request links to an issue.
• This pull request uses the develop branch as its base.
• This pull request Subject follows the Conventional Commits standard.
• This code follows the style guidelines of this project.
• I have performed a self-review of my code.
• I have checked that this code is commented where required.
• I have provided a detailed with enough description of this PR.
• I have checked If documentation needs updating.

Documentation

Documentation should to be updated. DayZ share the same mods installation process then Arma 3.
https://github.com/GameServerManagers/LinuxGSM-Docs/blob/master/game-servers/arma-3.md#mod-support

If documentation does need updating either update it by creating a PR (preferred) or request a documentation update.

• User docs: https://github.com/GameServerManagers/LinuxGSM-Docs
• Dev docs: https://github.com/GameServerManagers/LinuxGSM-Dev-Docs

Thank you for your Pull Request!

[h3o66]

a few nits to check from my perspective

[Marcin648]

Status for now.
Server installs correctly, configure, starts and *stops. Network ports are parsed correct. Monitor feature fully work.
Details commands shows all informations correct.

Known issues:
DayZ crash if logFile is defined in game config. Need to be commented. (DayZ Bug)
*DayZ throw SIGSEGV and create core dump while closing is in progress (server stop command). LGSM report it as FAIL but it's normal for now. (DayZ Bug)
DayZ mods are broken if are use debug command. #3409 (comment)

This PR is draft for now. Any comments are welcome :)

[Marcin648]

Debug command issue

Some games like Arma3 or DayZ use special characters in argument line, that need to be escape. For some reason the start command works fine as opposed to debug command. To find out what went wrong I wrote simple script that prints all process arguments. They are my conclusions.
https://gist.github.com/Marcin648/0074f322b3af8df76a2bf8e444999187

My dayzserver.cfg file looks like this below. It's the same pattern, that Arma 3 configuration looks like. That tries to load two mods @cf and @cj187_immersive_map.

ip="0.0.0.0"
port="2302"

## DayZ Modules
# Add mods with relative paths:
# mods/@cf
# To load the "Community framework for DayZ SA" module found in the
# directory serverfiles/mods/@cf.  Load several mods as:
# mods="mods/@cf\;mods/@dayz-expansion\;mods/@deerisle"
mods="mods/@cf\;mods/@cj187_immersive_map\;"

## Server-side Mods
servermods=""

## Path to BattlEye
# Leave empty for default
bepath=""

## Server Parameters | https://docs.linuxgsm.com/configuration/start-parameters#additional-parameters
startparameters="-ip=${ip} -port=${port} -config=${servercfgfullpath} -mod=${mods} -servermod=${servermods} -bepath=${bepath} -limitFPS=60 -dologs -adminlog -freezeCheck"

The problem

This is what args looks like when run with start command (output from check_args.py)

...
argv[3] = -config=/home/linuxgsm/srv/serverfiles/cfg/dayzserver.server.cfg
argv[4] = -mod=mods/@cf;mods/@cj187_immersive_map;
argv[5] = -servermod=
...

and that looks with debug command

...
argv[3] = -config=/home/linuxgsm/srv/serverfiles/cfg/dayzserver.server.cfg
argv[4] = -mod=mods/@cf\;mods/@cj187_immersive_map\;
argv[5] = -servermod=
...

So when we use debug, arguments are not unescaped. (\;)
The reason for this is that command line is passed as argument in "" to tmux, unlike using debug, command line is call directly.

https://github.com/Marcin648/LinuxGSM/blob/d9367755097f14834bf91492db64dabb6e9aea54/lgsm/functions/command_start.sh#L82
https://github.com/Marcin648/LinuxGSM/blob/d9367755097f14834bf91492db64dabb6e9aea54/lgsm/functions/command_debug.sh#L125

Solution

In my opinion best and easiest solution to that is call command line by eval when debug is using.
That do unescape parameters the same way that happend when we use tmux.
In this PR, I made elif for DayZ because this is feature/dayz-server branch, but in my opinion every game should be use eval in this case. This change also can solves the same problem in Arma3 server.

[dgibbs64]

@Marcin648 that issue relates to #3409 I will consider using eval as it may resolve simular issues. Thank you for the research

[dgibbs64]

I have merged the use of eval in to the develop branch. so that should resolve the debug issues.

[BlueSky-fur]

Looking forward to this!

[BlueSky-fur]

Any Updates on this?

[Marcin648]

Updated for new features that be added in latest LGSM release.
Ready to merge.

[BlueSky-fur]

We should add a note that its only Experimental DayZ Branch servers, stable is yet to come sadly :/

[PhilPhonic]

Suggestion: merge this as is "DayZ Experimental Server" and as soon as "DayZ Server" is available create another PR.
That way we'd be able to run normal and experimantal servers with linuxgsm.

[Marcin648]

I suggested exactly this on discord. But after discussion users said that instead of create two entry of servers in LGSM better is simple change appid in config. The same way that beta branch change.

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.