XEP-xxxx: Tic-tac-toe

Abstract:This document defines how to play a Tic-tac-toe game over XMPP
Author:Torsten Grote
Copyright:© 1999 - 2009 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status:ProtoXEP
Type:Standards Track
Version:0.0.1
Last Updated:2009-03-14

WARNING: This document has not yet been accepted for consideration or approved in any official manner by the XMPP Standards Foundation, and this document must not be referred to as an XMPP Extension Protocol (XEP). If this document is accepted as a XEP by the XMPP Council, it will be published at <http://www.xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.


Table of Contents


1. Introduction
2. Requirements
3. Discovering Support
4. Invitation
5. Game Flow
6. Game Termination
7. Security Considerations
8. IANA Considerations
9. XMPP Registrar Considerations
10. XML Schema

Appendices
    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History


1. Introduction

It is quite common to play games over IM networks. Since Tic-tac-toe is a well known game, XMPP needs a protocol to support it.

2. Requirements

This protocol should provide all means to play a regular game of Tic-tac-toe over XMPP.

Tic-tac-toe is also one of the simplest games and played "just for fun". Therefore no validation support is needed. The typical duration is below one minute and the matches are not of great interest for non-players. Therefore spectators do not have to be supported as well. That is why this document only describes the protocol to play a Tic-tac-toe as a One-to-One match without support for game saving and resuming.

3. Discovering Support

An entity implementing this protocol MUST also support Instant Gaming [1] and answer to disco requests accordingly including both the Instant Gaming and the game <feature/> elements in the response.

Example 1. Juliet Informs Romeo That She is Capable of Playing Tic-tac-toe

<iq type='result'
    from='juliet@capulet.com/garden'
    to='romeo@montague.net/balcony'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    ...
    <feature var='http://jabber.org/protocol/games'/>
    <feature var='http://jabber.org/protocol/games/tictactoe'/>
    ...
  </query>
</iq>

4. Invitation

When inviting to a game of Tic-tac-toe, an entity SHOULD use Data Forms [2] to specify game options in the REQUIRED <game/> element. Possible options are "role" (of the inviting player), "rows" (height), "cols" (width) and "strike" (number of marks in a row needed to win). If these options are missing, all but role default to '3' and role defaults to 'x'. An implementation MUST be able to handle the default values. Everything beyond that is OPTIONAL.

Example 2. Romeo Invites Juliet

<message
    from='romeo@montague.net/garden'
    to='juliet@capulet.com/balcony'>
  <thread>juliet@capulet.com-romeo@montague.net-tictactoe-1591-02-23T11:36:25Z-4321</thread>
  <invite xmlns='http://jabber.org/protocol/games'
      transport='one-to-one'
      type='new'>
    <reason>
      Hello Juliet,
      would you like to play a little game?
    </reason>
    <game var='http://jabber.org/protocol/games/tictactoe'>
      <x xmlns='jabber:x:data' type='submit'>
        <field type='list-single' var='role'>
          <value>x</value>
        </field>
        <field type='text-single' var='rows'>
          <value>3</value>
        </field>
        <field type='text-single' var='cols'>
          <value>3</value>
        </field>
        <field type='text-single' var='strike'>
          <value>3</value>
        </field>
      </x>
    </game>
  </invite>
</message>

When sending an invitation of type "renew", the role option MUST be changed to the opposite of the role the inviting player had in the previous match with that match ID. So both players essentially switch their roles. All other options MUST stay the same.

5. Game Flow

During the game, players change in turn, each of them sending one move at a time. The player with the role 'x' makes the first move. A game move is represented as a <message/> stanza addressed to the full JID of the other player. It MUST have a <thread/> child element which specifies the match ID. Furthermore, the <message/> stanza contains a <turn/> element which in turn contains exactly one <move/> element qualified by 'http://jabber.org/protocol/games/tictactoe'. It MUST possess these attributes:

Table 1: <move/> attributes

Name Type Description
'id' REQUIRED The number of the move. First move is 1.
'row' REQUIRED The horizontal position of the mark.
'col' REQUIRED The vertical position of the mark.

Example 3. Part of the Match Between Romeo and Juliet

<message
    from='romeo@montague.net/room'
    to='juliet@capulet.com/room'
    type='chat'>
  <thread>juliet@capulet.com-romeo@montague.net-tictactoe-1591-02-23T11:36:25Z-4321</thread>
  <turn xmlns='http://jabber.org/protocol/games'>
    <move xmlns='http://jabber.org/protocol/games/tictactoe'
        row='2'
        col='2'
        id='1'/>
  </turn>
</message>

<message
    from='juliet@capulet.com/room'
    to='romeo@montague.net/room'
    type='chat'>
  <thread>juliet@capulet.com-romeo@montague.net-tictactoe-1591-02-23T11:36:25Z-4321</thread>
  <turn xmlns='http://jabber.org/protocol/games'>
    <move xmlns='http://jabber.org/protocol/games/tictactoe'
        row='2'
        col='3'
        id='2'/>
  </turn>
</message>

6. Game Termination

Notifying the players whether they have won or lost is in responsibility of the game client. The game is considered terminated when the board is full, i.e. nine moves have been made. For further termination conditions see the appropriate section of Instant Gaming [3].

7. Security Considerations

The author is not aware of any security issues introduced by this protocol extension.

8. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [4].

9. XMPP Registrar Considerations

The XMPP Registrar [5] shall include 'http://jabber.org/protocol/games/tictactoe' in its registry of protocols.

10. XML Schema

<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://jabber.org/protocol/games/tictactoe'
    xmlns='http://jabber.org/protocol/games/tictactoe'
    elementFormDefault='qualified'>

<xs:element name='move'>
  <xs:complexType>
    <xs:attribute name='col' type='positiveInteger'/>
    <xs:attribute name='row' type='positiveInteger'/>
    <xs:attribute name='id' type='positiveInteger'/>
  </xs:complexType>
</xs:element>

</xs:schema>
  

Appendices


Appendix A: Document Information

Series: XEP
Number: xxxx
Publisher: XMPP Standards Foundation
Status: ProtoXEP
Type: Standards Track
Version: 0.0.1
Last Updated: 2009-03-14
Approving Body: XMPP Council
Dependencies: XMPP Core, XEP-xxxx
Supersedes: None
Superseded By: None
Short Name: Not yet assigned


Appendix B: Author Information

Torsten Grote

Email: Torsten.Grote(ät)fsfe.de
JabberID: Torsten.Grote(ät)jabber.fsfe.org


Appendix C: Legal Notices

Copyright

This XMPP Extension Protocol is copyright © 1999 - 2009 by the XMPP Standards Foundation (XSF).

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. In no event shall the XMPP Standards Foundation or the authors of this Specification be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising out of the use or inability to use the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which may be found at <http://xmpp.org/extensions/ipr-policy.shtml> or obtained by writing to XSF, P.O. Box 1641, Denver, CO 80201 USA).

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 3920) and XMPP IM (RFC 3921) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.


Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <http://xmpp.org/about/discuss.shtml> for a complete list.

Errata may be sent to <editor@xmpp.org>.


Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".


Appendix G: Notes

1. XEP-xxxx: Instant Gaming <http://pidgin-games.sourceforge.net/xep/instant-gaming.html>.

2. XEP-0004: Data Forms <http://xmpp.org/extensions/xep-0004.html>.

3. XEP-xxxx: Instant Gaming <http://pidgin-games.sourceforge.net/xep/instant-gaming.html>.

4. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

5. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <http://xmpp.org/registrar/>.


Appendix H: Revision History

Version 0.0.1 (2009-03-14)

First Draft.

(tg)

END