Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 3.03 KB

README.md

File metadata and controls

67 lines (49 loc) · 3.03 KB
Raw

reliquary-archiver

tool to create a relic export from network packets of a certain turn-based anime game

json output format is based on the format of HSR-Scanner

made to be used with fribbels hsr optimizer

run

  • requires npcap (windows) or libpcap (linux)
    • when installing on windows, make sure to enable the "winpcap api-compatible mode". if this is grayed out for you, see here 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)) 
      sudo setcap CAP_NET_RAW=+ep target/release/reliquary-archiver
  • download latest release from here
  • Launch the game and get to this screen. Do not go into the game yet main menu start screen
  • run the archiver executable and wait until it says "listening with a timeout" archiver listening for timeout
  • start the game
  • if successful, the archiver should output a file to archiver_output.json archiver visual guide

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

cli usage

Usage: reliquary-archiver.exe [OPTIONS] [OUTPUT]

Arguments:
  [OUTPUT]  Path to output .json file to [default: archive_output.json]

Options:
      --pcap <PCAP>          Read packets from .pcap file instead of capturing live packets
      --timeout <TIMEOUT>    How long to wait in seconds until timeout is triggered (for live capture) [default: 120]
  -v, --verbose...           How verbose the output should be, can be set up to 3 times. Has no effect if RUST_LOG is set
  -l, --log-path <LOG_PATH>  Path to output log to
  -h, --help                 Print help

to customize logging, either

  • set the verbose flags
  • or set RUST_LOG env variable to customize logging, see here

to output logs to a file, provide --log-path <path>. file logs will always be trace-level.

build from source

  • follow instructions here
    • for me on windows, adding the Packet.lib and wpcap.lib from the sdk (check the x64 or arm dir) to this directory was enough to link successfully
  • cargo build / cargo run

note that the necessary resource files are downloaded in the build script and compiled into the binary.

related projects

want to do more with packet parsing? check out the standalone library the archiver is built on top off!

looking to export your achievements? check out stardb-exporter!