From fead8f84b56af89455e97f2f95748bb81d6d5ff8 Mon Sep 17 00:00:00 2001 From: Dimach Date: Thu, 29 Feb 2024 05:41:08 +0000 Subject: [PATCH] Create README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3f18461 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# RTracy server +This is server for streaming .utacy files generated by https://github.com/ParadiseSS13/byond-tracy to tracy https://github.com/wolfpld/tracy profiler +Works with Tracy 0.10 (protocol 64) +This server allow partial streaming of large snapshots to prevent huge memory usage + +# Usage +Just run rtracy with .utracy file as arg and connect using capture or tracy +Server support multiple connection at the same time +Optional arguments +| Arg | Info | +| --- | ------------- | +| -p port | Port on wich server will be run | +| -s skip | Skip desired amount of frames from snapshot begin | +| -l limit | Limit desired amount of frames to be streamed | + +For example if you want to stream 30 minutes of data after 10 minutes from start (assuming you snapshot written at 10 frames per second) run ./rtracy you_file.utracy -s 6000 -l 18000 + +# Why +RTracy created to resolve two main problems of @AffectedArc07 ParaTracyReplay script (https://github.com/AffectedArc07/ParaTracyReplay): +1. Query handling while loading, wich allow you to stop load snapshot at any time without getting ??? on all callsights +2. Partial file streaming wich allow to open 100GB snapshots without 128GB of ram + +Also this server slightly faster + +# Contributing +Please do