spring rts lobby dev meeting proposals 26. feb. 2012

<!-- ####################################################################### -->
<!-- Proposal 0: Presentation of compat flags query protocol addendum -->

    <Command Name="LISTCOMPFLAGS" Source="client">
      <Description>
      Client may send this command after it has received <clink name="TASSERVER"/> to query server for supported compFlags that may be specified on <clink name="LOGIN" />.
      </Description>
      <Response>
      See <clink name="COMPFLAGS"/>.
      </Response>
    </Command>

    <Command Name="COMPFLAGS" Source="server">
      <Arguments>
        <Argument Name="compFlag1" />
        <Argument Name="compFlag2" />
        <Argument Name="..." />
      </Arguments>
      <Description>
      Sent as a response to a <clink name="LISTCOMPFLAGS"/> command.
      Server sends a list of supported compFlags that may be specified by client on <clink name="LOGIN" />.
      </Description>
      <Response />
      <Examples>
        <Example>COMPFLAGS a b</Example>
        <Example>COMPFLAGS a b sp</Example>
      </Examples>
    </Command>

<!-- ####################################################################### -->
<!-- Proposal 1: FORCEJOINBATTLE -->

    <Command Name="FORCEJOINBATTLE" Source="client">
     <Arguments>
        <Argument Name="user" />
        <Argument Name="BATTLE_ID" />
        <Argument Name="battlePassword" optional="true" />
       </Arguments>
      <Description>
      Client may send this command if it is a battle host or lobby moderator. Server will decide if they are and send  <clink name="FORCEJOINBATTLE"/> to user.
      </Description>
      <Response>
      See <clink name="FORCEJOINBATTLE"/>.
      </Response>
    </Command>

    <Command Name="FORCEJOINBATTLE" Source="server">
      <Arguments>
         <Argument Name="BATTLE_ID" />
        <Argument Name="battlePassword"  optional="true"/>
      </Arguments>
      <Description>
      Sent to user specified by previous <clink name="FORCEJOINBATTLE"/> command from client. Client must subsequently comply by sending a <clink name="JOINBATTLE"/>  command to server.
      </Description>
      <Response />
    </Command>

<!-- ####################################################################### -->
<!-- Proposal 2: CONNECTUSER -->

   <Command Name="CONNECTUSER" Source="client">
     <Arguments>
        <Argument Name="user" />
        <Argument Name="IP:port" />
        <Argument Name="scriptPassword" optional="true" />
       </Arguments>
      <Description>
      Client may send this command if it is a battle host or lobby moderator. Server will decide if they are and send  <clink name="CONNECTUSER"/> to user.
      </Description>
      <Response>
      See <clink name="CONNECTUSER"/>.
      </Response>
    </Command>
   <Command Name="CONNECTUSER" Source="server">
     <Arguments>
        <Argument Name="IP:port" />
        <Argument Name="scriptPassword" optional="true" />
       </Arguments>
      <Description>
      Client connects spring to given IP:port with given script password  <clink name="CONNECTUSER"/> to user.
      </Description>
      <Response>
      See <clink name="CONNECTUSER"/>.
      </Response>
    </Command>

<!-- ####################################################################### -->
<!-- Proposal 3: REQUESTDOWNLOAD -->

   <Command Name="REQUESTDOWNLOAD" Source="client">
     <Arguments>
        <Argument Name="user" />
        <Argument Name="type" values="map|game|engine"| />
        <Argument Name="resource" />
       </Arguments>
      <Description>
      Client may send this command if it is a battle host or lobby moderator. Server will decide if they are and send  <clink name="REQUESTDOWNLOAD"/> to user.
      </Description>
      <Response>
      See <clink name="REQUESTDOWNLOAD"/>.
      </Response>
    </Command>

   <Command Name="REQUESTDOWNLOAD" Source="server">
     <Arguments>
        <Argument Name="user" />
        <Argument Name="type" values="map|game|engine" />
        <Argument Name="resource" />
       </Arguments>
      <Description>
      Client starts download of given resource unless its already present <clink name="REQUESTDOWNLOAD"/>.
      </Description>
      <Response>
      See <clink name="REQUESTDOWNLOAD"/>.
      </Response>
    </Command>

   <Command Name="REPORTDOWNLOADPROGRESS" Source="client">
     <Arguments>
        <Argument Name="user" />
        <Argument Name="resource" />
        <Argument Name="progress"/>
        <Argument Name="eta"/>
       </Arguments>
      <Description>
      Client sends that at least 1x per 30s to requestor of download and sends 100 if resource is present
      Progress is in percents = 100 = done
       -1 = download failed
      Eta is in seconds
      <clink name="REQUESTDOWNLOAD"/>.
      </Description>
      <Response>
      See <clink name="REQUESTDOWNLOAD"/>.
      </Response>
    </Command>

   <Command Name="REPORTDOWNLOADPROGRESS" Source="server">
     <Arguments>
        <Argument Name="user" />
        <Argument Name="resource" />
        <Argument Name="progress"/>
        <Argument Name="eta"/>
       </Arguments>
      <Description>
      Client sends that at least 1x per 30s to requestor of download<clink name="REQUESTDOWNLOAD"/>.
      </Description>
      <Response>
      See <clink name="REQUESTDOWNLOAD"/>.
      </Response>
    </Command>

<!-- ####################################################################### -->
<!-- Proposal 4: FORCEJOINBATTLE -> JOINBATTLEFORCE -->

<!-- see title, thats all there is, there isn't anymore -->

<!-- ####################################################################### -->
<!-- Proposal 5: Change CPU info -->

<!-- ??? was this the... adding a table about special CPU values to the protocol doc? -->

<!-- ####################################################################### -->
<!-- 1.B Protocol - Add new commands for joining User -->

<!--
        // Suggest user to join me (Battleroom)
        JOINROOM {password}

        // User must tell Server that he wants to play some Game with Cooperative / FFA / Bugs
        JOINWANTED {game, mode, ...}

        // Then, the user status changed on Server
        // Then Server can join that user by force to any battleroom
        JOINROOMFORCE {password}

        // Suggest user to join me (Channel)
        JOINCHANNEL {password}
this is hugely incomplete.. there would need to be a way to register matchamking agents to server, to register game types, to exahcnge data from server to agent, to manage multiple agents etc..
too complex.. any such commands should be exchanged directly between user and agent
using private messages because its no concern for server
for that i propose
!juggler_list_preferences
lists in format ffa=2,1v1=0  etc
and
!juggler_set_preferneces
in same format
sent to Nightwatch
-->

<!-- ####################################################################### -->