StartRNR/README.md

66 lines
1.9 KiB
Markdown
Raw Normal View History

# StartRNR
2023-08-25 22:12:47 -04:00
2023-10-03 23:47:40 -04:00
**StartRNR** is an implementation of the cutting-edge player rating system known
as **Relative Network Rating (RNR)** for competitive gaming. It uses
[start.gg](https://www.start.gg/)'s tournament data to generate and maintain a
network of relative advantages between players.
2023-08-25 22:12:47 -04:00
2023-10-03 23:47:40 -04:00
Once the advantage network is generated, StartRNR can be used to predict the
probability of a player winning a match, generate provably optimal seedings for
2023-10-04 17:58:54 -04:00
tournaments, inspect the match history of two players, and create competitive
rankings automatically.
2023-10-03 23:47:40 -04:00
**All of these features work for any game, in any region, without restriction.**
2023-08-25 23:13:33 -04:00
2023-12-16 00:01:56 -05:00
> [!WARNING]
2023-10-13 18:15:10 -04:00
> StartRNR is unstable and under active development. The design and user
> interface of this program is experimental and may be subject to change.
>
2023-12-16 00:03:35 -05:00
> Currently, the power ranking and seeding features have not been implemented.
2023-08-25 22:12:47 -04:00
## Installation
2023-09-23 03:37:22 -04:00
*For more information, see the [installation page](INSTALL.md).*
Build and install StartRNR using `cargo`:
2023-09-23 03:37:22 -04:00
``` sh
cargo install --git https://github.com/kiana-S/StartRNR
2023-09-23 03:37:22 -04:00
```
Alternatively, if you use Nix:
``` sh
nix profile install github:kiana-S/StartRNR
2023-09-23 03:37:22 -04:00
```
2023-08-25 22:12:47 -04:00
You will need to provide a start.gg API token to access tournament data. Details can be found in [INSTALL.md](INSTALL.md).
2023-12-16 00:18:35 -05:00
## Usage
Once StartRNR is installed, run:
``` sh
startrnr sync
```
The program will walk you through creating a dataset, then run its rating
algorithm. **This may take up to a few hours to finish running!**
Once the rating data has been generated, these commands can be used to access it:
``` sh
# Access a player's data
startrnr player info <player>
# Analyze matchup of two players
startrnr player matchup <player1> <player2>
```
A player can be specified by their tag or by their
[discriminator](https://help.start.gg/en/articles/4855957-discriminators-on-start-gg).
2023-10-13 18:15:10 -04:00
## Details - The RNR System
2023-08-25 22:12:47 -04:00
2023-10-13 18:15:10 -04:00
*For more information on RNR, see the [details page](DETAILS.md).*