Skip to content

Commit 7238163

Browse files
committed
up Readme, accoring to the changes in v0.5.0
1 parent bf9b4d8 commit 7238163

1 file changed

Lines changed: 32 additions & 9 deletions

File tree

README.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,34 @@ An addon installer for Left 4 Dead 2 that will let you use them on official serv
66
![](screenshots/gui1_linux.png) ![installation](screenshots/gui2_linux.png)
77
![renaming](screenshots/gui3_linux.png)
88

9-
Since v0.3.0 there's a PuG mode switch (on/off) to temporarily restore the vanilla backup, to let you play on servers that impose file consistency. As well as a button to completely and irreversibly reset the current gameinfo to the default.
9+
Since v0.5.0 there's a different scheme of CLI commands. The commands are now divided between subcommands that perform it's own function. E.g. Installation, Listing, PuG mode, etc.
1010

1111
![](screenshots/gui_since-0.3.0_linux.png)
1212

1313
### CLI Usage
1414

1515
#### Installation
1616

17-
`L4AddonEnforcer -f <path to the *.vpk> -n <name>`
17+
`L4AddonEnforcer install -f <path to the *.vpk> -n <name>`
18+
19+
**`install`** or **`i`** corresponds to the subcommand for installation.
1820

1921
**`-f`** corresponds to the original VPK addon file that will be copied (as pak01_dir.vpk) to the later created addon directory.
2022

2123
**`-n`** corresponds to the common name of the addon, a directory that will be named after, and an entry in the gameinfo.txt.
2224
You can name it whatever you like, to later know what that addon is.
25+
Since 0.5.0 optional due to the added autoinstall function that extracts and constructs name from the addon.
2326

24-
Example (linux): `./L4AddonEnforcer -f /home/user/Downloads/ion_vocalizer.vpk -n vocalizer`</br>
25-
Example (windows): `L4AddonEnforcer.exe -f C:\Users\User\Downloads\ion_vocalizer.vpk -n vocalizer`
27+
Example (linux): `./L4AddonEnforcer install -f /home/user/Downloads/ion_vocalizer.vpk -n vocalizer`</br>
28+
Example (windows): `L4AddonEnforcer.exe install -f C:\Users\User\Downloads\ion_vocalizer.vpk -n vocalizer`
2629

2730
**The same way you can update an already installed addon.**
2831

2932
#### List of already installed addons
3033

31-
`L4AddonEnforcer -l`
34+
`L4AddonEnforcer list`
35+
36+
**`list`** or **`l`** corresponds to the subcommand for listing.
3237

3338
Example output:
3439
```
@@ -41,27 +46,45 @@ Installed addons:
4146
Boomer_Pudge
4247
```
4348

49+
Since 0.5.0 there is a **`-d`** argument to print metadata extracted from the addon.
50+
4451
***The list doesn't include the base game components***
4552
#### Uninstallation
4653

47-
`L4AddonEnforcer -u <name>`
54+
`L4AddonEnforcer uninstall -n <name>`
4855

49-
**`-u`** corresponds to the name of the already installed addon.
56+
**`uninstall`** or **`u`** corresponds to the subcommand for uninstallation.
57+
58+
**`-n`** corresponds to the name of the already installed addon.
5059

5160
Example (linux): `./L4AddonEnforcer -u AlienSwarmFont`</br>
5261
Example (windows): `L4AddonEnforcer.exe -u AlienSwarmFont`
5362

5463
#### Renaming
5564

56-
`L4AddonEnforcer -r <old_name> -n <new_name>`
65+
`L4AddonEnforcer rename -c <current_name> -n <new_name>`
66+
67+
**`rename`** or **`r`** corresponds to the subcommand for renaming.
5768

58-
**`-r`** corresponds to the name of the already installed addon.
69+
**`-c`** corresponds to the current name of the already installed addon.
5970

6071
**`-n`** corresponds to the new name of the addon.
6172

6273
Example (linux): `./L4AddonEnforcer -r vocalizer -n ion_vocalizer`</br>
6374
Example (windows): `L4AddonEnforcer.exe -r vocalizer -n ion_vocalizer`
6475

76+
#### PuG Mode
77+
78+
PuG mode temporalily switches the current gameinfo.txt file with the original gameinfo.txt file backup, if there is a need to play on servers that impose file consistency.
79+
80+
`L4AddonEnforcer pug < -c | -s >`
81+
82+
**`pug`** or **`p`** corresponds to the subcommand for managing the PuG mode.
83+
84+
**`-c`** checks the current status of the PuG mode.
85+
86+
**`-s`** switches the PuG mode.
87+
6588
#### More usage...
6689

6790
Use `L4AddonEnforcer -h` (simple) or `L4AddonEnforcer --help` (detailed) to learn more.

0 commit comments

Comments
 (0)