Lunars

Lunars (Lunaro-scores) is a community-made ranking system for Lunaro, a PvP game mode in Digital Extremes' Warframe.

This repo serves as the server (backend) for the rating system.

Functionality:

Old, v1 ranking system

Lunars v1 was an adapted Elo rating system, in which each player was assigned an elo value determining their skill level.

Depending on players' performances we then lowered or raised this elo value.

In our rating system players were assigned leagues based on which range of ranking points they were in. These leagues are as follows:

From	To	League
2750	3000	Champion
2500	2750	Master
2250	2500	Pro
2000	2250	Skilled
1750	2000	Amateur
1500	1750	Padawan
1000	1500	Neophyte

For a more in depth explanation of how the v1 rating system worked, take a look at the Lunaro Rating Specification, written by quonnz

New, v2 ranking system

Lunars v2 is based on the Glicko-2 ranking system, which adds rank deviation (how unsure we are of a player's true rating) and rank volatility (how inconsistent a player is).

Lunars v2 uses the same modification for player latency and score as Lunars v1.

Lunars v2 also utilises the fractional rating period modification seen in instant-glicko-2 (and Lichess' system).

Lunars v2 wouldn't have been possible without the following resources:

• deepy/glicko2 - helpful for writing the base glicko math in code
• gplusbc/instant-glicko-2 and So You Want To Use Glicko-2 For Your Game's Ratings - fractional rating period modification, rating system theory

A heartfelt thanks to their authors!

Usage

• Download a release binary and .env file or git clone this repo.

• When cloning, you can generate a release binary for your local machine using

  $ cargo build --release

  You can then find the binary in /target/release.

• We now have the binaries, but before running the server we need to create a json file that will have our hashed keys.

• By default the server will look for a user.json but this can be set in the .env

• Your json file should look something like this:

  [
    {
      "hash" : "yoursha256hashhere"
    }
  ]

• You should also examine the values in the .env before running.

  If you will be running behind a reverse proxy, such as Nginx, be sure to set the X-Real-IP header and configure the reverse proxy key.

  The reverse proxy key is added to confirm the X-Real-IP header was set by the reverse proxy, and not by a bad actor. We recommend setting it to a randomly generated string.

  An example configuration of a reverse proxy key setup:

  .env

  # Only include this is you will be running behind a reverse proxy
  #
  # if you are behind a reverse proxy, this is required
  #
  # This should be a sha256 hash of a random string that the
  # reverse proxy needs to set in the header "X-Reverse-Proxy-Key", to
  # verify that X-Real-IP is real and not spoofed.
  REVERSE_PROXY_KEY_HASH="06dac547b85d01d625bfefe8e4b7a7f16b119fb90f7b64cba932a5be9211874b"
  

  nginx.conf

    server {
    	server_name lunars.example.com www.lunars.example.com;
    	location / {
    		proxy_set_header X-Real-IP $remote_addr;
    		proxy_set_Header X-Reverse-Proxy-Key "ZRgBVqwocRNaWNPhkOjNxnUQkQcPInSq";
    		proxy_pass http://38.242.248.25:58081;
    	}
    }
  

• After your setup is done, you can run the lunars executable, or run using Docker

  $ ./target/release/lunars       # Run binary
  $ docker-compose up -d --build  # Run in Docker

• Now you can interact with the API via the defined endpoints.

Credits

quonnz - Document author, curator, developer

koza1brada - curator, developer

Yujas - architect, curator