1.1 KiB
1.1 KiB
Installation
Step 1: Authentication Token
In order to access start.gg's API, you must first have an authentication token linked to your account. Instructions for generating one can be found in the developer API docs.
Once you have an auth token, it must be provided to StartRNR. In order, the program checks for a token in:
- A command-line flag
--auth. - An environment variable
AUTH_TOKEN, - A file
auth.txtwithin the config directory (see the README for a list of directories in each OS).
The last method is recommended, as StartRNR can simply read from that file whenever it needs to.
Step 2: Dependencies
StartRNR is written in Rust, so install the Rust toolchain.
In addition, StartRNR needs these run-time dependencies:
Step 3: Compiling
Once you have all the necessary dependencies, build and install StartRNR by running the following command:
cargo install --git https://github.com/kiana-S/StartRNR