Unverified Commit 8b007531 authored by Tom Wiesing's avatar Tom Wiesing
Browse files

Update README.md

parent 9cd97100
......@@ -2,10 +2,10 @@
This repository contains data about the Kalah Tournament.
Each round is contained in a separate file, the first round in `round1-4-4.json`, the second round in `round2-5-5.json` etc.
Each round is contained in a separate file, the first round in `round1-4-4.json`, the second round in `round2-5-5.json`, etc.
The first number indicates the round, the second number indicates the number of houses, the third number the number of seeds.
The fields contained within should be self-explanatory, but here it is nonetheless:
The fields contained within should be self-explanatory, but here is a description regardless:
```ts
......@@ -24,34 +24,34 @@ interface Match {
Player1: string;
/* the name of the second player */
Player2: string;
Player2: string;
/* "Events" that took place during this match, see below */
Events: Array<MatchEvent>;
/* the winner of this match, "" if it resulted in a tie */
Winner: string;
Winner: string;
/* the scores at the end of this match */
Final: MatchEvent;
Final: MatchEvent;
/* additional output produced during this match, mostly exceptions */
ExtraLines: Array<string>;
ExtraLines: Array<string>;
}
/* MatchEvent represents an event that took place during a match */
interface MatchEvent {
/* the round number right before this event occured */
Round: number;
Round: number;
/* the score of Player1 right before this event occured */
Player1Score: number;
Player1Score: number;
/* the score of Player2 right before this event occured */
Player2Score: number;
Player2Score: number;
/* human-readable description of this event */
Event: string;
Event: string;
}
/* Placement represents a placement within the result table */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment