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:344CheckIn allows players to check themselves in.
message
tournament_service.proto:216string id = 1
bool checkin = 2
message
tournament_service.proto:231string id = 1
bool delete_non_checked_in = 2
message
tournament_service.proto:228string id = 1
message
tournament_service.proto:393optional 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
message
tournament_service.proto:385string id = 1
string format = 2
bool use_real_names = 3
message
tournament_service.proto:391string exported = 1
message
tournament_service.proto:191string id = 1
GetMyTournaments returns tournaments where the authenticated user is a director.
message
tournament_service.proto:260(message has no fields)
message
tournament_service.proto:262repeated tournaments = 1
message
tournament_service.proto:251int32 limit = 1
optional limit for number of tournaments to return (default 100)
message
tournament_service.proto:256repeated tournaments = 1
message
tournament_service.proto:245(message has no fields)
message
tournament_service.proto:247repeated tournaments = 1
message
tournament_service.proto:410string id = 1
club_id
int32 count = 2
int32 offset = 3
message
tournament_service.proto:417repeated sessions = 1
message
tournament_service.proto:189string id = 1
message
tournament_service.proto:183string id = 1
User must provide the ID, or the slug (but not both)
string slug = 2
message
tournament_service.proto:194optional 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:434string tournament_id = 1
message
tournament_service.proto:438repeated participants = 1
message
tournament_service.proto:236string id = 1
bool show_opponents = 2
bool show_seeds = 3
bool show_qr_code = 4
message
tournament_service.proto:243bytes pdf_zip = 1
Monitoring/invigilation endpoints
message
tournament_service.proto:419string tournament_id = 1
MovePlayer moves a player from one division to another
message
tournament_service.proto:138string 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
message
tournament_service.proto:178string id = 1
string slug = 2
message
tournament_service.proto:229string id = 1
message
tournament_service.proto:227string id = 1
message
tournament_service.proto:110string id = 1
string division = 2
int32 round = 3
bool preserve_byes = 4
bool delete_pairings = 5
message
tournament_service.proto:201string id = 1
tournament id
int32 num_games = 2
int32 offset = 3
message
tournament_service.proto:208repeated games = 1
rpc Register (, )
tournament_service.proto:345message
tournament_service.proto:221string id = 1
string division = 2
bool register = 3
message
tournament_service.proto:214string id = 1
Input to RemoveDirectors should be director usernames.
Input to RemovePlayers should be player usernames
message
tournament_service.proto:132string id = 1
string division = 2
string new_name = 3
message
tournament_service.proto:423string tournament_id = 1
string stream_type = 2
"camera" or "screenshot"
message
tournament_service.proto:428string tournament_id = 1
string user_id = 2
string stream_type = 3
"camera" or "screenshot"
rpc RunCOP (, )
tournament_service.proto:370message
tournament_service.proto:266string 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:145string id = 1
string division = 2
repeated pairings = 3
message
tournament_service.proto:155TournamentResultOverrideRequest 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:104string id = 1
string division = 2
optional round_controls = 3
message
tournament_service.proto:96optional 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:170string 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:212string id = 1
message
tournament_service.proto:192string id = 1
message
tournament_service.proto:210string id = 1
message
tournament_service.proto:401Used 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: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:118Used as request type in: TournamentService.AddDivision, TournamentService.RemoveDivision
string id = 1
string division = 2
message
tournament_service.proto:90Used in:
string name = 1
optional game_request = 2
repeated round_controls = 3
message
tournament_service.proto:37Used 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:123Used 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:177Used 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.SetSingleRoundControls, TournamentService.SetTournamentMetadata, TournamentService.StartRoundCountdown, TournamentService.UncheckAllIn, TournamentService.UnfinishTournament, TournamentService.UnstartTournament
(message has no fields)