Skip to content

Commit

Permalink
Add goals
Browse files Browse the repository at this point in the history
  • Loading branch information
hohav committed Mar 28, 2024
1 parent b723d69 commit 6b86707
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,15 @@ The Rust source files in [src/frame](src/frame) are generated using Clojure from

If you're adding support for a new version of the spec, you'll also need to bump `peppi::io::slippi::MAX_SUPPORTED_VERSION`.

## Goals

- Performance: Peppi aims to be the fastest parser for `.slp` files.
- Ergonomics: It should be easy and natural to work with parsed data.
- Lenience: accept-and-warn on malformed data, when feasible.
- Cross-language support: other languages should be able to interact with Peppi easily and efficiently.
- Round-tripping: Peppi can parse a replay and then write it back, bit-for-bit identically.
- Alternative format: Peppi provides an [alternative format](#peppi-format) that is more compressible and easier to work with than `.slp`.

## Peppi Format

The Peppi format (`.slpp`) is a [GNU tar](https://en.wikipedia.org/wiki/Tar_(computing)) archive containing the following files:
Expand Down

0 comments on commit 6b86707

Please sign in to comment.