Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
notscuffed committed Feb 12, 2019
1 parent 864f2dc commit 8d98a32
Showing 1 changed file with 41 additions and 36 deletions.
77 changes: 41 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# RePKG

Wallpaper engine PKG unpacker/TEX to png converter, written in C#.
Wallpaper engine PKG unpacker/TEX decompiler, written in C#.
Made using information obtained from reverse engineering "resourcecompiler.exe" in wallpaper engine bin's folder.

I don't know if anyone will find this project useful, uploaded it mainly because I wanted to learn to use git.
Expand All @@ -9,40 +8,46 @@ Made in 2 days including reverse engineering, feel free to report errors or requ
Initially I wanted to make it be able to extract and repack stuff but I found that repacking is not really that useful.

# Features

- Unpack PKG files
- Convert TEX to PNG
- Show info about PKG/TEX files
- Unpack PKG files
- Decompile TEX to PNG
- Convert PKG into wallpaper engine project
- Show info about PKG/TEX files

### Commands

- help - shows those commands, use `help "extract"` and `help "info"` to see options for them
- extract - extracts specified PKG/TEX file, or files from folder
```
-o, --output (Default: ./output) Path to output directory
-i, --ignoreexts Ignore files with specified extension (split extensions using ,)
-e, --onlyexts Only extract files with specified extension (split extensions using ,)
-d, --debuginfo (Default: false) Show debug info about extracted items
-t, --tex (Default: false) Extract directory of tex files
-s, --singledir (Default: false) Should all extracted files be put in one directory instead of their specific subfolders
-r, --recursive (Default: false) Recursive search in all subfolders of specified directory
```
- info - Shows info about specified PKG/TEX file
```
-s, --sort (Default: false) Sort entries a-z
-b, --sortby (Default: name) Sort by ... (available options: name, extension, size)
```
- help - shows those commands, use `help "extract"` and `help "info"` to see options for them
- extract - extracts specified PKG/TEX file, or files from folder
```
-o, --output (Default: ./output) Output directory
-i, --ignoreexts Don't extract files with specified extensions (delimited by comma ",")
-e, --onlyexts Only extract files with specified extensions (delimited by comma ",")
-d, --debuginfo (Default: false) Print debug info while extracting/decompiling
-t, --tex (Default: false) Decompile all tex files from specified directory in input
-s, --singledir (Default: false) Should all extracted files be put in one directory instead of their entry path
-r, --recursive (Default: false) Recursive search in all subfolders of specified directory
-c, --copyproject Copy project.json and preview.jpg from beside .pkg into output directory
--no-tex-decompile Don't decompile .tex files while extracting .pkg
--overwrite Overwrite all existing files
```
- info - Shows info and entries in PKG/TEX file
```
-s, --sort (Default: false) Sort entries a-z
-b, --sortby (Default: name) Sort by ... (available options: name, extension, size)
```

### Examples
Find .pkg files in subfolders of specified directory and only extract+convert .tex entries to png and put them in ./output omitting their paths from .pkg:
```
repkg extract -e tex -s -o ./output E:\Games\steamapps\workshop\content\431960
```
Extract all files from specific .pkg to output directory while keeping their paths from .pkg
```
repkg extract -o ./output E:\Games\steamapps\workshop\content\431960
```
Convert all .tex files from specific folder to png
```
repkg extract -t -s E:\path\to\dir\with\tex\files
```
### Examples
Find .pkg files in subfolders of specified directory and make wallpaper engine projects out of them in output directory
```
repkg extract -c E:\Games\steamapps\workshop\content\431960
```
Find .pkg files in subfolders of specified directory and only decompile .tex entries to png and put them in ./output omitting their paths from .pkg:
```
repkg extract -e tex -s -o ./output E:\Games\steamapps\workshop\content\431960
```
Extract all files from specific .pkg to output directory while keeping their paths from .pkg
```
repkg extract -o ./output E:\Games\steamapps\workshop\content\431960
```
Convert all .tex files from specific folder to png
```
repkg extract -t -s E:\path\to\dir\with\tex\files
```

0 comments on commit 8d98a32

Please sign in to comment.