Skip to content

Commit 5401c7d

Browse files
committed
Update README with detailed mod verification examples for Windows and Linux
1 parent cb9e2db commit 5401c7d

1 file changed

Lines changed: 31 additions & 3 deletions

File tree

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,41 @@ In general ModVerify has two operation mods.
8080
1. `verify` Verifying a game or mod
8181
2. `createBaseline` Creating a baseline for a game or mod, that can be used for further verifications in order to verify you did not add more errors to your mods.
8282

83-
### Example
84-
This is an example run configuration that analyzes a specific mod, uses a the FoC basline and writes the output into a dedicated directory:
83+
### Examples
8584

86-
```bash
85+
#### Example 1: Auto-detection with a custom baseline
86+
Analyzes a specific mod, uses the FoC baseline and writes the output into a dedicated directory:
87+
88+
**Windows:**
89+
```bat
8790
.\ModVerify.exe verify --path "C:\My Games\FoC\Mods\MyMod" --outDir "C:\My Games\FoC\Mods\MyMod\verifyResults" --baseline ./focBaseline.json
8891
```
8992

93+
**Linux:**
94+
```bash
95+
./ModVerify verify \
96+
--path "/home/user/games/FoC/Mods/MyMod" \
97+
--outDir "/home/user/games/FoC/Mods/MyMod/verifyResults" \
98+
--baseline ./focBaseline.json
99+
```
100+
101+
#### Example 2: Manual mod setup with sub-mods, EaW fallback and default baseline
102+
Uses manual mod setup, including sub-mods and the EaW fallback game, and uses the default embedded baseline:
103+
104+
**Windows:**
105+
```bat
106+
.\ModVerify.exe verify --mods "C:\My Games\FoC\Mods\MySubMod;C:\My Games\FoC\Mods\MyMod" --game "C:\My Games\FoC" --fallbackGame "C:\My Games\EaW" --useDefaultBaseline
107+
```
108+
109+
**Linux:**
110+
```bash
111+
./ModVerify verify \
112+
--mods "/home/user/games/FoC/Mods/MySubMod;/home/user/games/FoC/Mods/MyMod" \
113+
--game "/home/user/games/FoC" \
114+
--fallbackGame "/home/user/games/EaW" \
115+
--useDefaultBaseline
116+
```
117+
90118
---
91119

92120
## Available Checks

0 commit comments

Comments
 (0)