Skip to content

Commit 839bbd9

Browse files
committed
Add readme
1 parent f8932e3 commit 839bbd9

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# PlayStation Archive viewer
2+
3+
A viewer for PlayStation Archive (PSARC) archives.
4+
5+
![](https://github.com/user-attachments/assets/f1a1a042-70c9-480b-aa96-7d9e74f89697)
6+
7+
## Installation
8+
9+
1. Download the latest release from the [releases page](https://github.com/ShadelessFox/psarc/releases/latest) for your operating system
10+
2. Unzip the downloaded archive and launch using `psarc.exe` on Windows or `bin/psarc` on Linux
11+
12+
#### Nightly builds
13+
14+
If you want to try the latest features and improvements, you can download the latest build from the [actions page](https://github.com/ShadelessFox/psarc/actions).
15+
Click on the latest workflow run and download the artifact from the `Artifacts` section for your operating system.
16+
17+
## Command Line
18+
19+
### Listing files
20+
21+
All files from an archive can be listed using the `list` command:
22+
23+
```bash
24+
psarc-cli list path/to/archive.psarc
25+
```
26+
27+
Additional options can be specified:
28+
29+
- `--verbose` to make the output include offset, size, and compressed size of files within the archive,
30+
- `--output` to specify the output file (by default, outputs to the standard output).
31+
32+
### Extracting files
33+
34+
All files from an archive can be extracted using the `extract` command:
35+
36+
```bash
37+
psarc-cli extract --dir path/to/output path/to/archive.psarc
38+
```

0 commit comments

Comments
 (0)