Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
b-morgan committed Apr 11, 2024
1 parent 4d8345a commit f76f2dc
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ removing all the other world files.
This is a Python3 program and a Python3 installation is needed if you wish to use the .py file.
An executable file is provided so a Python3 installation is not needed.

# Command line options
## Command line options
```
usage: clean_enshrouded.exe [-h] [-b] [-p] [-c] [-w WAIT] [-d DIRECTORY]
Expand All @@ -21,7 +21,7 @@ options:
directory to process
```

# Recommendations
## Recommendations

By default (i.e. no switches on the command line), the program just analyzes the current directory and exits.
A `-c` on the command line is needed to actually process the directory.
Expand All @@ -32,9 +32,11 @@ the `Start in:` can be edited to the location of the world save files.

It is recommended to make a backup first. The program will first create a `backup.zip` file in the current directory
if `-b` or `-p` command line switches are present. The `-b` switch uses the program 7-zip, https://www.7-zip.org/ and
the `-p` switch uses PowerShell.
the `-p` switch uses PowerShell. The `backup.zip` only contains the world files.

The program output is sent to a console window. If started from an Explorer window (or a shortcut),
this console window will close when the program exits.
A "sleep" for 10 seconds before exiting allows some time for the output to be read and
this time can be changed with the `-w` switch.

The `-d` switch is optional and if present, the program will switch to that directory before processing begins.

0 comments on commit f76f2dc

Please sign in to comment.