diff --git a/README.md b/README.md index cf70035..7440b07 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -DayZ Linux CLI launcher +DayZ Linux CLI Launcher ==== ## About @@ -9,7 +9,7 @@ Proton is currently unable to start the game's own regular launcher application Automatic Steam workshop mod downloads are currently unsupported due to a limitation of Steam's CLI. Workshop mods will therefore need to be subscribed manually via the web browser. A URL for each missing mod will be printed to the output. -Please see the "Important notes" section down below to get the game running on Linux. +Please see the "Install DayZ" section down below on how to get the game running on Linux. ## Usage @@ -64,11 +64,37 @@ Environment variables: ## TODO - Don't use a custom server query API and query the server directly -- Install mods automatically +- Install mods automatically Unfortunately, Steam doesn't support downloading workshop mods via the CLI and only the `steamcmd` CLI utility seems to be able to do this from a command line shell context, but this requires a Steam login via CLI parameters, which is a bit unpractical. - If possible, resolve mod dependencies -## Important notes +## Install + +To install the launcher script, simply clone the git repository: + +```sh +git clone https://github.com/bastimeyer/dayz-linux-cli-launcher.git +cd dayz-linux-cli-launcher +./dayz-launcher.sh ... +``` + +or download the raw script file from GitHub and make it executable (check the script file contents first before running it): + +```sh +curl -SL -o dayz-launcher.sh 'https://github.com/bastimeyer/dayz-linux-cli-launcher/raw/master/dayz-launcher.sh' +chmod +x dayz-launcher.sh +./dayz-launcher.sh ... +``` + +This repository currently does not submit to any versioning scheme, so please be aware of any breaking changes that may be applied in the future. + +## Install DayZ + +[Support for BattlEye anti-cheat for Proton on Linux has been officially announced by Valve on 2021-12-03.][battleye-announcement] + +In order to get the game running on Linux, you first have to install the Steam beta client (see Steam's settings menu). Then install `Proton Experimental` and the `Proton BattlEye Runtime` (filter by "tools" in your games library). After that, set the "Steam play compatibility tool" for DayZ to "Proton Experimental" (right-click the game and go to properties). + +### Important notes In order for the game to actually run on Linux via Proton, the [`vm.max_map_count`][vm.max_map_count] kernel parameter needs to be increased, because otherwise the game will freeze while loading the main menu or after playing for a couple of minutes. Some custom kernels like TK-Glitch for example already increase this value from its [default value of `64*1024-6`][vm.max_map_count-default] to [`512*1024`][tkg-kernel-patch], but even this won't work reliably. Increasing it to `1024*1024` seems to work. @@ -83,6 +109,7 @@ Or apply it permanently: ``` + [battleye-announcement]: https://store.steampowered.com/news/group/4145017/view/3104663180636096966 [vm.max_map_count]: https://github.com/torvalds/linux/blob/v5.15/Documentation/admin-guide/sysctl/vm.rst#max_map_count [vm.max_map_count-default]: https://github.com/torvalds/linux/blob/v5.15/include/linux/mm.h#L185-L202 [tkg-kernel-patch]: https://github.com/Frogging-Family/linux-tkg/blob/db405096bd7fb52656fc53f7c5ee87e7fe2f99c9/linux-tkg-patches/5.15/0003-glitched-base.patch#L477-L534