Cockatrice/libcockatrice_protocol/libcockatrice/protocol/pb/room_commands.proto
BruebachL 5ea16c805f
[Server/Client/Protocol] Shuffle or reorder player seats before a game starts (#7398)
* [Protocol] Add shuffle players option and player order command/event

Adds a 'Shuffle players at start' option to game creation plus a local
player id on the game state so clients can reconcile seat changes, and a
SET_PLAYER_ORDER command (1206) with a PLAYER_ORDER_CHANGED event (2023)
so the game host can set or randomize the seating order.

Took 6 minutes

* [Server] Shuffle and reorder player seats before a game starts

Auto-shuffles the seats at game start when enabled (now for games with
two or more players instead of three or more) and handles the new
SET_PLAYER_ORDER command so the game host or a moderator can reorder or
randomize the seats before the game starts. Re-seating re-keys the
player ids while keeping the per-user game/seat routing and persistent
player records in sync, then broadcasts the new order to everyone.

* [Client] Add shuffle players option and turn order dialog

Adds the 'Shuffle players at start' checkbox to game creation and a
host-only 'Set turn order...' action that opens a dialog to reorder or
randomize the seats before the game starts. Seating changes are shown in
the game's message log.

* [Client] Move the turn order dialog strings into retranslateUi

Follows the DlgInviteToGame convention so the dialog can be retranslated
instead of freezing its strings at construction time.

* [Server] Keep player ids stable across seat shuffles

* [Client] Lay out table and turn order dialog in seat order

* [Server] Send game-joined player list in seat order

* [Client] Reword the shuffle option to match its behaviour

* [Client] Address the seat-order review comments

- Give the game setup checkboxes a row of their own so they no longer
  collide in the create-game dialog
- Rename DlgTurnOrder::randomize() to isRandomizeRequested()
- Document what the ids in GameState::seatOrder mean
- Keep "Set turn order..." in sync with the game: hidden for non-hosts
  and once the game has started, re-shown when the game ends or hosting
  moves to the local player (new GameState::hostChanged signal)

* [Client] Do not preview a randomized turn order

Randomizing is a request to the server, not a local shuffle. Shuffling the
list locally meant the dialog showed an order the server then discarded, and
let the host re-open it until a favourable order appeared. The dialog now
switches to a mode that says the server will randomize and toggles back to the
manual list on request.

* [Client] Let moderators set the turn order

The server accepts SET_PLAYER_ORDER from the host or a moderator, but the
client hid the action from everyone except the host, making the moderator
branch unreachable. Visibility and the handler now share canSetTurnOrder().

* [Server] Rely on the player order event instead of a full state resend

cmdSetPlayerOrder re-sent the whole game state after reseating, so every
client reloaded its deck view mid-lobby for no reason. The new seating reaches
clients through the Event_PlayerOrderChanged that reseatPlayers broadcasts.

* [Client] Show random turn order in the game selector

The restrictions column listed "open decklists" but not the new seating
option, so a joining player had no way to see that seats will be randomized
each game. Game info already shows the disabled checkbox.

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
2026-11-04 15:44:50 +01:00

95 lines
2.6 KiB
Protocol Buffer

syntax = "proto2";
message RoomCommand {
enum RoomCommandType {
LEAVE_ROOM = 1000;
ROOM_SAY = 1001;
CREATE_GAME = 1002;
JOIN_GAME = 1003;
ROOM_CHANNEL_SAY = 1004;
}
extensions 100 to max;
}
message Command_LeaveRoom {
extend RoomCommand {
optional Command_LeaveRoom ext = 1000;
}
}
message Command_RoomSay {
extend RoomCommand {
optional Command_RoomSay ext = 1001;
}
optional string message = 1;
}
message Command_RoomChannelSay {
extend RoomCommand {
optional Command_RoomChannelSay ext = 1004;
}
optional string channel_id = 1;
optional string message = 2;
}
// Create a new game in the room
message Command_CreateGame {
extend RoomCommand {
optional Command_CreateGame ext = 1002;
}
// game description shown in game list
optional string description = 1;
// password users will have to provide to join the game
optional string password = 2;
// amount of players needed to play
optional uint32 max_players = 3;
// limits the game to only allowing users on the creator's buddy list to join
optional bool only_buddies = 4;
// limits the game to only allowing registered users
optional bool only_registered = 5;
// allows non players to view the game as spectator
optional bool spectators_allowed = 6;
// allows spectators to join without password if false
optional bool spectators_need_password = 7;
// allows spectators to use game say commands
optional bool spectators_can_talk = 8;
// allows spectators to see hands and hidden information
optional bool spectators_see_everything = 9;
// selection of game types as presented in the server's room configuration
repeated uint32 game_type_ids = 10;
// the creator of the game will join it as a judge
optional bool join_as_judge = 11;
// the creator of the game will join it as a spectator
optional bool join_as_spectator = 12;
// set the starting life total
optional uint32 starting_life_total = 13;
// share decklists with all players when selected
optional bool share_decklists_on_load = 14;
// shuffle the player order (seats) before each game starts
optional bool shuffle_players = 15;
}
message Command_JoinGame {
extend RoomCommand {
optional Command_JoinGame ext = 1003;
}
optional sint32 game_id = 1 [default = -1];
optional string password = 2;
optional bool spectator = 3;
optional bool override_restrictions = 4;
optional bool join_as_judge = 5;
}