aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 8d516ead1d1613d04dffe03ffa7f489418264310 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Arma Reforger Dedicated Server Mod Manager (ardsmm)

## Installation

### Using Virtualenv

```
python -m venv venv 

# If on Windows:
.\venv\Scripts\activate

# If on Linux/Unix:
source venv/bin/activate

pip install git+https://github.com/jhunkeler/ardsmm
```

## Using Conda

```
conda create -n "ardsmm" python
conda activate ardsmm
pip install  git+https://github.com/jhunkeler/ardsmm
```

## Usage

```
usage: ardsmm [-h] [-i] [-o OUTPUT_FILE] [-m MOD_FILE] [-I INDENT] [-V] [configfile]

positional arguments:
  configfile            An Arma Reforger dedicated server JSON config

options:
  -h, --help            show this help message and exit
  -i, --in-place        modify JSON config file in-place
  -o OUTPUT_FILE, --output-file OUTPUT_FILE
                        write JSON output to file (default: stdout)
  -m MOD_FILE, --mod-file MOD_FILE
                        read mods from file (default: stdin)
  -I INDENT, --indent INDENT
                        set JSON indentation level (default: 4)
  -V, --version         display version number and exit

```

## Examples

Create a new configuration file with your `config.json` as the baseline. Mod definitions are appended to `{ "game": { "mods": [] } }`:

```
ardsmm -o test.json -m examples/mods.txt examples/config.json
```

Or add mods to an existing configuration file:

```
ardsmm -i -m examples/mods.txt examples/config.json
```