Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
IceDynamix committed Aug 23, 2024
1 parent d62302b commit 8e1a7e1
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ made to be used with [fribbels hsr optimizer](https://github.com/fribbels/hsr-op
- when installing on windows, make sure to enable the "winpcap api-compatible mode".
if this is grayed out for you, see [here](https://github.com/IceDynamix/reliquary-archiver/issues/2)
for more details
- if you use wifi, enable `Support raw 802.11 traffic (and monitor mode) for wireless adapters`
- when building on Linux, set the `CAP_NET_RAW` capability on the resulting executable (via [pcap(3pcap)](https://man.archlinux.org/man/pcap.3pcap#Under~5))
```sh
sudo setcap CAP_NET_RAW=+ep target/release/reliquary-archiver
Expand All @@ -25,6 +26,8 @@ made to be used with [fribbels hsr optimizer](https://github.com/fribbels/hsr-op
- if successful, the archiver should output a file to `archiver_output.json`
![archiver visual guide](./archiver_visual_guide.gif)

you might have to disable your VPN or enable/disable wifi!

### cli usage

```
Expand Down Expand Up @@ -56,7 +59,9 @@ to output logs to a file, provide `--log-path <path>`. file logs will always be
note that the necessary resource files are downloaded in the build script and compiled into the binary.
## library
## related projects
want to do more with packet parsing? check out the
[standalone library](https://github.com/IceDynamix/reliquary) the archiver is built on top off!
looking to export your achievements? check out [stardb-exporter](https://github.com/juliuskreutz/stardb-exporter)!

0 comments on commit 8e1a7e1

Please sign in to comment.