Breaking Change: Game time_class and rules

Sort:
bcurtis

To better conform with the upcoming player ratings groups, we need to change some of the standardized values in the games endpoints.

  1. time_class : all daily chess games will use the term "daily" rather than an indication of the number of days per turn. Other livechess time classes will be unchanged.
  2. time_control : a new field will be added with specific timing indication. The values here will be the same as you see in the one-click "start a game" shortcuts in the navbar, plus any custom time control values that are set in livechess games. Here is where the daily chess days-per-turn value will go.
  3. rules : this will cover the same set of rules variants, but will use our internal notation (lowercase, one-word no spaces). Notably, "Standard Chess" will become "chess."

We expect these changes to be live this week.

walidmujahid

Very nice! I am looking forward to these changes.

BlackSpock

I hope you mean that these changes will take place sometime this week. I 'm not sure of the consequences of the changes being "dead".wink.png

bcurtis

Right, @BlackSpock, the changes will be made, tested, and available later this week. I do sometimes forget to talk like a real person when I'm discussing technical things.

null

bcurtis

Update: feedback on the time_control value led us to prefer the PGN-standard format. This format is the number of seconds for the base time, and if a move-increment exists then it is also in seconds and separated by a plus sign ("+"). Daily Chess games are included in this change, and only have a base time. All values will be encoded as strings, to prevent the plus sign from being interpreted mathematically.

Examples, from the time-control values visible in the quick-start game interface on the website:

  • "30 min" → "1800"
  • "10 min" → "600"
  • "5 min" → "300"
  • "15 | 10" → "900+10"
  • "5 | 5" → "300+5"
  • "3 | 2" → "180+2"
  • "3 min" → "180"
  • "2 | 1" → "120+1"
  • "1 min" → "60"
  • "1 day" → "86400"
  • "2 days" → "172800"
  • "3 days" → "259200"
  • "5 days" → "432000"
  • "7 days" → "604800"
  • "10 days" → "864000"
  • "14 days" → "1209600"

If you have a script parsing these time_control values, you should update it today. Existing game data may take up to a day to update.

bcurtis

Further update: feedback from players tells us that the proper PGN Time Control format for the daily chess time class to describe one move per unit-of-time with no overall time limit is "1/86400" (where "86400" is replaced with the appropriate number of seconds for the amount of days allowed per turn). There is no indication in the Time Control for PGN or the JSON response for vacation time (which acts as a suspension of the clock).

We expect this change to be active this week.