package tournament_service
Get desktop application:
View/edit binary Protocol Buffers messages
Input to AddDirectors should be director usernames.
Input to AddPlayers should be player usernames
rpc CheckIn (, )
tournament_service.proto:520CheckIn allows players to check themselves in.
message
tournament_service.proto:252string id = 1
bool checkin = 2
message
tournament_service.proto:267string id = 1
bool delete_non_checked_in = 2
message
tournament_service.proto:264string id = 1
message
tournament_service.proto:578optional date = 1
date is the date of the session This is used as scheduled_start_time for the tournament now that we store this data.
string club_id = 2
EditPlayer changes an existing player's rating, or (in IRL mode) name.
message
tournament_service.proto:152string id = 1
string division = 2
string player_id = 3
The player's username (or name, for IRL tournaments), as with RemovePlayers.
optional int32 rating = 4
optional string new_name = 5
Only supported in IRL mode, where a player is identified by their name.
optional string team = 6
The player's team; empty removes them from their team. Teams can't change once the division has started.
message
tournament_service.proto:166(message has no fields)
message
tournament_service.proto:570string id = 1
string format = 2
bool use_real_names = 3
message
tournament_service.proto:576string exported = 1
message
tournament_service.proto:227string id = 1
GetEnteredTournaments returns the tournaments and clubs a user played in or is registered in, the last played first.
message
tournament_service.proto:307string username = 1
username, if set, lists the tournaments and clubs that user entered instead, for a caller who can see private user data (the admin user lookup).
message
tournament_service.proto:330repeated tournaments = 1
GetMyTournaments returns tournaments where the authenticated user is a director.
message
tournament_service.proto:296string username = 1
username, if set, lists the tournaments and clubs that user directs instead, for a caller who can see private user data (the admin user lookup).
message
tournament_service.proto:303repeated tournaments = 1
message
tournament_service.proto:287int32 limit = 1
optional limit for number of tournaments to return (default 100)
message
tournament_service.proto:292repeated tournaments = 1
message
tournament_service.proto:281(message has no fields)
message
tournament_service.proto:283repeated tournaments = 1
message
tournament_service.proto:595string id = 1
club_id
int32 count = 2
int32 offset = 3
message
tournament_service.proto:602repeated sessions = 1
message
tournament_service.proto:225string id = 1
message
tournament_service.proto:219string id = 1
User must provide the ID, or the slug (but not both)
string slug = 2
message
tournament_service.proto:230optional metadata = 1
repeated string directors = 2
directors are not part of the metadata. We decided to make those individually addable/removable (See AddDirectors)
message
tournament_service.proto:619string tournament_id = 1
message
tournament_service.proto:623repeated participants = 1
message
tournament_service.proto:272string id = 1
bool show_opponents = 2
bool show_seeds = 3
bool show_qr_code = 4
message
tournament_service.proto:279bytes pdf_zip = 1
Monitoring/invigilation endpoints
message
tournament_service.proto:604string tournament_id = 1
MovePlayer moves a player from one division to another
message
tournament_service.proto:145string id = 1
string source_division = 2
string target_division = 3
string player_id = 4
message
tournament_service.proto:25string slug = 1
If slug is not assigned, a random ID will be chosen.
string name = 2
string description = 3
repeated string director_usernames = 4
TType type = 5
optional scheduled_start_time = 6
optional scheduled_end_time = 7
bool irl_mode = 8
irl_mode creates the tournament with over-the-board (IRL) pairing mode enabled, so that usernames need not be registered on the site. It can also be toggled later via SetTournamentMetadata, but only before any players have been added.
message
tournament_service.proto:214string id = 1
string slug = 2
message
tournament_service.proto:265string id = 1
message
tournament_service.proto:263string id = 1
message
tournament_service.proto:117string id = 1
string division = 2
int32 round = 3
bool preserve_byes = 4
bool delete_pairings = 5
PreviewPairings shows how each pre-paired scheme would pair the division, ranked for what the director wants. Nothing is changed.
message
tournament_service.proto:346string id = 1
string division = 2
int32 rounds = 3
How many rounds to pre-pair.
int32 expected_players = 4
If more than the players registered, the rest are placeholders, seeded last.
PlannerIntent intent = 5
int32 rounds_per_opponent = 6
For the Team Round Robin: how many rounds in a row each pair plays (its round controls' games_per_round). 0 means 1.
message
tournament_service.proto:432repeated players = 1
repeated schemes = 2
Best first for the intent; the suggestion, if any, is first.
repeated alternatives = 3
int32 top_seeds = 4
message
tournament_service.proto:237string id = 1
tournament id
int32 num_games = 2
int32 offset = 3
message
tournament_service.proto:244repeated games = 1
rpc Register (, )
tournament_service.proto:521message
tournament_service.proto:257string id = 1
string division = 2
bool register = 3
message
tournament_service.proto:250string id = 1
Input to RemoveDirectors should be director usernames.
Input to RemovePlayers should be player usernames
message
tournament_service.proto:139string id = 1
string division = 2
string new_name = 3
message
tournament_service.proto:608string tournament_id = 1
string stream_type = 2
"camera" or "screenshot"
message
tournament_service.proto:613string tournament_id = 1
string user_id = 2
string stream_type = 3
"camera" or "screenshot"
rpc RunCOP (, )
tournament_service.proto:552message
tournament_service.proto:440string id = 1
string division = 2
int32 round = 3
repeated int32 player_classes = 4
repeated int32 class_prizes = 5
double control_loss_threshold = 6
double hopefulness_threshold = 7
int32 place_prizes = 8
int32 division_sims = 9
int32 control_loss_sims = 10
int32 control_loss_activation_round = 11
bool allow_repeat_byes = 12
int32 gibson_spread = 13
message
tournament_service.proto:168string id = 1
string division = 2
repeated pairings = 3
message
tournament_service.proto:178TournamentResultOverrideRequest is sent when a score needs to be edited or added by a director. Note that player one and player two need to be the players that went first and second, respectively; otherwise, we will not be able to accurately track firsts/seconds.
string id = 1
string division = 2
string player_one_id = 3
string player_two_id = 4
int32 round = 5
int32 player_one_score = 6
int32 player_two_score = 7
ipc.TournamentGameResult player_one_result = 8
ipc.TournamentGameResult player_two_result = 9
ipc.GameEndReason game_end_reason = 10
bool amendment = 11
int32 game_index = 12
message
tournament_service.proto:111string id = 1
string division = 2
optional round_controls = 3
message
tournament_service.proto:207bool paired = 1
paired is true if the round was paired because its pairing lag changed and the round it is now paired from was already complete.
repeated string warnings = 2
warnings are as in TournamentResponse.
message
tournament_service.proto:103optional metadata = 1
bool set_only_specified = 2
set_only_specified sets only the specified fields, and not the entire metadata. non-zero-value fields will be treated as "specified"
message
tournament_service.proto:193string id = 1
string division = 2
int32 round = 3
bool start_all_rounds = 4
Uncheck everyone in. Use this some time before the beginning of a session.
message
tournament_service.proto:248string id = 1
message
tournament_service.proto:228string id = 1
message
tournament_service.proto:246string id = 1
message
tournament_service.proto:586Used as response type in: TournamentService.CreateClubSession
Used as field type in:
string tournament_id = 1
Note that club sessions are tournaments in our backend. We return the created tournament ID here:
string slug = 2
slug will look like /club/{club_name}/{date}. It should be case-insensitive.
message
tournament_service.proto:316A tournament or club a user entered: played a game in, or is in a division of while it is not finished.
Used in:
string id = 1
string name = 2
string slug = 3
TType type = 4
bool irl_mode = 5
int32 games = 6
games played in it, 0 if only registered.
optional last_played = 7
bool registered = 8
registered is whether the user is in one of its divisions now; only unfinished tournaments are looked at for this.
What a director wants from the rounds they pre-pair, which decides how the pairing planner ranks the schemes.
Used in:
PLANNER_FAIR_START = 0
A fair start before COP (or another method) pairs the rest: everyone gets a similar schedule, and the top seeds are kept apart for later.
PLANNER_WHOLE_EVENT = 1
The pre-paired rounds are the whole event.
PLANNER_TWO_TEAMS = 2
Two teams play each other, such as Portland vs Seattle.
message
tournament_service.proto:367Used in:
int32 first = 1
Players are indexes into PreviewPairingsResponse.players, in seed order.
int32 second = 2
message
tournament_service.proto:360Used in:
string name = 1
int32 rating = 2
string team = 3
bool placeholder = 4
message
tournament_service.proto:378Used in:
int32 firsts = 1
int32 seconds = 2
int32 byes = 3
int32 own_group_games = 4
Games against players in the same team or group, and outside it.
int32 other_group_games = 5
double average_opponent_seed = 6
int32 longest_run = 7
The most firsts or seconds in a row.
int32 distinct_opponents = 8
How many different players they play.
message
tournament_service.proto:373Used in:
repeated games = 1
repeated int32 byes = 2
message
tournament_service.proto:425A different number of pre-paired rounds that would suit the intent better.
Used in:
int32 rounds = 1
ipc.PairingMethod pairing_method = 2
bool play_within_team = 3
string reason = 4
message
tournament_service.proto:392Used in:
ipc.PairingMethod pairing_method = 1
bool play_within_team = 2
bool available = 3
string unavailable_reason = 4
repeated rounds = 5
repeated int32 groups = 6
Each player's team or group (an index), or -1 when the scheme has none.
int32 cycle_length = 7
How many rounds it takes for everyone to play everyone the scheme pairs them with; 0 if it can't be told.
double min_average_opponent_seed = 8
double max_average_opponent_seed = 9
int32 top_seed_games = 10
Games among seeds 1 to PreviewPairingsResponse.top_seeds.
int32 repeats = 11
int32 max_byes = 12
int32 max_first_imbalance = 13
The most anyone is off even, firsts minus seconds, at the end.
int32 longest_run = 14
repeated player_stats = 15
repeated string notes = 16
Plain sentences for the director: what the scheme does with this field and what to watch out for.
bool suggested = 17
string name = 18
What to call the scheme, such as "Snaked Round Robin, within teams".
int32 missed_opponents = 19
The most different opponents any player misses: they could have played one more new opponent instead of each repeat, but didn't.
message
tournament_service.proto:9string tournament_id = 1
int32 round = 2
Used in: , ,
STANDARD = 0
A Standard tournament
CLUB = 1
A new "clubhouse"
CHILD = 2
A club session or child tournament.
LEGACY = 3
A legacy tournament
message
tournament_service.proto:125Used as request type in: TournamentService.AddDivision, TournamentService.RemoveDivision
string id = 1
string division = 2
message
tournament_service.proto:95Used in:
string name = 1
optional game_request = 2
repeated round_controls = 3
optional division_controls = 4
Used to copy a tournament's settings (gibsonization, spread cap, etc).
message
tournament_service.proto:42Used in: , , , ,
string id = 1
string name = 2
string description = 3
description is the markdown information for the tournament on the right-hand side
string slug = 4
TType type = 5
string disclaimer = 6
a caption that shows up for the tournament in various places.
string tile_style = 7
tile_style if set is default
string board_style = 8
board_style if set is default
optional default_club_settings = 9
for clubs (not tournaments) we want to be able to hard-code settings if the following parameter is set.
repeated string freeform_club_setting_fields = 10
When setting the game request, some clubs would like some parameters to be more freeform (for example, lexicon option or time setting). The following parameter is a list of field names that are freeform. The acceptable values are: lexicon, time, challenge_rule, rating_mode, variant_name
string password = 11
a simple password for this tournament. Without it you can't see what is happening. Likely front-end only implementation, although password will be at least hashed. For clubs that want to be more private.
string logo = 12
a url to a logo in the metadata card, disclaimer card and center square.
string color = 13
an override color for the gradient in the tournament info
bool private_analysis = 14
bool irl_mode = 15
irl_mode allows tournament mode to be used for pairings for an over-the-board tournament, and will not enforce that usernames are registered on the site.
optional scheduled_start_time = 16
optional scheduled_end_time = 17
bool checkins_open = 18
bool registration_open = 19
bool monitored = 20
monitored enables invigilation/monitoring mode requiring participants to share camera and screenshot streams via vdo.ninja
string first_director = 21
first_director is the username of the first tournament director
int32 registrant_count = 22
registrant_count is the total number of registered players across all divisions
repeated divisions = 23
divisions contains a summary of each division for copy/template purposes
message
tournament_service.proto:130Used in:
string player_one_id = 1
string player_two_id = 2
int32 round = 3
ipc.TournamentGameResult self_play_result = 4
If player_one_id and player_two_id are the same, we should specify what we want the result to be (BYE, FORFEIT_LOSS, VOID)
message
tournament_service.proto:200Used as response type in: TournamentService.AddDirectors, TournamentService.AddDivision, TournamentService.AddPlayers, TournamentService.CheckIn, TournamentService.CloseCheckins, TournamentService.CloseRegistration, TournamentService.FinishTournament, TournamentService.InitializeMonitoringKeys, TournamentService.MovePlayer, TournamentService.OpenCheckins, TournamentService.OpenRegistration, TournamentService.PairRound, TournamentService.Register, TournamentService.RemoveAllPlayersNotCheckedIn, TournamentService.RemoveDirectors, TournamentService.RemoveDivision, TournamentService.RemovePlayers, TournamentService.RenameDivision, TournamentService.RequestMonitoringStream, TournamentService.ResetMonitoringStream, TournamentService.SetDivisionControls, TournamentService.SetPairing, TournamentService.SetResult, TournamentService.SetRoundControls, TournamentService.SetTournamentMetadata, TournamentService.StartRoundCountdown, TournamentService.UncheckAllIn, TournamentService.UnfinishTournament, TournamentService.UnstartTournament
repeated string warnings = 1
warnings are WooglesError strings for follow-on work that failed without failing the request, such as pairing a lagged round that was waiting for the round the request paired.