Skip to content

Commit

Permalink
add usage example images
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisDeadman committed Feb 11, 2022
1 parent 020528d commit 30a86a9
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 9 deletions.
40 changes: 31 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
Binary file added images/example-list-crafts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/example-list-mods.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/example-list-partdeps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/example-list-parts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/example-remove-parts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 30a86a9

Please sign in to comment.