docs: update README

This commit is contained in:
bastimeyer 2021-12-05 21:58:18 +01:00
parent 897fbf1ab3
commit 1da6a22b82

View file

@ -1,13 +1,30 @@
DayZ Linux workshop setup
====
This is an expermental and still work-in-progress setup script for workshop mods of DayZ standalone when running the game via Proton on Linux.
This is an expermental and still work-in-progress setup+launcher script for workshop mods of DayZ standalone when running the game via Proton on Linux.
Proton is currently unable to start the game's own regular launcher application which sets up mods and launch parameters of the game client.
Proton is currently unable to start the game's own regular launcher application which sets up mods and launch parameters for the game client. The game however does work fine when launching the client directly, so mods can be set up and configured manually, which is what this script tries to do, similar to what the launcher would do.
Mods can be loaded via the `-mod=@MOD_NAME1;@MOD_NAME2;@MOD_NAME3` DayZ client launch parameter after they've been correctly set up in the game's root directory.
## Usage
----
```sh
./dayz-mods.sh MODID1 MODID2 MODID3...
./dayz-mods.sh --server ADDRESS
./dayz-mods.sh --launch --server ADDRESS
```
## TODO
- Add `--help` message
- Don't use a custom server query API and query the server directly
- Install mods automatically (only the `steamcmd` CLI utility seems to be able to do this from a command line shell context)
- If possible, resolve mod dependencies
## Known Issues
- Mod names which contain special characters like `'` for example don't get interpreted correctly by Steam as launch argument, meaning the `--launch` parameter won't work
## 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 ([original definition][definition]) needs to be set, otherwise the game will freeze while loading or after playing for a couple of minutes: