Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderHarrison authored Aug 30, 2024
1 parent 098c654 commit 6d5375c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SLPZ
# slpz
This library compresses and decompresses between the slp and slpz formats.

You can expect slpz files to be around 8x to 12x times smaller than slp files for regular matches. (~3Mb down to ~300Kb).
Expand All @@ -11,13 +11,13 @@ Important information, such as player tags, stages, date, characters, etc. all r
This allows slp file browsers to easily parse and display this information without needing to decompress the replay.

# The slpz program
You can download the the 'slpz' executable through the 'releases' on github.
You can download the slpz executable through the 'Releases' menu on github.
This program allows commandline compression and decompression of both files and entire directories.

For example, the command `slpz -r --rm -x ~/Slippi/` will compress every replay in your Slippi replay directory.
The command `slpz -r --rm -d ~/Slippi/` will decompress them.

# The SLPZ Format
# The slpz Format

## Header
24 bytes.
Expand Down

0 comments on commit 6d5375c

Please sign in to comment.