diff --git a/README.md b/README.md index 8cc219d..1ec963d 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,15 @@ Removes parts from Kerbal Space Program crafts - and more :) * Checks all links to the removed part(s) and only removes parts with "hard" dependencies * Adapts "parent", "link", "sym", "SrfN" and "AttN" links on dependent parts +## General notes + +* If no output file is specified, the input file is modified. +* This tool supports a **--silent** switch and can be used programmatically should you desire. +* It has been tested with the following types of files so far : + * .craft files generated by KSP 1.12 + * .sfs files generated by KSP 1.12 + * .txt vessel files generated by LMPServer (not fully tested) + ## Usage ``` KSPPartRemover v1.2 @@ -37,7 +46,7 @@ Commands: list-mods list mods used by the parts in the input file if you don't have a required mod installed it will be listed as UNKNOWN - [KSPPartRemover needs to be in KSP directory for this to work!] + [KSP directory needs to be your current directory for this to work!] remove-parts remove one or more parts from one or more crafts @@ -72,22 +81,35 @@ Switches: do not print additional info, do not ask for confirmation ``` -## General notes +## Usage Examples -* If no output file is specified, the input file is modified. -* This tool supports a **--silent** switch and can be used programmatically should you desire. -* It has been tested with the following types of files so far : - * .craft files generated by KSP 1.12 - * .sfs files generated by KSP 1.12 - * .txt vessel files generated by LMPServer (not fully tested) +### list-crafts + +![example-list-crafts](images/example-list-crafts.png) + +### list-parts + +![example-list-parts](images/example-list-parts.png) + +### list-partdeps + +![example-list-partdeps](images/example-list-partdeps.png) + +### list-mods + +![example-list-mods](images/example-list-mods.png) + +### remove-parts + +![example-remove-parts](images/example-remove-parts.png) Release notes ======================= ### KSPPartRemover v1.2 * New command **list-mods**: list mods used by the parts in the input file - * KSPPartRemover **needs** to be in KSP directory for this to work! * If you don't have a required mod installed it will be listed as **UNKNOWN** + * **KSP directory needs to be your current directory** for this to work! * Make loading files much more tolerant (since part information from mods can now be loaded from KSP directory) ### KSPPartRemover v1.1 diff --git a/images/example-list-crafts.png b/images/example-list-crafts.png new file mode 100644 index 0000000..588cdd5 Binary files /dev/null and b/images/example-list-crafts.png differ diff --git a/images/example-list-mods.png b/images/example-list-mods.png new file mode 100644 index 0000000..a8b567e Binary files /dev/null and b/images/example-list-mods.png differ diff --git a/images/example-list-partdeps.png b/images/example-list-partdeps.png new file mode 100644 index 0000000..f4706d3 Binary files /dev/null and b/images/example-list-partdeps.png differ diff --git a/images/example-list-parts.png b/images/example-list-parts.png new file mode 100644 index 0000000..55eb343 Binary files /dev/null and b/images/example-list-parts.png differ diff --git a/images/example-remove-parts.png b/images/example-remove-parts.png new file mode 100644 index 0000000..e00889c Binary files /dev/null and b/images/example-remove-parts.png differ