Skip to content

Latest commit

 

History

History
92 lines (47 loc) · 3.63 KB

README.md

File metadata and controls

92 lines (47 loc) · 3.63 KB
Raw

ELO Ranking Application

Ranking Players using Elo algorithm.

Configuration

Given two files:

  1. Players file: Each line has an ID number and a name for that player. File name and location is defined in
    application.properties with the property players.filename. Default value is ./players.txt

  2. Matches file: Each line contains the ID of the two players of a match and the first one is the winner of that match. File name and location is defined in
    application.properties with the property matches.filename Default value is ./matches.txt

How to run the application

Required:

  1. Java 11
  2. Maven

Build the application

mvn clean install

Run application using maven

Example:

mvn spring-boot:run -Dspring-boot.run.arguments="SHOW_DETAILS 13"

Use -Dspring-boot.run.arguments to send different options.

Run jar application

After running mvn clean install jar application elo-0.0.1-SNAPSHOT.jar could be found on ./target directory.

Example:

java -jar target/elo-0.0.1-SNAPSHOT.jar SHOW_DETAILS 13

Where SHOW_DETAILS and 13 are application options.

Application options

  • LIST_PLAYERS: Shows a list of players and their ranking, number of wins and losses. By default, the list is sorted by RANKING. However other sort options could be ID, NAME, RANKING, WINS, LOSSES. it is possible as well to change the sorting direction using the options ASC, DES. By default, the list is sorted by using ASC.

Example: java -jar target/elo-0.0.1-SNAPSHOT.jar LIST_PLAYERS WINS DES

  • SHOW_DETAILS: Shows the player details like ranking, number of wins, losses. Additionally, it shows whom the player won or lost and the number of times. For this option is mandatory a second parameter with the playerId.

Example: java -jar target/elo-0.0.1-SNAPSHOT.jar SHOW_DETAILS 13

  • GENERATE_MATCH: Shows a list of Player ID pairs with suggested matches. Matches are arranged based on player ranking. Matches with similar player rankings will be fun and challenging for the players. A match is generated per player in the list. As the player list might not be even in terms of the number of players, a player might need to play twice.

Runtime configuration options.

Location of the source files players.filename and matches.filename can be changed when running the application.

Example: java -jar target/elo-0.0.1-SNAPSHOT.jar SHOW_DETAILS 13 --players.filename=./new_players_file.txt

For Developers.

  1. Console entry point is io.fysus.elo.CommandRunner class.

  2. Based on the chosen option one of the io.fysus.elo.controller.Controller is executed.

  3. Controllers classes rely on Services implementations in the package io.fysus.elo.service to obtain the information and that information is formatted and reported using one of the implementations of io.fysus.elo.formatter.OutputFormatter

  4. Service Implementation in the package io.fysus.elo.service rely on io.fysus.elo.core.MatchAnalyzer to obtain match and player statistics.

LICENSE

See License

Questions?

Copyright

Copyright (c) 2020 Fredy Sierra