https://github.com/spanglel/openrareplay
Ruby program/library to parse and generate OpenRA replays without identifying information
https://github.com/spanglel/openrareplay
openra openra-replays ruby
Last synced: 7 months ago
JSON representation
Ruby program/library to parse and generate OpenRA replays without identifying information
- Host: GitHub
- URL: https://github.com/spanglel/openrareplay
- Owner: spanglel
- License: agpl-3.0
- Created: 2018-06-29T19:00:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-06T01:30:57.000Z (over 7 years ago)
- Last Synced: 2025-03-04T04:03:09.047Z (7 months ago)
- Topics: openra, openra-replays, ruby
- Language: Ruby
- Homepage:
- Size: 38.1 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# OpenRA Replay
> Copyright (C) 2018 Luke Spangler
>
> This program is free software: you can redistribute it and/or modify
> it under the terms of the GNU Affero General Public License as
> published by the Free Software Foundation, either version 3 of the
> License, or (at your option) any later version.
>
> This program is distributed in the hope that it will be useful,
> but WITHOUT ANY WARRANTY; without even the implied warranty of
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> GNU Affero General Public License for more details.
## Description
A library and executable that can parse OpenRA replay files and produce "sanitized" versions, without pings, exact timestamps, or other unnecessary information. The long term goal is to produce a full gem project packaging both a library and an executable for reading and writing to OpenRA replay files. However, the library will never support parsing non-YAML data beyond preserving it as a chunk. Examples of non-YAML data includes unit and building orders.
## Requirements:
A relatively recent version of Ruby.
## Installation:
```
gem install openrareplay
```
## Usage:
```
Usage: openra-sanitize [options] in_file out_file
Reads an OpenRA replay file, trims/masks it, and outputs the result as a new file
Specific options:
-p, --ping Trim all ping-related content
-m, --message Trim all server messages
-c, --chat Trim all chat messages
-i, --ip Trim all IP addresses
-t, --time Mask all dates and times
-P, --password Trims the server password
-n, --player-name Masks all player names
-s, --server-name Trim the server name
-f, --force Force overwriting out_file
Common options:
-h, --help Show this message
--version Show version
```
Keep in mind that some options might not make sense without another. For instance, without removing server messages, player names would still be revealed in those messages.
