FAForever Lobby Server API 1.0.0

Since AsyncAPI can only model a publish/subscribe model, this spec only covers the server side of the bidirectional lobby connection

Servers

  • wss://ws.faforever.com/wssproduction
  • wss://ws.faforever.xyz/wsstest
  • ws://localhost/wslocal

Operations

  • RECEIVE

    Server receives clients request to host a game

    Operation IDserverHostGame

    Available only on servers:

    • #server

    Accepts the following message:

    Request to host a game
    Message IDHostGameRequest
    object

    Examples

  • RECEIVE

    Server receives clients request to join a game

    Operation IDserverJoinGame

    Available only on servers:

    • #server

    Accepts the following message:

    Request to join a game
    Message IDJoinGameRequest
    object

    Examples

  • RECEIVE

    Server receives clients request to get a session

    Operation IDserverRequestSession

    Available only on servers:

    • #server

    Accepts the following message:

    Request to get a session
    Message IDSessionRequest
    object

    Examples

  • RECEIVE

    Server receives clients request to add a friend/foe

    Operation IDserverAddSocial

    Available only on servers:

    • #server

    Accepts the following message:

    Request to add a friend/foe
    Message IDSocialAddRequest
    object

    Examples

  • RECEIVE

    Server receives clients request to remove a friend/foe

    Operation IDserverRemoveSocial

    Available only on servers:

    • #server

    Accepts the following message:

    Request to remove a friend/foe
    Message IDSocialRemoveRequest
    object

    Examples

  • RECEIVE

    Server receives avatar request

    Operation IDserverAvatarRequest

    Available only on servers:

    • #server

    Accepts the following message:

    Request to list all avatars or select one
    Message IDAvatarRequest
    object

    Examples

  • RECEIVE

    Server receives request to restore game session for a game

    Operation IDserverRestoreGameSession

    Available only on servers:

    • #server

    Accepts the following message:

    Request to restore game session for a game
    Message IDRestoreGameSessionRequest
    object

    Examples

  • RECEIVE

    Ping received

    Operation IDserverPing

    Available only on servers:

    • #server

    Accepts the following message:

    Ping
    Message IDPingMessage
    object

    Examples

  • RECEIVE

    Pong received

    Operation IDserverPong

    Available only on servers:

    • #server

    Accepts the following message:

    Pong
    Message IDPongMessage
    object

    Examples

  • RECEIVE

    Server receives admin action

    Operation IDserverAdminAction

    Available only on servers:

    • #server

    Accepts the following message:

    Admin commands
    Message IDAdminRequest
    object

    Examples

  • RECEIVE

    Server receives invite to party request

    Operation IDserverInviteToParty

    Available only on servers:

    • #server

    Accepts the following message:

    Request to invite a player to a party
    Message IDInviteToPartyRequest
    object

    Examples

  • RECEIVE

    Server receives accept to party request

    Operation IDserverAcceptInviteToParty

    Available only on servers:

    • #server

    Accepts the following message:

    Request to accept invite to a party
    Message IDAcceptInviteToPartyRequest
    object

    Examples

  • RECEIVE

    Server receives kick from party request

    Operation IDserverKickPlayerFromParty

    Available only on servers:

    • #server

    Accepts the following message:

    Request to kick a player from a party
    Message IDKickPlayerFromPartyRequest
    object

    Examples

  • RECEIVE

    Server leave party request

    Operation IDserverLeaveParty

    Available only on servers:

    • #server

    Accepts the following message:

    Request to leave a party
    Message IDLeavePartyRequest
    object

    Examples

  • RECEIVE

    Server unready party request

    Operation IDserverUnreadyParty

    Available only on servers:

    • #server

    Accepts the following message:

    Request to unready a party
    Message IDUnreadyPartyRequest
    object

    Examples

  • RECEIVE

    Server request to select party factions

    Operation IDserverSelectPartyFactions

    Available only on servers:

    • #server

    Accepts the following message:

    Request to set party factions
    Message IDSelectPartyFactionsRequest
    object

    Examples

  • RECEIVE

    Server request to join or leave matchmaking queue

    Operation IDserverSetMatchmakingStatus

    Available only on servers:

    • #server

    Accepts the following message:

    Request to join or leave matchmaking queue
    Message IDGameMatchmakingRequest
    object

    Examples

  • RECEIVE

    Server request to set player vetoes

    Operation IDserverSetPlayerVetoes

    Available only on servers:

    • #server

    Accepts the following message:

    Request to set player vetoes
    Message IDSetPlayerVetoesRequest
    object

    Examples

  • RECEIVE

    Server request to receive latest matchmaker info

    Operation IDserverGetMatchmakerInfo

    Available only on servers:

    • #server

    Accepts the following message:

    Request to receive latest matchmaker info
    Message IDMatchmakerInfoRequest
    object

    Examples

  • RECEIVE

    Server request to authenticate

    Operation IDserverAuthenticate

    Available only on servers:

    • #server

    Accepts the following message:

    Request to authenticate
    Message IDAuthenticateRequest
    object

    Examples

  • RECEIVE

    Server request response to is_ready request

    Operation IDserverGetIsReady

    Available only on servers:

    • #server

    Accepts the following message:

    Response to is_ready request
    Message IDIsReadyResponse
    object

    Examples

  • SEND

    Client requests to join a game

    Operation IDclientJoinGame

    Available only on servers:

    • #client

    Accepts the following message:

    Request to join a game
    Message IDJoinGameRequest
    object

    Examples

Messages

  • #1Request to host a game
    Message IDHostGameRequest
    object
  • #2Request to join a game
    Message IDJoinGameRequest
    object
  • #3Request to get a session
    Message IDSessionRequest
    object
  • #4Request to add a friend/foe
    Message IDSocialAddRequest
    object
  • #5Request to remove a friend/foe
    Message IDSocialRemoveRequest
    object
  • #6Request to list all avatars or select one
    Message IDAvatarRequest
    object
  • #7Request to restore game session for a game
    Message IDRestoreGameSessionRequest
    object
  • #8Ping
    Message IDPingMessage
    object
  • #9Pong
    Message IDPongMessage
    object
  • #10Admin commands
    Message IDAdminRequest
    object
  • #11Request to invite a player to a party
    Message IDInviteToPartyRequest
    object
  • #12Request to accept invite to a party
    Message IDAcceptInviteToPartyRequest
    object
  • #13Request to kick a player from a party
    Message IDKickPlayerFromPartyRequest
    object
  • #14Request to leave a party
    Message IDLeavePartyRequest
    object
  • #15Request to unready a party
    Message IDUnreadyPartyRequest
    object
  • #16Request to set party factions
    Message IDSelectPartyFactionsRequest
    object
  • #17Request to join or leave matchmaking queue
    Message IDGameMatchmakingRequest
    object
  • #18Request to set player vetoes
    Message IDSetPlayerVetoesRequest
    object
  • #19Request to receive latest matchmaker info
    Message IDMatchmakerInfoRequest
    object
  • #20Request to authenticate
    Message IDAuthenticateRequest
    object
  • #21Response to is_ready request
    Message IDIsReadyResponse
    object