This is Info file pm.info, produced by Makeinfo version 1.68 from the input file bigpm.texi.  File: pm.info, Node: Games/Cards/Tk, Next: Games/Cards/Undo, Prev: Games/Cards, Up: Module List Package to write Tk ports for Games::Cards card games ***************************************************** NAME ==== Games::Cards::Tk - Package to write Tk ports for Games::Cards card games SYNOPSIS ======== See *Note Games/Cards: Games/Cards, for all the non-GUI aspects of writing card games. use Games::Cards; use Games::Cards::Tk; # Create a canvas and print background etc. $My_Game->set_canvas($c); # my game will use canvas $c # ... do lots of things you do in Games::Cards anyway # Cards' Tk images will be moved automatically! $Stock->give_cards($Waste, 3); # Mark clicked card $card = $My_Game->get_card_by_tag("current"); $card->mark; DESCRIPTION =========== WARNING!!! ---------- This module is doubleplus alpha. It's entirely possible that large parts of it will be changing as I learn more Tk, and if you try to write a game that's much different from the included games, it may break. There's still some stuff that needs to be better modularized, abstracted, and otherwise made into good code. However, the current games seem to be pretty good for a first try, and I'd like to get comments in case I'm doing anything really stupid. Overview -------- Each class in Games::Cards had a corresponding Games::Cards::Tk class. The classes are meant to be exactly the same, except that the Tk ones also take care of moving actual card images around the screen. The card images used were created by Oliver Xymoron (oxymoron@waste.org). Class Games::Cards::Tk::Game ---------------------------- This class ends up holding information - such as the canvas that the game is played on, card images - and methods like finding a card given its tag. card_width card_height The size of card images load_card_images Loads the card images and stores them to draw later. card_image Returns the card image associated with this card. get_card_by_tag Given a tag, return the Card (on this Games' canvas) that has that tag, if any. get_card_by_tag Given a tag, return the CardSet (on this Games' canvas) that has that tag, if any. get_marked_card Is a card marked? If so, return it. get_clicked_cardset Return the set which was clicked on. Do so by looking for the "current" tag, but note that that tag may apply either to a CardSet or to a Card in that set. canvas set_canvas(Canvas) Return/set the Tk::Canvas associated with this Game Class Games::Cards::Tk::Card ---------------------------- A Card is represented in GC::Tk as two rectangles, the front and back, which are always moved around together. The card is "turned over" by raising the front or back rectangle (but the face_up/face_down methods do that automatically for you). Lots of methods are basically the same as Games::Cards::Card methods. We just have to add some GUI changes. But there are also some Tk-specific methods. Tk_truename This returns a Tk tag that's guaranteed to belong to just one Card. (However, note this tag will include the card's front and back rectangles.) Tk_truename_front and Tk_truename_back return tags that will access just the front or back image. unmark Unmark a card that was marked with the "mark" method. place(X, Y) Put a Card's images at X, Y. redraw Redraw (i.e. raise) the card & make sure you're showing front/back correctly. Class Games::Cards::Tk::Deck ---------------------------- This class exists but isn't terribly interesting. The main point is that by calling this class' new instead of Games::Cards::Deck::new, you automatically get a deck filled with Games::Cards::Tk::Cards instead of regular cards. Class Games::Cards::Tk::CardSet ------------------------------- This class has extra methods to do Tk stuff to CardSets, i.e. drawing columns, rows, piles, hands of cards. There are a few extra fields in the Tk version of the class: delta_x x distance between right side of one card and the next in the Set. 0 if you want the cards to totally overlap, some number of pixels smaller than a card if you want them to overlap some, larger than cardsize if you want them to not overlap at all. border_x A column may be slightly wider/higher than the cards in it, for example. Also delta_y and border_y. Fields are changed by the "attributes" method. attributes(HASHREF) This is a copout way of setting a bunch of CardSet attributes in one shot. Settable attributes include: delta_x/y and border_x/y. Hashref's keys are attributes and values are things to set them to. redraw Redraw the Cards in this CardSet. This is the reason you have to set things like delta_y and border_x.  File: pm.info, Node: Games/Cards/Undo, Next: Games/Chess, Prev: Games/Cards/Tk, Up: Module List undoing/redoing moves in Games::Cards games ******************************************* NAME ==== Games::Cards::Undo - undoing/redoing moves in Games::Cards games SYNOPSIS ======== use Games::Cards::Undo; $Undo = new Games::Cards::Undo(100); # Make undo engine to save 100 moves $Undo->undo; # undo last move $Undo->redo; # redo last undone move $Undo->end_move; # tell undo engine we're done with a move DESCRIPTION =========== This is the package for methods to undo & redo moves. The GC::Undo object has no publicly accessible fields. But it stores an array of the preceding moves. Note that a "move" is made up of several "atoms" (objects of the private class GC::Undo::Atom and its subclassess). For example, moving a card from one column to another in solitaire involves one or more Splice atoms (removing or adding card(s) to a CardSet) and possibly a Face atom (turning a card over). Many of the GC::Undo methods (and all of the GC::Undo::Atom methods) will be called by other Games::Cards methods, but not by the actual games. Here are the publicly accesssible methods: new(MOVES) Initialize the Undo engine. MOVES is the number of atoms to save. 0 (or no argument) allows infinite undo. This method must be called before any undo-able moves are made (i.e., it can be called after the hands are dealt). This method will also re-initialize the engine for a new game. end_move End the current move. Everything between the last call to end_move and now is considered one move. This tells undo how much to undo. undo Undo a move. redo Redo a move that had been undone with undo.  File: pm.info, Node: Games/Chess, Next: Games/Chess/PGN, Prev: Games/Cards/Undo, Up: Module List represent chess positions and games *********************************** NAME ==== Games::Chess - represent chess positions and games SYNOPSIS ======== use Games::Chess qw(:constants); my $p = Games::Chess::Position->new; $p->at(0,0,BLACK,ROOK); $p->at(7,7,WHITE,ROOK); print $p->to_text; DESCRIPTION =========== The `Games::Chess' package provides the class `Games::Chess::Piece' to represent chess pieces, and the class `Games::Chess::Position' to represent a position in a chess game. Objects can be instantiated from data in standard formats and exported to these formats. NOTATION ======== See *Note Games/Chess/PGN: Games/Chess/PGN, for full details of the notations. SAN Standard Algebraic Notation. The modern international notation for chess games. For example, 1. e4 e5 2. f4 exf4 3. Nf3 g5 FEN Forsythe-Edwards Notation. A compact representation for chess positions. FEN specifies the piece placement, the active color, the castling availability, the en passant target square, the halfmove clock, and the fullmove number as six fields separated by spaces. For example, the opening position is described in FEN as follows: rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1 PGN Portable Game Notation. A notation for chess games, including the moves, commentary, variations, and metadata such as the players, the event, the round number, and the date of the match. For example, [Event "F/S Return Match"] [Site "Belgrade, Serbia JUG"] [Date "1992.11.04"] [Round "29"] [White "Fischer, Robert J."] [Black "Spassky, Boris V."] [Result "1/2-1/2"] 1. e4 e5 2. Nf3 Nc6 3. Bb5 a6 4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7 11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5 Nxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6 23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5 hxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5 35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6 Nf2 42. g4 Bd3 43. Re6 1/2-1/2 EPD Extended Position Description. An extensible notation based on FEN. Intended for data interchange between chess-playing programs and for the construction of opening databases. Not used by `Games::Chess'. ERROR HANDLING ============== All the `Games::Chess::*' packages share a common error-handling protocol, depending on the debugging level passed to the `Games::Chess::debug' function. (The debugging level is 0 by default.) At debugging level 0, each function and method returns undefined if it is passed invalid arguments or if some other error happens. A description of the error is available by calling `Games::Chess::errmsg'. At debugging level 1, each function and method returns undefined if it is passed invalid arguments or if some other error happens. A warning is also issued. A description of the error is available by calling `Games::Chess::errmsg'. At debugging level 2, each function and method calls die if it is passed invalid arguments. CONSTANTS ========= Piece colours are represented by the constants `BLACK' and `WHITE'. Piece values are represented by the constants `PAWN', `KNIGHT', `BISHOP', `ROOK', `QUEEN', and `KING'. To import these constants into your namespace, include the tags `:colours' (colours only), `:pieces' (piece values only), or `:constants' (all constants) in the use statement. For example: use Games::Chess qw(:colours); (If you `use strict;', you'll have to write these constants as function calls like `WHITE()' or `&WHITE' to satisfy the compiler.) FUNCTIONS ========= To import all these functions into your namespace, include the tag `:functions' in the use statement, for example use Games::Chess qw(:functions); algebraic_to_xy($square) If $square represents a square in Standard Algebraic Notation (from a1 to h8), return a list of two elements ($x,$y) giving the coordinates of that square, from (0,0) to (7,7). Return undefined otherwise. colour_valid($colour) Return 1 if $colour is a valid colour value, `WHITE' or `BLACK'. Return undefined otherwise. debug($level) Set the debugging level. See `ERROR HANDLING' in this node. errmsg Return a description of the most recent error in any of the `Games::Chess::*' packages, or the empty string if no errors have occurred. See `ERROR HANDLING' in this node. halfmove_valid($halfmove) Return 1 if $halfmove is a valid value for the halfmove clock, which counts the number of ply (moves by either player) since the last pawn move or capture. Return undefined otherwise. move_valid($move) Return 1 if $move is a valid value for the full move count (the number of black moves since the start of the game, plus 1). Return undefined otherwise. piece_valid($piece) Return 1 if $piece is a valid piece value, from `PAWN' to `KING'. Return undefined otherwise. xy_to_algebraic($x,$y) If ($x,$y) is a valid board position, from (0,0) to (7,7), return the algebraic notation for that square, from `a1' to `h8'. Return undefined otherwise. xy_valid($x,$y) Return 1 if ($x,$y) is a valid board position, from (0,0) to (7,7). Return undefined otherwise. CHESS PIECES ============ A chess piece, or an empty square on a chess board, is represented as an object belonging to the `Games::Chess::Piece' class. PIECE REPRESENTATION -------------------- A chess piece is represented as a reference to an 8-bit value where bits 0-2 are the piece type (0 = empty square, 1 = pawn, 2 = knight, 3 = bishop, 4 = rook, 5 = queen and 6 = king) and bits 3-4 are the piece color (0 = empty square, 1 = white, 2 = black). Bits 5-7 are reserved for future use. So for example, a black knight is represented as the binary value 00010010 (decimal 18). PIECE CONSTRUCTORS ------------------ Piece->new With no argument, return an object representing an empty square. Piece->new($piece) With a single argument that is a member of the `Games::Chess::Piece' class, return an object representing the same piece as $piece. Piece->new($number) With a numeric argument, return an object representing a piece with that encoding. Return undefined if $number is not an integer in the range 0 to 255. Piece->new($character) With a single character string as an argument, return an object representing a piece with that encoding in the standard Forsythe-Edwards Notation. A space represents an empty square, and the letters P, N, B, R, Q, and K represent pawn, knight, bishop, rook, queen, and king respectively. Upper-case letters represent white pieces and lower-case letters black pieces. Return undefined if $character does not represent a piece. Piece->new($color,$piece) Return an object representing the piece described. Return undefined if $color is not WHITE or BLACK, or $piece is not PAWN, KNIGHT, BISHOP, ROOK, QUEEN or KING. PIECE METHODS ------------- Piece->code Return the FEN code for the piece as a single character (PNBRQKpnbrqk), or a space if the piece represents an empty square. Piece->colour Return EMPTY, `WHITE' or `BLACK' as appropriate. Piece->colour_name Return "empty", "white" or "black" as appropriate. Piece->name Return a string describing the piece, for example "black knight", or "white king", or "empty square". Piece->piece Return EMPTY, `PAWN', `KNIGHT', `BISHOP', `ROOK', `QUEEN', or `KING' as appropriate. Piece->piece_name Return "square", "pawn", "knight", "bishop", "rook", "queen", or "king" as appropriate. CHESS POSITIONS =============== A chess position represented as an object belonging to the `Games::Chess::Position' class. POSITION REPRESENTATION ----------------------- A chess position is represented as a reference to a hash, whose board member is a vector of 64 bytes, where the square at FILE,RANK is at byte (FILE*8)+RANK. For example, square c7 is at byte (2*8)+6 = 22. Each byte is in the format described for the `Games::Chess::Piece' class, above. The representation is reasonably compact: a position is represented in 64 bytes. But more importantly, it is easy and efficient to manipulate in C; you can cast the vector to a 2-dimensional array using code like unsigned char (*position)[8][8] = (unsigned char(*)[8][8])vector; and then position[x][y] refers to the square at file x, rank y. POSITION CONSTRUCTORS --------------------- Position->new With no argument, return an object representing a position with all 16 pieces in their initial positions. Position->new($position) With a single argument that is a member of the `Games::Chess::Position' class, return a copy of $position. Position->new($FEN) With one string argument, return an object representing the chess position described by the Forsythe-Edwards Notation string $FEN. The Position constructor does not require $FEN to contain all six FEN fields; only the first (the piece placement) is required. The remaining five fields, if missing, take the values `w - - 0 1'. POSITION METHODS ---------------- Position->at($x,$y) If ($x,$y) is a valid board position, return an object of class `Games::Chess::Piece' representing the square at ($x,$y). Return undefined otherwise. Position->at($x,$y,@piece) If ($x,$y) is a valid board position, and @piece would be valid as arguments to the `Games::Chess::Piece' constructor (see `PIECE CONSTRUCTORS' in this node), put the specified piece on the specified square and return 1. Return undefined otherwise. Position->board Return the board position as a vector of 64 bytes. Position->can_castle($colour,$piece) If $colour is a valid colour, and $piece is `KING' or `QUEEN', return true if the player given by $colour can castle on the side given by $piece, false if they cannot. Return undefined otherwise. Position->can_castle($colour,$piece,$can_castle) If $colour is a valid colour, and $piece is `KING' or `QUEEN', set the castling availability for the player given by $colour and the side given by $piece to the truth value of $can_castle, and return 1. Return undefined otherwise. Position->clear($x,$y) If ($x,$y) is a valid board position, clear the specified square and return 1. Return undefined otherwise. Equivalent to Position->at($x,$y,Piece->new); Position->en_passant Return the en passant target square as the list (FILE,RANK), or undefined if there is no en passant target square. Position->en_passant($x,$y) If ($x,$y) is a valid board position, set the en passant target square to ($x,$y) and return 1. Return undefined otherwise. Position->halfmove_clock Return the halfmove clock (the number of ply since the last pawn move or capture). Position->halfmove_clock($halfmove) If $halfmove is a valid halfmove clock value, set the halfmove clock to $halfmove and return 1. Return undefined otherwise. Position->move_number Return the move number (the number of full moves since the beginning of the game, plus 1). Position->move_number($move) If $move is a valid move number, set the move number to $move and return 1. Return undefined otherwise. Position->player_to_move Return `WHITE' if white is to move, `BLACK' otherwise. Position->player_to_move($colour) If $colour is `WHITE' or `BLACK', set the player to move to $colour and return 1. Return undefined otherwise. Position->to_FEN Return a string representing the board position in Forsythe-Edwards notation. For example, the initial position is returned as the string rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1 Position->to_GIF(option => value, ...) Return a string representing the board position as a GIF (an image in Graphics Interchange Format). The following options can be passed to control the image: border The width of the black border around the chess board, in pixels (defaults to 2). letters If true, draw a margin to the left of the board containing rank numbers, and a margin below the board containing file letters (defaults to true). bmargin The height of the margin to draw below the board (containing the file letters), in pixels (defaults to 20). Ignored if the letters option is false. lmargin The width of the margin to draw to the left of the board (containing the rank numbers), in pixels (defaults to 20). Ignored if the letters option is false. font A reference to a `GD::Font' object describing the font to use to draw the rank numbers and file letters (defaults to `GD::Font::Giant'). Ignored if the letters option is false. Position->to_text Return a string representing the board position as an ASCII diagram. For example, the initial position is returned as the string r n b q k b n r p p p p p p p p . . . . . . . . . . . . . . . . P P P P P P P P R N B Q K B N R Position->validate Apply some simple validation tests to the position. Return 1 if the position passes the tests, undefined otherwise. If the position fails to validate, the reason for failure can be found by calling `Games::Chess::errmsg'. These tests are applied: 1. The total of pawns plus obviously promoted pieces (for example, a second queen or a third rook) must be no more than 8 on each side. 2. Each side must have exactly one king. 3. There must be no pawns on ranks 1 and 8. 4. The en passant target square, if specified, must be plausible. That is, if white is to move, the ep square must be on rank 6, with a black pawn on rank 5 and empty squares on ranks 6 and 7 in that file. If black is to move, the ep square must be on rank 3, with a white pawn on rank 4 and empty squares on ranks 2 and 3 in that file. 5. The castling availability must be plausible. For example, if white can castle queenside, there must be a white rook on a1 and a white king on e1. 6. The halfmove count must be between 0 and 50 (it can't be greater than 50 or the game would have been drawn). 7. The full move number must be 1 or more. BUGS ==== * No representation of chess moves. * No representation of chess games and no support for PGN. * No simple way to clear the en passant target square. * No way to choose a different font for the chess pieces when creating a GIF (if anyone knows an easy way to do this, I'd love to know about it). * No way to choose the size of the chess pieces when creating a GIF. SEE ALSO ======== *Note Games/Chess/PGN: Games/Chess/PGN, - a description of the Portable Game Notation (PGN) standard, incorporating Standard Algebraic Notation (SAN), Forsythe-Edwards Notation (FEN) and Extended Position Description (EPD). (Steven J. Edwards) *Note GD: GD, - a Perl interface to Tom Boutell's `libgd' graphics library. (Lincoln Stein) AUTHOR ====== Gareth Rees `'. COPYRIGHT ========= Copyright (c) 1999 Gareth Rees. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  File: pm.info, Node: Games/Chess/PGN, Next: Games/Chess/Referee, Prev: Games/Chess, Up: Module List Portable Game Notation for Chess ******************************** NAME ==== PGN - Portable Game Notation for Chess DESCRIPTION =========== This is the Portable Game Notation Specification and Implementation Guide, as revised on 12th March 1994. AUTHOR ====== Interested readers of the Internet newsgroup rec.games.chess, coordinated by Steven J. Edwards `'. 0. PREFACE ========== From the Tower of Babel story: "If now, while they are one people, all speaking the same language, they have started to do this, nothing will later stop them from doing whatever they propose to do." Genesis XI, v.6, New American Bible 1. INTRODUCTION =============== PGN is "Portable Game Notation", a standard designed for the representation of chess game data using ASCII text files. PGN is structured for easy reading and writing by human users and for easy parsing and generation by computer programs. The intent of the definition and propagation of PGN is to facilitate the sharing of public domain chess game data among chessplayers (both organic and otherwise), publishers, and computer chess researchers throughout the world. PGN is not intended to be a general purpose standard that is suitable for every possible use; no such standard could fill all conceivable requirements. Instead, PGN is proposed as a universal portable representation for data interchange. The idea is to allow the construction of a family of chess applications that can quickly and easily process chess game data using PGN for import and export among themselves. 2. CHESS DATA REPRESENTATION ============================ Computer usage among chessplayers has become quite common in recent years and a variety of different programs, both commercial and public domain, are used to generate, access, and propagate chess game data. Some of these programs are rather impressive; most are now well behaved in that they correctly follow the Laws of Chess and handle users' data with reasonable care. Unfortunately, many programs have had serious problems with several aspects of the external representation of chess game data. Sometimes these problems become more visible when a user attempts to move significant quantities of data from one program to another; if there has been no real effort to ensure portability of data, then the chances for a successful transfer are small at best. 2.1 DATA INTERCHANGE INCOMPATIBILITY ------------------------------------ The reasons for format incompatibility are easy to understand. In fact, most of them are correlated with the same problems that have already been seen with commercial software offerings for other domains such as word processing, spreadsheets, fonts, and graphics. Sometimes a manufacturer deliberately designs a data format using encryption or some other secret, proprietary technique to "lock in" a customer. Sometimes a designer may produce a format that can be deciphered without too much difficulty, but at the same time publicly discourage third party software by claiming trade secret protection. Another software producer may develop a non-proprietary system, but it may work well only within the scope of a single program or application because it is not easily expandable. Finally, some other software may work very well for many purposes, but it uses symbols and language not easily understood by people or computers available to those outside the country of its development. 2.2 SPECIFICATION GOALS ----------------------- A specification for a portable game notation must observe the lessons of history and be able to handle probable needs of the future. The design criteria for PGN were selected to meet these needs. These criteria include: 1. The details of the system must be publicly available and free of unnecessary complexity. Ideally, if the documentation is not available for some reason, typical chess software developers and users should be able to understand most of the data without the need for third party assistance. 2. The details of the system must be non-proprietary so that users and software developers are unrestricted by concerns about infringing on intellectual property rights. The idea is to let chess programmers compete in a free market where customers may choose software based on their real needs and not based on artificial requirements created by a secret data format. 3. The system must work for a variety of programs. The format should be such that it can be used by chess database programs, chess publishing programs, chess server programs, and chessplaying programs without being unnecessarily specific to any particular application class. 4. The system must be easily expandable and scalable. The expansion ability must include handling data items that may not exist currently but could be expected to emerge in the future. (Examples: new opening classifications and new country names.) The system should be scalable in that it must not have any arbitrary restrictions concerning the quantity of stored data. Also, planned modes of expansion should either preserve earlier databases or at least allow for their automatic conversion. 5. The system must be international. Chess software users are found in many countries and the system should be free of difficulties caused by conventions local to a given region. 6. Finally, the system should handle the same kinds and amounts of data that are already handled by existing chess software and by print media. 2.3 A SAMPLE PGN GAME --------------------- Although its description may seem rather lengthy, PGN is actually fairly simple. A sample PGN game follows; it has most of the important features described in later sections of this document. [Event "F/S Return Match"] [Site "Belgrade, Serbia JUG"] [Date "1992.11.04"] [Round "29"] [White "Fischer, Robert J."] [Black "Spassky, Boris V."] [Result "1/2-1/2"] 1. e4 e5 2. Nf3 Nc6 3. Bb5 a6 4. Ba4 Nf6 5. O-O Be7 6. Re1 b5 7. Bb3 d6 8. c3 O-O 9. h3 Nb8 10. d4 Nbd7 11. c4 c6 12. cxb5 axb5 13. Nc3 Bb7 14. Bg5 b4 15. Nb1 h6 16. Bh4 c5 17. dxe5 Nxe4 18. Bxe7 Qxe7 19. exd6 Qf6 20. Nbd2 Nxd6 21. Nc4 Nxc4 22. Bxc4 Nb6 23. Ne5 Rae8 24. Bxf7+ Rxf7 25. Nxf7 Rxe1+ 26. Qxe1 Kxf7 27. Qe3 Qg5 28. Qxg5 hxg5 29. b3 Ke6 30. a3 Kd6 31. axb4 cxb4 32. Ra5 Nd5 33. f3 Bc8 34. Kf2 Bf5 35. Ra7 g6 36. Ra6+ Kc5 37. Ke1 Nf4 38. g3 Nxh3 39. Kd2 Kb5 40. Rd6 Kc5 41. Ra6 Nf2 42. g4 Bd3 43. Re6 1/2-1/2 3. FORMATS: IMPORT AND EXPORT ============================= There are two formats in the PGN specification. These are the "import" format and the "export" format. These are the two different ways of formatting the same PGN data according to its source. The details of the two formats are described throughout the following sections of this document. Other than formats, there is the additional topic of PGN presentation. While both PGN import and export formats are designed to be readable by humans, there is no recommendation that either of these be an ultimate mode of chess data presentation. Rather, software developers are urged to consider all of the various techniques at their disposal to enhance the display of chess data at the presentation level (i.e., highest level) of their programs. This means that the use of different fonts, character sizes, color, and other tools of computer aided interaction and publishing should be explored to provide a high quality presentation appropriate to the function of the particular program. 3.1 IMPORT FORMAT ALLOWS FOR MANUALLY PREPARED DATA --------------------------------------------------- The import format is rather flexible and is used to describe data that may have been prepared by hand, much like a source file for a high level programming language. A program that can read PGN data should be able to handle the somewhat lax import format. 3.2 EXPORT FORMAT USED FOR PROGRAM GENERATED OUTPUT --------------------------------------------------- The export format is rather strict and is used to describe data that is usually prepared under program control, something like a pretty printed source program reformatted by a compiler. 3.2.1 BYTE EQUIVALENCE ---------------------- For a given PGN data file, export format representations generated by different PGN programs on the same computing system should be exactly equivalent, byte for byte. 3.2.2 ARCHIVAL STORAGE AND THE NEWLINE CHARACTER ------------------------------------------------ Export format should also be used for archival storage. Here, "archival" storage is defined as storage that may be accessed by a variety of computing systems. The only extra requirement for archival storage is that the newline character have a specific representation that is independent of its value for a particular computing system's text file usage. The archival representation of a newline is the ASCII control character LF (line feed, decimal value 10, hexadecimal value 0x0a). Sadly, there are some accidents of history that survive to this day that have baroque representations for a newline: multicharacter sequences, end-of-line record markers, start-of-line byte counts, fixed length records, and so forth. It is well beyond the scope of the PGN project to reconcile all of these to the unified world of ANSI C and the those enjoying the bliss of a single '\n' convention. Some systems may just not be able to handle an archival PGN text file with native text editors. In these cases, an indulgence of sorts is granted to use the local newline convention in non-archival PGN files for those text editors. 3.2.3 SPEED OF PROCESSING ------------------------- Several parts of the export format deal with exact descriptions of line and field justification that are absent from the import format details. The main reason for these restrictions on the export format are to allow the construction of simple data translation programs that can easily scan PGN data without having to have a full chess engine or other complex parsing routines. The idea is to encourage chess software authors to always allow for at least a limited PGN reading capability. Even when a full chess engine parsing capability is available, it is likely to be at least two orders of magnitude slower than a simple text scanner. 3.2.4 REDUCED EXPORT FORMAT --------------------------- A PGN game represented using export format is said to be in "reduced export format" if all of the following hold: 1) it has no commentary, 2) it has only the standard seven tag roster identification information ("STR", see below), 3) it has no recursive annotation variations ("RAV", see below), and 4) it has no numeric annotation glyphs ("NAG", see below). Reduced export format is used for bulk storage of unannotated games. It represents a minimum level of standard conformance for a PGN exporting application. 4. LEXICOGRAPHICAL ISSUES ========================= PGN data is composed of characters; non-overlapping contiguous sequences of characters form lexical tokens. 4.1 CHARACTER CODES ------------------- PGN data is represented using a subset of the eight bit ISO 8859/1 (Latin 1) character set. This set is also known as ECMA-94 and is similar to other ISO Latin character sets. ISO 8859/1 includes the standard seven bit ASCII character set for the 32 control character code values from zero to 31. The 95 printing character code values from 32 to 126 are also equivalent to seven bit ASCII usage. (Code value 127, the ASCII DEL control character, is a graphic character in ISO 8859/1; it is not used for PGN data representation.) The 32 ISO 8859/1 code values from 128 to 159 are non-printing control characters. They are not used for PGN data representation. The 32 code values from 160 to 191 are mostly non-alphabetic printing characters and their use for PGN data is discouraged as their graphic representation varies considerably among other ISO Latin sets. Finally, the 64 code values from 192 to 255 are mostly alphabetic printing characters with various diacritical marks; their use is encouraged for those languages that require such characters. The graphic representations of this last set of 64 characters is fairly constant for the ISO Latin family. Printing character codes outside of the seven bit ASCII range may only appear in string data and in commentary. They are not permitted for use in symbol construction. Because some PGN users' environments may not support presentation of non-ASCII characters, PGN game authors should refrain from using such characters in critical commentary or string values in game data that may be referenced in such environments. PGN software authors should have their programs handle such environments by displaying a question mark ("?") for non-ASCII character codes. This is an important point because there are many computing systems that can display eight bit character data, but the display graphics may differ among machines and operating systems from different manufacturers. Only four of the ASCII control characters are permitted in PGN import format; these are the horizontal and vertical tabs along with the linefeed and carriage return codes. The external representation of the newline character may differ among platforms; this is an acceptable variation as long as the details of the implementation are hidden from software implementors and users. When a choice is practical, the Unix "newline is linefeed" convention is preferred. 4.2 TAB CHARACTERS ------------------ Tab characters, both horizontal and vertical, are not permitted in the export format. This is because the treatment of tab characters is highly dependent upon the particular software in use on the host computing system. Also, tab characters may not appear inside of string data. 4.3 LINE LENGTHS ---------------- PGN data are organized as simple text lines without any special bytes or markers for secondary record structure imposed by specific operating systems. Import format PGN text lines are limited to having a maximum of 255 characters per line including the newline character. Lines with 80 or more printing characters are strongly discouraged because of the difficulties experienced by common text editors with long lines. In some cases, very long tag values will require 80 or more columns, but these are relatively rare. An example of this is the "FEN" tag pair; it may have a long tag value, but this particular tag pair is only used to represent a game that doesn't start from the usual initial position. 5. COMMENTARY ============= Comment text may appear in PGN data. There are two kinds of comments. The first kind is the "rest of line" comment; this comment type starts with a semicolon character and continues to the end of the line. The second kind starts with a left brace character and continues to the next right brace character. Comments cannot appear inside any token. Brace comments do not nest; a left brace character appearing in a brace comment loses its special meaning and is ignored. A semicolon appearing inside of a brace comment loses its special meaning and is ignored. Braces appearing inside of a semicolon comments lose their special meaning and are ignored. *** Export format representation of comments needs definition work. 6. ESCAPE MECHANISM =================== There is a special escape mechanism for PGN data. This mechanism is triggered by a percent sign character ("%") appearing in the first column of a line; the data on the rest of the line is ignored by publicly available PGN scanning software. This escape convention is intended for the private use of software developers and researchers to embed non-PGN commands and data in PGN streams. A percent sign appearing in any other place other than the first position in a line does not trigger the escape mechanism. 7. TOKENS ========= PGN character data is organized as tokens. A token is a contiguous sequence of characters that represents a basic semantic unit. Tokens may be separated from adjacent tokens by white space characters. (White space characters include space, newline, and tab characters.) Some tokens are self delimiting and do not require white space characters. A string token is a sequence of zero or more printing characters delimited by a pair of quote characters (ASCII decimal value 34, hexadecimal value 0x22). An empty string is represented by two adjacent quotes. (Note: an apostrophe is not a quote.) A quote inside a string is represented by the backslash immediately followed by a quote. A backslash inside a string is represented by two adjacent backslashes. Strings are commonly used as tag pair values (see below). Non-printing characters like newline and tab are not permitted inside of strings. A string token is terminated by its closing quote. Currently, a string is limited to a maximum of 255 characters of data. An integer token is a sequence of one or more decimal digit characters. It is a special case of the more general "symbol" token class described below. Integer tokens are used to help represent move number indications (see below). An integer token is terminated just prior to the first non-symbol character following the integer digit sequence. A period character (".") is a token by itself. It is used for move number indications (see below). It is self terminating. An asterisk character ("*") is a token by itself. It is used as one of the possible game termination markers (see below); it indicates an incomplete game or a game with an unknown or otherwise unavailable result. It is self terminating. The left and right bracket characters ("[" and "]") are tokens. They are used to delimit tag pairs (see below). Both are self terminating. The left and right parenthesis characters ("(" and ")") are tokens. They are used to delimit Recursive Annotation Variations (see below). Both are self terminating. The left and right angle bracket characters ("<" and ">") are tokens. They are reserved for future expansion. Both are self terminating. A Numeric Annotation Glyph ("NAG", see below) is a token; it is composed of a dollar sign character ("$") immediately followed by one or more digit characters. It is terminated just prior to the first non-digit character following the digit sequence. A symbol token starts with a letter or digit character and is immediately followed by a sequence of zero or more symbol continuation characters. These continuation characters are letter characters ("A-Za-z"), digit characters ("0-9"), the underscore ("_"), the plus sign ("+"), the octothorpe sign ("#"), the equal sign ("="), the colon (":"), and the hyphen ("-"). Symbols are used for a variety of purposes. All characters in a symbol are significant. A symbol token is terminated just prior to the first non-symbol character following the symbol character sequence. Currently, a symbol is limited to a maximum of 255 characters in length. 8. PARSING GAMES ================ A PGN database file is a sequential collection of zero or more PGN games. An empty file is a valid, although somewhat uninformative, PGN database. A PGN game is composed of two sections. The first is the tag pair section and the second is the movetext section. The tag pair section provides information that identifies the game by defining the values associated with a set of standard parameters. The movetext section gives the usually enumerated and possibly annotated moves of the game along with the concluding game termination marker. The chess moves themselves are represented using SAN (Standard Algebraic Notation), also described later in this document. 8.1 TAG PAIR SECTION -------------------- The tag pair section is composed of a series of zero or more tag pairs. A tag pair is composed of four consecutive tokens: a left bracket token, a symbol token, a string token, and a right bracket token. The symbol token is the tag name and the string token is the tag value associated with the tag name. (There is a standard set of tag names and semantics described below.) The same tag name should not appear more than once in a tag pair section. A further restriction on tag names is that they are composed exclusively of letters, digits, and the underscore character. This is done to facilitate mapping of tag names into key and attribute names for use with general purpose database programs. For PGN import format, there may be zero or more white space characters between any adjacent pair of tokens in a tag pair. For PGN export format, there are no white space characters between the left bracket and the tag name, there are no white space characters between the tag value and the right bracket, and there is a single space character between the tag name and the tag value. Tag names, like all symbols, are case sensitive. All tag names used for archival storage begin with an upper case letter. PGN import format may have multiple tag pairs on the same line and may even have a tag pair spanning more than a single line. Export format requires each tag pair to appear left justified on a line by itself; a single empty line follows the last tag pair. Some tag values may be composed of a sequence of items. For example, a consultation game may have more than one player for a given side. When this occurs, the single character ":" (colon) appears between adjacent items. Because of this use as an internal separator in strings, the colon should not otherwise appear in a string. The tag pair format is designed for expansion; initially only strings are allowed as tag pair values. Tag value formats associated with the STR (Seven Tag Roster, see below) will not change; they will always be string values. However, there are long term plans to allow general list structures as tag values for non-STR tag pairs. Use of these expanded tag values will likely be restricted to special research programs. In all events, the top level structure of a tag pair remains the same: left bracket, tag name, tag value, and right bracket. 8.1.1 SEVEN TAG ROSTER ---------------------- There is a set of tags defined for mandatory use for archival storage of PGN data. This is the STR (Seven Tag Roster). The interpretation of these tags is fixed as is the order in which they appear. Although the definition and use of additional tag names and semantics is permitted and encouraged when needed, the STR is the common ground that all programs should follow for public data interchange. For import format, the order of tag pairs is not important. For export format, the STR tag pairs appear before any other tag pairs. (The STR tag pairs must also appear in order; this order is described below). Also for export format, any additional tag pairs appear in ASCII order by tag name. The seven tag names of the STR are (in order): 1. Event (the name of the tournament or match event) 2. Site (the location of the event) 3. Date (the starting date of the game) 4. Round (the playing round ordinal of the game) 5. White (the player of the white pieces) 6. Black (the player of the black pieces) 7. Result (the result of the game) A set of supplemental tag names is given later in this document. For PGN export format, a single blank line appears after the last of the tag pairs to conclude the tag pair section. This helps simple scanning programs to quickly determine the end of the tag pair section and the beginning of the movetext section. 8.1.1.1 THE EVENT TAG --------------------- The Event tag value should be reasonably descriptive. Abbreviations are to be avoided unless absolutely necessary. A consistent event naming should be used to help facilitate database scanning. If the name of the event is unknown, a single question mark should appear as the tag value. Examples: [Event "FIDE World Championship"] [Event "Moscow City Championship"] [Event "ACM North American Computer Championship"] [Event "Casual Game"] 8.1.1.2 THE SITE TAG -------------------- The Site tag value should include city and region names along with a standard name for the country. The use of the IOC (International Olympic Committee) three letter names is suggested for those countries where such codes are available. If the site of the event is unknown, a single question mark should appear as the tag value. A comma may be used to separate a city from a region. No comma is needed to separate a city or region from the IOC country code. A later section of this document gives a list of three letter nation codes along with a few additions for "locations" not covered by the IOC. Examples: [Site "New York City, NY USA"] [Site "St. Petersburg RUS"] [Site "Riga LAT"] 8.1.1.3 THE DATE TAG -------------------- The Date tag value gives the starting date for the game. (Note: this is not necessarily the same as the starting date for the event.) The date is given with respect to the local time of the site given in the Event tag. The Date tag value field always uses a standard ten character format: "YYYY.MM.DD". The first four characters are digits that give the year, the next character is a period, the next two characters are digits that give the month, the next character is a period, and the final two characters are digits that give the day of the month. If the any of the digit fields are not known, then question marks are used in place of the digits. Examples: [Date "1992.08.31"] [Date "1993.??.??"] [Date "2001.01.01"] 8.1.1.4 THE ROUND TAG --------------------- The Round tag value gives the playing round for the game. In a match competition, this value is the number of the game played. If the use of a round number is inappropriate, then the field should be a single hyphen character. If the round is unknown, a single question mark should appear as the tag value. Some organizers employ unusual round designations and have multipart playing rounds and sometimes even have conditional rounds. In these cases, a multipart round identifier can be made from a sequence of integer round numbers separated by periods. The leftmost integer represents the most significant round and succeeding integers represent round numbers in descending hierarchical order. Examples: [Round "1"] [Round "3.1"] [Round "4.1.2"] 8.1.1.5 THE WHITE TAG --------------------- The White tag value is the name of the player or players of the white pieces. The names are given as they would appear in a telephone directory. The family or last name appears first. If a first name or first initial is available, it is separated from the family name by a comma and a space. Finally, one or more middle initials may appear. (Wherever a comma appears, the very next character should be a space. Wherever an initial appears, the very next character should be a period.) If the name is unknown, a single question mark should appear as the tag value. The intent is to allow meaningful ASCII sorting of the tag value that is independent of regional name formation customs. If more than one person is playing the white pieces, the names are listed in alphabetical order and are separated by the colon character between adjacent entries. A player who is also a computer program should have appropriate version information listed after the name of the program. The format used in the FIDE Rating Lists is appropriate for use for player name tags. Examples: [White "Tal, Mikhail N."] [White "van der Wiel, Johan"] [White "Acme Pawngrabber v.3.2"] [White "Fine, R."] 8.1.1.6 THE BLACK TAG --------------------- The Black tag value is the name of the player or players of the black pieces. The names are given here as they are for the White tag value. Examples: [Black "Lasker, Emmanuel"] [Black "Smyslov, Vasily V."] [Black "Smith, John Q.:Woodpusher 2000"] [Black "Morphy"] 8.1.1.7 THE RESULT TAG ---------------------- The Result field value is the result of the game. It is always exactly the same as the game termination marker that concludes the associated movetext. It is always one of four possible values: "1-0" (White wins), "0-1" (Black wins), "1/2-1/2" (drawn game), and "*" (game still in progress, game abandoned, or result otherwise unknown). Note that the digit zero is used in both of the first two cases; not the letter "O". All possible examples: [Result "0-1"] [Result "1-0"] [Result "1/2-1/2"] [Result "*"] 8.2 MOVETEXT SECTION -------------------- The movetext section is composed of chess moves, move number indications, optional annotations, and a single concluding game termination marker. Because illegal moves are not real chess moves, they are not permitted in PGN movetext. They may appear in commentary, however. One would hope that illegal moves are relatively rare in games worthy of recording. 8.2.1 MOVETEXT LINE JUSTIFICATION --------------------------------- In PGN import format, tokens in the movetext do not require any specific line justification. In PGN export format, tokens in the movetext are placed left justified on successive text lines each of which has less than 80 printing characters. As many tokens as possible are placed on a line with the remainder appearing on successive lines. A single space character appears between any two adjacent symbol tokens on the same line in the movetext. As with the tag pair section, a single empty line follows the last line of data to conclude the movetext section. Neither the first or the last character on an export format PGN line is a space. (This may change in the case of commentary; this area is currently under development.) 8.2.2 MOVETEXT MOVE NUMBER INDICATIONS -------------------------------------- A move number indication is composed of one or more adjacent digits (an integer token) followed by zero or more periods. The integer portion of the indication gives the move number of the immediately following white move (if present) and also the immediately following black move (if present). 8.2.2.1 IMPORT FORMAT MOVE NUMBER INDICATIONS --------------------------------------------- PGN import format does not require move number indications. It does not prohibit superfluous move number indications anywhere in the movetext as long as the move numbers are correct. PGN import format move number indications may have zero or more period characters following the digit sequence that gives the move number; one or more white space characters may appear between the digit sequence and the period(s). 8.2.2.2 EXPORT FORMAT MOVE NUMBER INDICATIONS --------------------------------------------- There are two export format move number indication formats, one for use appearing immediately before a white move element and one for use appearing immediately before a black move element. A white move number indication is formed from the integer giving the fullmove number with a single period character appended. A black move number indication is formed from the integer giving the fullmove number with three period characters appended. All white move elements have a preceding move number indication. A black move element has a preceding move number indication only in two cases: first, if there is intervening annotation or commentary between the black move and the previous white move; and second, if there is no previous white move in the special case where a game starts from a position where Black is the active player. There are no other cases where move number indications appear in PGN export format. 8.2.3 MOVETEXT SAN (STANDARD ALGEBRAIC NOTATION) ------------------------------------------------ SAN (Standard Algebraic Notation) is a representation standard for chess moves using the ASCII Latin alphabet. Examples of SAN recorded games are found throughout most modern chess publications. SAN as presented in this document uses English language single character abbreviations for chess pieces, although this is easily changed in the source. English is chosen over other languages because it appears to be the most widely recognized. An alternative to SAN is FAN (Figurine Algebraic Notation). FAN uses miniature piece icons instead of single letter piece abbreviations. The two notations are otherwise identical. 8.2.3.1 SQUARE IDENTIFICATION ----------------------------- SAN identifies each of the sixty four squares on the chessboard with a unique two character name. The first character of a square identifier is the file of the square; a file is a column of eight squares designated by a single lower case letter from "a" (leftmost or queenside) up to and including "h" (rightmost or kingside). The second character of a square identifier is the rank of the square; a rank is a row of eight squares designated by a single digit from "1" (bottom side [White's first rank]) up to and including "8" (top side [Black's first rank]). The initial squares of some pieces are: white queen rook at a1, white king at e1, black queen knight pawn at b7, and black king rook at h8. 8.2.3.2 PIECE IDENTIFICATION ---------------------------- SAN identifies each piece by a single upper case letter. The standard English values: pawn = "P", knight = "N", bishop = "B", rook = "R", queen = "Q", and king = "K". The letter code for a pawn is not used for SAN moves in PGN export format movetext. However, some PGN import software disambiguation code may allow for the appearance of pawn letter codes. Also, pawn and other piece letter codes are needed for use in some tag pair and annotation constructs. It is admittedly a bit chauvinistic to select English piece letters over those from other languages. There is a slight justification in that English is a de facto universal second language among most chessplayers and program users. It is probably the best that can be done for now. A later section of this document gives alternative piece letters, but these should be used only for local presentation software and not for archival storage or for dynamic interchange among programs. 8.2.3.3 BASIC SAN MOVE CONSTRUCTION ----------------------------------- A basic SAN move is given by listing the moving piece letter (omitted for pawns) followed by the destination square. Capture moves are denoted by the lower case letter "x" immediately prior to the destination square; pawn captures include the file letter of the originating square of the capturing pawn immediately prior to the "x" character. SAN kingside castling is indicated by the sequence "O-O"; queenside castling is indicated by the sequence "O-O-O". Note that the upper case letter "O" is used, not the digit zero. The use of a zero character is not only incompatible with traditional text practices, but it can also confuse parsing algorithms which also have to understand about move numbers and game termination markers. Also note that the use of the letter "O" is consistent with the practice of having all chess move symbols start with a letter; also, it follows the convention that all non-pwn move symbols start with an upper case letter. En passant captures do not have any special notation; they are formed as if the captured pawn were on the capturing pawn's destination square. Pawn promotions are denoted by the equal sign "=" immediately following the destination square with a promoted piece letter (indicating one of knight, bishop, rook, or queen) immediately following the equal sign. As above, the piece letter is in upper case. 8.2.3.4 DISAMBIGUATION ---------------------- In the case of ambiguities (multiple pieces of the same type moving to the same square), the first appropriate disambiguating step of the three following steps is taken: First, if the moving pieces can be distinguished by their originating files, the originating file letter of the moving piece is inserted immediately after the moving piece letter. Second (when the first step fails), if the moving pieces can be distinguished by their originating ranks, the originating rank digit of the moving piece is inserted immediately after the moving piece letter. Third (when both the first and the second steps fail), the two character square coordinate of the originating square of the moving piece is inserted immediately after the moving piece letter. Note that the above disambiguation is needed only to distinguish among moves of the same piece type to the same square; it is not used to distinguish among attacks of the same piece type to the same square. An example of this would be a position with two white knights, one on square c3 and one on square g1 and a vacant square e2 with White to move. Both knights attack square e2, and if both could legally move there, then a file disambiguation is needed; the (nonchecking) knight moves would be "Nce2" and "Nge2". However, if the white king were at square e1 and a black bishop were at square b4 with a vacant square d2 (thus an absolute pin of the white knight at square c3), then only one white knight (the one at square g1) could move to square e2: "Ne2". 8.2.3.5 CHECK AND CHECKMATE INDICATION CHARACTERS ------------------------------------------------- If the move is a checking move, the plus sign "+" is appended as a suffix to the basic SAN move notation; if the move is a checkmating move, the octothorpe sign "#" is appended instead. Neither the appearance nor the absence of either a check or checkmating indicator is used for disambiguation purposes. This means that if two (or more) pieces of the same type can move to the same square the differences in checking status of the moves does not allieviate the need for the standard rank and file disabiguation described above. (Note that a difference in checking status for the above may occur only in the case of a discovered check.) Neither the checking or checkmating indicators are considered annotation as they do not communicate subjective information. Therefore, they are qualitatively different from move suffix annotations like "!" and "?". Subjective move annotations are handled using Numeric Annotation Glyphs as described in a later section of this document. There are no special markings used for double checks or discovered checks. There are no special markings used for drawing moves. 8.2.3.6 SAN MOVE LENGTH ----------------------- SAN moves can be as short as two characters (e.g., "d4"), or as long as seven characters (e.g., "Qa6xb7#", "fxg1=Q+"). The average SAN move length seen in realistic games is probably just fractionally longer than three characters. If the SAN rules seem complicated, be assured that the earlier notation systems of LEN (Long English Notation) and EDN (English Descriptive Notation) are much more complex, and that LAN (Long Algebraic Notation, the predecessor of SAN) is unnecessarily bulky. 8.2.3.7 IMPORT AND EXPORT SAN ----------------------------- PGN export format always uses the above canonical SAN to represent moves in the movetext section of a PGN game. Import format is somewhat more relaxed and it makes allowances for moves that do not conform exactly to the canonical format. However, these allowances may differ among different PGN reader programs. Only data appearing in export format is in all cases guaranteed to be importable into all PGN readers. There are a number of suggested guidelines for use with implementing PGN reader software for permitting non-canonical SAN move representation. The idea is to have a PGN reader apply various transformations to attempt to discover the move that is represented by non-canonical input. Some suggested transformations include: letter case remapping, capture indicator insertion, check indicator insertion, and checkmate indicator insertion. 8.2.3.8 SAN MOVE SUFFIX ANNOTATIONS ----------------------------------- Import format PGN allows for the use of traditional suffix annotations for moves. There are exactly six such annotations available: "!", "?", "!!", "!?", "?!", and "??". At most one such suffix annotation may appear per move, and if present, it is always the last part of the move symbol. When exported, a move suffix annotation is translated into the corresponding Numeric Annotation Glyph as described in a later section of this document. For example, if the single move symbol "Qxa8?" appears in an import format PGN movetext, it would be replaced with the two adjacent symbols "Qxa8 $2". 8.2.4 MOVETEXT NAG (NUMERIC ANNOTATION GLYPH) --------------------------------------------- An NAG (Numeric Annotation Glyph) is a movetext element that is used to indicate a simple annotation in a language independent manner. An NAG is formed from a dollar sign ("$") with a non-negative decimal integer suffix. The non-negative integer must be from zero to 255 in value. 8.2.5 MOVETEXT RAV (RECURSIVE ANNOTATION VARIATION) --------------------------------------------------- An RAV (Recursive Annotation Variation) is a sequence of movetext containing one or more moves enclosed in parentheses. An RAV is used to represent an alternative variation. The alternate move sequence given by an RAV is one that may be legally played by first unplaying the move that appears immediately prior to the RAV. Because the RAV is a recursive construct, it may be nested. *** The specification for import/export representation of RAV elements needs further development. 8.2.6 GAME TERMINATION MARKERS ------------------------------ Each movetext section has exactly one game termination marker; the marker always occurs as the last element in the movetext. The game termination marker is a symbol that is one of the following four values: "1-0" (White wins), "0-1" (Black wins), "1/2-1/2" (drawn game), and "*" (game in progress, result unknown, or game abandoned). Note that the digit zero is used in the above; not the upper case letter "O". The game termination marker appearing in the movetext of a game must match the value of the game's Result tag pair. (While the marker appears as a string in the Result tag, it appears as a symbol without quotes in the movetext.) 9. SUPPLEMENTAL TAG NAMES ========================= The following tag names and their associated semantics are recommended for use for information not contained in the Seven Tag Roster. 9.1 PLAYER RELATED INFORMATION ------------------------------ Note that if there is more than one player field in an instance of a player (White or Black) tag, then there will be corresponding multiple fields in any of the following tags. For example, if the White tag has the three field value "Jones:Smith:Zacharias" (a consultation game), then the WhiteTitle tag could have a value of "IM:-:GM" if Jones was an International Master, Smith was untitled, and Zacharias was a Grandmaster. 9.1.1 TAGS: WHITETITLE, BLACKTITLE ---------------------------------- These use string values such as "FM", "IM", and "GM"; these tags are used only for the standard abbreviations for FIDE titles. A value of "-" is used for an untitled player. 9.1.2 TAGS: WHITEELO, BLACKELO ------------------------------ These tags use integer values; these are used for FIDE Elo ratings. A value of "-" is used for an unrated player. 9.1.3 TAGS: WHITEUSCF, BLACKUSCF -------------------------------- These tags use integer values; these are used for USCF (United States Chess Federation) ratings. Similar tag names can be constructed for other rating agencies. 9.1.4 TAGS: WHITENA, BLACKNA ---------------------------- These tags use string values; these are the e-mail or network addresses of the players. A value of "-" is used for a player without an electronic address. 9.1.5 TAGS: WHITETYPE, BLACKTYPE -------------------------------- These tags use string values; these describe the player types. The value "human" should be used for a person while the value "program" should be used for algorithmic (computer) players. 9.2 EVENT RELATED INFORMATION ----------------------------- The following tags are used for providing additional information about the event. 9.2.1 TAG: EVENTDATE -------------------- This uses a date value, similar to the Date tag field, that gives the starting date of the Event. 9.2.2 TAG: EVENTSPONSOR ----------------------- This uses a string value giving the name of the sponsor of the event. 9.2.3 TAG: SECTION ------------------ This uses a string; this is used for the playing section of a tournament (e.g., "Open" or "Reserve"). 9.2.4 TAG: STAGE ---------------- This uses a string; this is used for the stage of a multistage event (e.g., "Preliminary" or "Semifinal"). 9.2.5 TAG: BOARD ---------------- This uses an integer; this identifies the board number in a team event and also in a simultaneous exhibition. 9.3 OPENING INFORMATION (LOCALE SPECIFIC) ----------------------------------------- The following tag pairs are used for traditional opening names. The associated tag values will vary according to the local language in use. 9.3.1 TAG: OPENING ------------------ This uses a string; this is used for the traditional opening name. This will vary by locale. This tag pair is associated with the use of the EPD opcode "v0" described in a later section of this document. 9.3.2 TAG: VARIATION -------------------- This uses a string; this is used to further refine the Opening tag. This will vary by locale. This tag pair is associated with the use of the EPD opcode "v1" described in a later section of this document. 9.3.3 TAG: SUBVARIATION ----------------------- This uses a string; this is used to further refine the Variation tag. This will vary by locale. This tag pair is associated with the use of the EPD opcode "v2" described in a later section of this document. 9.4 OPENING INFORMATION (THIRD PARTY VENDORS) --------------------------------------------- The following tag pairs are used for representing opening identification according to various third party vendors and organizations. References to these organizations does not imply any endorsement of them or any endorsement by them. 9.4.1 TAG: ECO -------------- This uses a string of either the form "XDD" or the form "XDD/DD" where the "X" is a letter from "A" to "E" and the "D" positions are digits; this is used for an opening designation from the five volume Encyclopedia of Chess Openings. This tag pair is associated with the use of the EPD opcode "eco" described in a later section of this document. 9.4.2 TAG: NIC -------------- This uses a string; this is used for an opening designation from the New in Chess database. This tag pair is associated with the use of the EPD opcode "nic" described in a later section of this document. 9.5 TIME AND DATE RELATED INFORMATION ------------------------------------- The following tags assist with further refinement of the time and data information associated with a game. 9.5.1 TAG: TIME --------------- This uses a time-of-day value in the form "HH:MM:SS"; similar to the Date tag except that it denotes the local clock time (hours, minutes, and seconds) of the start of the game. Note that colons, not periods, are used for field separators for the Time tag value. The value is taken from the local time corresponding to the location given in the Site tag pair. 9.5.2 TAG: UTCTIME ------------------ This tag is similar to the Time tag except that the time is given according to the Universal Coordinated Time standard. 9.5.3 TAG: UTCDATE ------------------ This tag is similar to the Date tag except that the date is given according to the Universal Coordinated Time standard. 9.6 TIME CONTROL ---------------- The follwing tag is used to help describe the time control used with the game. 9.6.1 TAG: TIMECONTROL ---------------------- This uses a list of one or more time control fields. Each field contains a descriptor for each time control period; if more than one descriptor is present then they are separated by the colon character (":"). The descriptors appear in the order in which they are used in the game. The last field appearing is considered to be implicitly repeated for further control periods as needed. There are six kinds of TimeControl fields. The first kind is a single question mark ("?") which means that the time control mode is unknown. When used, it is usually the only descriptor present. The second kind is a single hyphen ("-") which means that there was no time control mode in use. When used, it is usually the only descriptor present. The third Time control field kind is formed as two positive integers separated by a solidus ("/") character. The first integer is the number of moves in the period and the second is the number of seconds in the period. Thus, a time control period of 40 moves in 2 1/2 hours would be represented as "40/9000". The fourth TimeControl field kind is used for a "sudden death" control period. It should only be used for the last descriptor in a TimeControl tag value. It is sometimes the only descriptor present. The format consists of a single integer that gives the number of seconds in the period. Thus, a blitz game would be represented with a TimeControl tag value of "300". The fifth TimeControl field kind is used for an "incremental" control period. It should only be used for the last descriptor in a TimeControl tag value and is usually the only descriptor in the value. The format consists of two positive integers separated by a plus sign ("+") character. The first integer gives the minimum number of seconds allocated for the period and the second integer gives the number of extra seconds added after each move is made. So, an incremental time control of 90 minutes plus one extra minute per move would be given by "4500+60" in the TimeControl tag value. The sixth TimeControl field kind is used for a "sandclock" or "hourglass" control period. It should only be used for the last descriptor in a TimeControl tag value and is usually the only descriptor in the value. The format consists of an asterisk ("*") immediately followed by a positive integer. The integer gives the total number of seconds in the sandclock period. The time control is implemented as if a sandclock were set at the start of the period with an equal amount of sand in each of the two chambers and the players invert the sandclock after each move with a time forfeit indicated by an empty upper chamber. Electronic implementation of a physical sandclock may be used. An example sandclock specification for a common three minute egg timer sandclock would have a tag value of "*180". Additional TimeControl field kinds will be defined as necessary. 9.7 ALTERNATIVE STARTING POSITIONS ---------------------------------- There are two tags defined for assistance with describing games that did not start from the usual initial array. 9.7.1 TAG: SETUP ---------------- This tag takes an integer that denotes the "set-up" status of the game. A value of "0" indicates that the game has started from the usual initial array. A value of "1" indicates that the game started from a set-up position; this position is given in the "FEN" tag pair. This tag must appear for a game starting with a set-up position. If it appears with a tag value of "1", a FEN tag pair must also appear. 9.7.2 TAG: FEN -------------- This tag uses a string that gives the Forsyth-Edwards Notation for the starting position used in the game. FEN is described in a later section of this document. If a SetUp tag appears with a tag value of "1", the FEN tag pair is also required. 9.8 GAME CONCLUSION ------------------- There is a single tag that discusses the conclusion of the game. 9.8.1 TAG: TERMINATION ---------------------- This takes a string that describes the reason for the conclusion of the game. While the Result tag gives the result of the game, it does not provide any extra information and so the Termination tag is defined for this purpose. Strings that may appear as Termination tag values: abandoned Abandoned game. adjudication Result due to third party adjudication process. death Losing player called to greater things, one hopes. emergency Game concluded due to unforeseen circumstances. normal Game terminated in a normal fashion. rules infraction Administrative forfeit due to losing player's failure to observe either the Laws of Chess or the event regulations. time forfeit Loss due to losing player's failure to meet time control requirements. unterminated Game not terminated. 9.9 MISCELLANEOUS ----------------- These are tags that can be briefly described and that doon't fit well inother sections. 9.9.1 TAG: ANNOTATOR -------------------- This tag uses a name or names in the format of the player name tags; this identifies the annotator or annotators of the game. 9.9.2 TAG: MODE --------------- This uses a string that gives the playing mode of the game. Examples: "OTB" (over the board), "PM" (paper mail), "EM" (electronic mail), "ICS" (Internet Chess Server), and "TC" (general telecommunication). 9.9.3 TAG: PLYCOUNT ------------------- This tag takes a single integer that gives the number of ply (moves) in the game. 10. NUMERIC ANNOTATION GLYPHS ============================= NAG zero is used for a null annotation; it is provided for the convenience of software designers as a placeholder value and should probably not be used in external PGN data. NAGs with values from 1 to 9 annotate the move just played. NAGs with values from 10 to 135 modify the current position. NAGs with values from 136 to 139 describe time pressure. Other NAG values are reserved for future definition. Note: the number assignments listed below should be considered preliminary in nature; they are likely to be changed as a result of reviewer feedback. 1. null annotation 2. good move (traditional "!") 3. poor move (traditional "?") 4. very good move (traditional "!!") 5. very poor move (traditional "??") 6. speculative move (traditional "!?") 7. questionable move (traditional "?!") 8. forced move (all others lose quickly) 9. singular move (no reasonable alternatives) 10. worst move 11. drawish position 12. equal chances, quiet position 13. equal chances, active position 14. unclear position 15. White has a slight advantage 16. Black has a slight advantage 17. White has a moderate advantage 18. Black has a moderate advantage 19. White has a decisive advantage 20. Black has a decisive advantage 21. White has a crushing advantage (Black should resign) 22. Black has a crushing advantage (White should resign) 23. White is in zugzwang 24. Black is in zugzwang 25. White has a slight space advantage 26. Black has a slight space advantage 27. White has a moderate space advantage 28. Black has a moderate space advantage 29. White has a decisive space advantage 30. Black has a decisive space advantage 31. White has a slight time (development) advantage 32. Black has a slight time (development) advantage 33. White has a moderate time (development) advantage 34. Black has a moderate time (development) advantage 35. White has a decisive time (development) advantage 36. Black has a decisive time (development) advantage 37. White has the initiative 38. Black has the initiative 39. White has a lasting initiative 40. Black has a lasting initiative 41. White has the attack 42. Black has the attack 43. White has insufficient compensation for material deficit 44. Black has insufficient compensation for material deficit 45. White has sufficient compensation for material deficit 46. Black has sufficient compensation for material deficit 47. White has more than adequate compensation for material deficit 48. Black has more than adequate compensation for material deficit 49. White has a slight center control advantage 50. Black has a slight center control advantage 51. White has a moderate center control advantage 52. Black has a moderate center control advantage 53. White has a decisive center control advantage 54. Black has a decisive center control advantage 55. White has a slight kingside control advantage 56. Black has a slight kingside control advantage 57. White has a moderate kingside control advantage 58. Black has a moderate kingside control advantage 59. White has a decisive kingside control advantage 60. Black has a decisive kingside control advantage 61. White has a slight queenside control advantage 62. Black has a slight queenside control advantage 63. White has a moderate queenside control advantage 64. Black has a moderate queenside control advantage 65. White has a decisive queenside control advantage 66. Black has a decisive queenside control advantage 67. White has a vulnerable first rank 68. Black has a vulnerable first rank 69. White has a well protected first rank 70. Black has a well protected first rank 71. White has a poorly protected king 72. Black has a poorly protected king 73. White has a well protected king 74. Black has a well protected king 75. White has a poorly placed king 76. Black has a poorly placed king 77. White has a well placed king 78. Black has a well placed king 79. White has a very weak pawn structure 80. Black has a very weak pawn structure 81. White has a moderately weak pawn structure 82. Black has a moderately weak pawn structure 83. White has a moderately strong pawn structure 84. Black has a moderately strong pawn structure 85. White has a very strong pawn structure 86. Black has a very strong pawn structure 87. White has poor knight placement 88. Black has poor knight placement 89. White has good knight placement 90. Black has good knight placement 91. White has poor bishop placement 92. Black has poor bishop placement 93. White has good bishop placement 94. Black has good bishop placement 95. White has poor rook placement 96. Black has poor rook placement 97. White has good rook placement 98. Black has good rook placement 99. White has poor queen placement 100. Black has poor queen placement 101. White has good queen placement 102. Black has good queen placement 103. White has poor piece coordination 104. Black has poor piece coordination 105. White has good piece coordination 106. Black has good piece coordination 107. White has played the opening very poorly 108. Black has played the opening very poorly 109. White has played the opening poorly 110. Black has played the opening poorly 111. White has played the opening well 112. Black has played the opening well 113. White has played the opening very well 114. Black has played the opening very well 115. White has played the middlegame very poorly 116. Black has played the middlegame very poorly 117. White has played the middlegame poorly 118. Black has played the middlegame poorly 119. White has played the middlegame well 120. Black has played the middlegame well 121. White has played the middlegame very well 122. Black has played the middlegame very well 123. White has played the ending very poorly 124. Black has played the ending very poorly 125. White has played the ending poorly 126. Black has played the ending poorly 127. White has played the ending well 128. Black has played the ending well 129. White has played the ending very well 130. Black has played the ending very well 131. White has slight counterplay 132. Black has slight counterplay 133. White has moderate counterplay 134. Black has moderate counterplay 135. White has decisive counterplay 136. Black has decisive counterplay 137. White has moderate time control pressure 138. Black has moderate time control pressure 139. White has severe time control pressure 140. Black has severe time control pressure 11. FILE NAMES AND DIRECTORIES ============================== File names chosen for PGN data should be both informative and portable. The directory names and arrangements should also be chosen for the same reasons and also for ease of navigation. Some of suggested file and directory names may be difficult or impossible to represent on certain computing systems. Use of appropriate conversion customs is encouraged. 11.1 FILE NAME SUFFIX FOR PGN DATA ---------------------------------- The use of the file suffix ".pgn" is encouraged for ASCII text files containing PGN data. 11.2 FILE NAME FORMATION FOR PGN DATA FOR A SPECIFIC PLAYER ----------------------------------------------------------- PGN games for a specific player should have a file name consisting of the player's last name followed by the ".pgn" suffix. 11.3 FILE NAME FORMATION FOR PGN DATA FOR A SPECIFIC EVENT ---------------------------------------------------------- PGN games for a specific event should have a file name consisting of the event's name followed by the ".pgn" suffix. 11.4 FILE NAME FORMATION FOR PGN DATA FOR CHRONOLOGICALLY ORDERED GAMES ----------------------------------------------------------------------- PGN data files used for chronologically ordered (oldest first) archives use date information as file name root strings. A file containing all the PGN games for a given year would have an eight character name in the format "YYYY.pgn". A file containing PGN data for a given month would have a ten character name in the format "YYYYMM.pgn". Finally, a file for PGN games for a single day would have a twelve character name in the format "YYYYMMDD.pgn". Large files are split into smaller files as needed. As game files are commonly arranged by chronological order, games with missing or incomplete Date tag pair data are to be avoided. Any question mark characters in a Date tag value will be treated as zero digits for collation within a file and also for file naming. Large quantities of PGN data arranged by chronological order should be organized into hierarchical directories. A directory containing all PGN data for a given year would have a four character name in the format "YYYY"; directories containing PGN files for a given month would have a six character name in the format "YYYYMM". 11.5 SUGGESTED DIRECTORY TREE ORGANIZATION ------------------------------------------ A suggested directory arrangement for ftp sites and CD-ROM distributions: PGN Master directory of the PGN subtree (pub/chess/Game-Databases/PGN) PGN/Events Directory of PGN files, each for a specific event PGN/Events/News News and status of the event collection PGN/Events/ReadMe Brief description of the local directory contents PGN/MGR Directory of the Master Games Repository subtree PGN/MGR/News News and status of the entire PGN/MGR subtree PGN/MGR/ReadMe Brief description of the local directory contents PGN/MGR/YYYY Directory of games or subtrees for the year YYYY PGN/MGR/YYYY/ReadMe Description of local directory for year YYYY PGN/MGR/YYYY/News News and status for year YYYY data PGN/News News and status of the entire PGN subtree PGN/Players Directory of PGN files, each for a specific player PGN/Players/News News and status of the player collection PGN/Players/ReadMe Brief description of the local directory contents PGN/ReadMe Brief description of the local directory contents PGN/Standard The PGN standard (this document) PGN/Tools Software utilities that access PGN data 12. PGN COLLATING SEQUENCE ========================== There is a standard sorting order for PGN games within a file. This collation is based on eight keys; these are the seven tag values of the STR and also the movetext itself. The first (most important, primary key) is the Date tag. Earlier dated games appear prior to games played at a later date. This field is sorted by ascending numeric value first with the year, then the month, and finally the day of the month. Query characters used for unknown date digit values will be treated as zero digit characters for ordering comparison. The second key is the Event tag. This is sorted in ascending ASCII order. The third key is the Site tag. This is sorted in ascending ASCII order. The fourth key is the Round tag. This is sorted in ascending numeric order based on the value of the integer used to denote the playing round. A query or hyphen used for the round is ordered before any integer value. A query character is ordered before a hyphen character. The fifth key is the White tag. This is sorted in ascending ASCII order. The sixth key is the Black tag. This is sorted in ascending ASCII order. The seventh key is the Result tag. This is sorted in ascending ASCII order. The eighth key is the movetext itself. This is sorted in ascending ASCII order with the entire text including spaces and newline characters. 15. INTERNATIONAL OLYMPIC COMMITTEE COUNTRY CODES ================================================= International Olympic Committee country codes are employed for Site nation information because of their traditional use with the reporting of international sporting events. Due to changes in geography and linguistic custom, some of the following may be incorrect or outdated. Corrections and extensions should be sent via e-mail to the PGN coordinator whose address listed near the start of this document. AFG Afghanistan AIR Aboard aircraft ALB Albania ALG Algeria AND Andorra ANG Angola ANT Antigua ARG Argentina ARM Armenia ATA Antarctica AUS Australia AZB Azerbaijan BAN Bangladesh BAR Bahrain BHM Bahamas BEL Belgium BER Bermuda BIH Bosnia and Herzegovina BLA Belarus BLG Bulgaria BLZ Belize BOL Bolivia BRB Barbados BRS Brazil BRU Brunei BSW Botswana CAN Canada CHI Chile COL Columbia CRA Costa Rica CRO Croatia CSR Czechoslovakia CUB Cuba CYP Cyprus DEN Denmark DOM Dominican Republic ECU Ecuador EGY Egypt ENG England ESP Spain EST Estonia FAI Faroe Islands FIJ Fiji FIN Finland FRA France GAM Gambia GCI Guernsey-Jersey GEO Georgia GER Germany GHA Ghana GRC Greece GUA Guatemala GUY Guyana HAI Haiti HKG Hong Kong HON Honduras HUN Hungary IND India IRL Ireland IRN Iran IRQ Iraq ISD Iceland ISR Israel ITA Italy IVO Ivory Coast JAM Jamaica JAP Japan JRD Jordan JUG Yugoslavia KAZ Kazakhstan KEN Kenya KIR Kyrgyzstan KUW Kuwait LAT Latvia LEB Lebanon LIB Libya LIC Liechtenstein LTU Lithuania LUX Luxembourg MAL Malaysia MAU Mauritania MEX Mexico MLI Mali MLT Malta MNC Monaco MOL Moldova MON Mongolia MOZ Mozambique MRC Morocco MRT Mauritius MYN Myanmar NCG Nicaragua NET The Internet NIG Nigeria NLA Netherlands Antilles NLD Netherlands NOR Norway NZD New Zealand OST Austria PAK Pakistan PAL Palestine PAN Panama PAR Paraguay PER Peru PHI Philippines PNG Papua New Guinea POL Poland POR Portugal PRC People's Republic of China PRO Puerto Rico QTR Qatar RIN Indonesia ROM Romania RUS Russia SAF South Africa SAL El Salvador SCO Scotland SEA At Sea SEN Senegal SEY Seychelles SIP Singapore SLV Slovenia SMA San Marino SPC Aboard spacecraft SRI Sri Lanka SUD Sudan SUR Surinam SVE Sweden SWZ Switzerland SYR Syria TAI Thailand TMT Turkmenistan TRK Turkey TTO Trinidad and Tobago TUN Tunisia UAE United Arab Emirates UGA Uganda UKR Ukraine UNK Unknown URU Uruguay USA United States of America UZB Uzbekistan VEN Venezuela VGB British Virgin Islands VIE Vietnam VUS U.S. Virgin Islands WLS Wales YEM Yemen YUG Yugoslavia ZAM Zambia ZIM Zimbabwe ZRE Zaire 16. ADDITIONAL CHESS DATA STANDARDS =================================== While PGN is used for game storage, there are other data representation standards for other chess related purposes. Two important standards are FEN and EPD, both described in this section. 16.1 FEN -------- FEN is "Forsyth-Edwards Notation"; it is a standard for describing chess positions using the ASCII character set. A single FEN record uses one text line of variable length composed of six data fields. The first four fields of the FEN specification are the same as the first four fields of the EPD specification. A text file composed exclusively of FEN data records should have a file name with the suffix ".fen". 16.1.1 HISTORY -------------- FEN is based on a 19th century standard for position recording designed by the Scotsman David Forsyth, a newspaper journalist. The original Forsyth standard has been slightly extended for use with chess software by Steven Edwards with assistance from commentators on the Internet. This new standard, FEN, was first implemented in Edwards' SAN Kit. 16.1.2 USES FOR A POSITION NOTATION ----------------------------------- Having a standard position notation is particularly important for chess programmers as it allows them to share position databases. For example, there exist standard position notation databases with many of the classical benchmark tests for chessplaying programs, and by using a common position notation format many hours of tedious data entry can be saved. Additionally, a position notation can be useful for page layout programs and for confirming position status for e-mail competition. Many interesting chess problem sets represented using FEN can be found at the chess.uoknor.edu ftp site in the directory pub/chess/SAN_testsuites. 16.1.3 DATA FIELDS ------------------ FEN specifies the piece placement, the active color, the castling availability, the en passant target square, the halfmove clock, and the fullmove number. These can all fit on a single text line in an easily read format. The length of a FEN position description varies somewhat according to the position. In some cases, the description could be eighty or more characters in length and so may not fit conveniently on some displays. However, these positions aren't too common. A FEN description has six fields. Each field is composed only of non-blank printing ASCII characters. Adjacent fields are separated by a single ASCII space character. 16.1.3.1 PIECE PLACEMENT DATA ----------------------------- The first field represents the placement of the pieces on the board. The board contents are specified starting with the eighth rank and ending with the first rank. For each rank, the squares are specified from file a to file h. White pieces are identified by uppercase SAN piece letters ("PNBRQK") and black pieces are identified by lowercase SAN piece letters ("pnbrqk"). Empty squares are represented by the digits one through eight; the digit used represents the count of contiguous empty squares along a rank. A solidus character "/" is used to separate data of adjacent ranks. 16.1.3.2 ACTIVE COLOR --------------------- The second field represents the active color. A lower case "w" is used if White is to move; a lower case "b" is used if Black is the active player. 16.1.3.3 CASTLING AVAILABILITY ------------------------------ The third field represents castling availability. This indicates potential future castling that may of may not be possible at the moment due to blocking pieces or enemy attacks. If there is no castling availability for either side, the single character symbol "-" is used. Otherwise, a combination of from one to four characters are present. If White has kingside castling availability, the uppercase letter "K" appears. If White has queenside castling availability, the uppercase letter "Q" appears. If Black has kingside castling availability, the lowercase letter "k" appears. If Black has queenside castling availability, then the lowercase letter "q" appears. Those letters which appear will be ordered first uppercase before lowercase and second kingside before queenside. There is no white space between the letters. 16.1.3.4 EN PASSANT TARGET SQUARE --------------------------------- The fourth field is the en passant target square. If there is no en passant target square then the single character symbol "-" appears. If there is an en passant target square then is represented by a lowercase file character immediately followed by a rank digit. Obviously, the rank digit will be "3" following a white pawn double advance (Black is the active color) or else be the digit "6" after a black pawn double advance (White being the active color). An en passant target square is given if and only if the last move was a pawn advance of two squares. Therefore, an en passant target square field may have a square name even if there is no pawn of the opposing side that may immediately execute the en passant capture. 16.1.3.5 HALFMOVE CLOCK ----------------------- The fifth field is a nonnegative integer representing the halfmove clock. This number is the count of halfmoves (or ply) since the last pawn advance or capturing move. This value is used for the fifty move draw rule. 16.1.3.6 FULLMOVE NUMBER ------------------------ The sixth and last field is a positive integer that gives the fullmove number. This will have the value "1" for the first move of a game for both White and Black. It is incremented by one immediately after each move by Black. 16.1.4 EXAMPLES --------------- Here's the FEN for the starting position: rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1 And after the move 1. e4: rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq e3 0 1 And then after 1. ... c5: rnbqkbnr/pp1ppppp/8/2p5/4P3/8/PPPP1PPP/RNBQKBNR w KQkq c6 0 2 And then after 2. Nf3: rnbqkbnr/pp1ppppp/8/2p5/4P3/5N2/PPPP1PPP/RNBQKB1R b KQkq - 1 2 For two kings on their home squares and a white pawn on e2 (White to move) with thirty eight full moves played with five halfmoves since the last pawn move or capture: 4k3/8/8/8/8/8/4P3/4K3 w - - 5 39 16.2 EPD -------- EPD is "Extended Position Description"; it is a standard for describing chess positions along with an extended set of structured attribute values using the ASCII character set. It is intended for data and command interchange among chessplaying programs. It is also intended for the representation of portable opening library repositories. A single EPD uses one text line of variable length composed of four data field followed by zero or more operations. The four fields of the EPD specification are the same as the first four fields of the FEN specification. A text file composed exclusively of EPD data records should have a file name with the suffix ".epd". 16.2.1 HISTORY -------------- EPD is based in part on the earlier FEN standard; it has added extensions for use with opening library preparation and also for general data and command interchange among advanced chess programs. EPD was developed by John Stanback and Steven Edwards; its first implementation is in Stanback's master strength chessplaying program Zarkov. 16.2.2 USES FOR AN EXTENDED POSITION NOTATION --------------------------------------------- Like FEN, EPD can also be used for general position description. However, unlike FEN, EPD is designed to be expandable by the addition of new operations that provide new functionality as needs arise. Many interesting chess problem sets represented using EPD can be found at the chess.uoknor.edu ftp site in the directory pub/chess/SAN_testsuites. 16.2.3 DATA FIELDS ------------------ EPD specifies the piece placement, the active color, the castling availability, and the en passant target square of a position. These can all fit on a single text line in an easily read format. The length of an EPD position description varies somewhat according to the position and any associated operations. In some cases, the description could be eighty or more characters in length and so may not fit conveniently on some displays. However, most EPD descriptions pass among programs only and these are not usually seen by program users. (Note: due to the likelihood of future expansion of EPD, implementors are encouraged to have their programs handle EPD text lines of up to 1024 characters long.) Each EPD data field is composed only of non-blank printing ASCII characters. Adjacent data fields are separated by a single ASCII space character. 16.2.3.1 PIECE PLACEMENT DATA ----------------------------- The first field represents the placement of the pieces on the board. The board contents are specified starting with the eighth rank and ending with the first rank. For each rank, the squares are specified from file a to file h. White pieces are identified by uppercase SAN piece letters ("PNBRQK") and black pieces are identified by lowercase SAN piece letters ("pnbrqk"). Empty squares are represented by the digits one through eight; the digit used represents the count of contiguous empty squares along a rank. A solidus character "/" is used to separate data of adjacent ranks. 16.2.3.2 ACTIVE COLOR --------------------- The second field represents the active color. A lower case "w" is used if White is to move; a lower case "b" is used if Black is the active player. 16.2.3.3 CASTLING AVAILABILITY ------------------------------ The third field represents castling availability. This indicates potential future castling that may or may not be possible at the moment due to blocking pieces or enemy attacks. If there is no castling availability for either side, the single character symbol "-" is used. Otherwise, a combination of from one to four characters are present. If White has kingside castling availability, the uppercase letter "K" appears. If White has queenside castling availability, the uppercase letter "Q" appears. If Black has kingside castling availability, the lowercase letter "k" appears. If Black has queenside castling availability, then the lowercase letter "q" appears. Those letters which appear will be ordered first uppercase before lowercase and second kingside before queenside. There is no white space between the letters. 16.2.3.4 EN PASSANT TARGET SQUARE --------------------------------- The fourth field is the en passant target square. If there is no en passant target square then the single character symbol "-" appears. If there is an en passant target square then is represented by a lowercase file character immediately followed by a rank digit. Obviously, the rank digit will be "3" following a white pawn double advance (Black is the active color) or else be the digit "6" after a black pawn double advance (White being the active color). An en passant target square is given if and only if the last move was a pawn advance of two squares. Therefore, an en passant target square field may have a square name even if there is no pawn of the opposing side that may immediately execute the en passant capture. 16.2.4 OPERATIONS ----------------- An EPD operation is composed of an opcode followed by zero or more operands and is concluded by a semicolon. Multiple operations are separated by a single space character. If there is at least one operation present in an EPD line, it is separated from the last (fourth) data field by a single space character. 16.2.4.1 GENERAL FORMAT ----------------------- An opcode is an identifier that starts with a letter character and may be followed by up to fourteen more characters. Each additional character may be a letter or a digit or the underscore character. An operand is either a set of contiguous non-white space printing characters or a string. A string is a set of contiguous printing characters delimited by a quote character at each end. A string value must have less than 256 bytes of data. If at least one operand is present in an operation, there is a single space between the opcode and the first operand. If more than one operand is present in an operation, there is a single blank character between every two adjacent operands. If there are no operands, a semicolon character is appended to the opcode to mark the end of the operation. If any operands appear, the last operand has an appended semicolon that marks the end of the operation. Any given opcode appears at most once per EPD record. Multiple operations in a single EPD record should appear in ASCII order of their opcode names (mnemonics). However, a program reading EPD records may allow for operations not in ASCII order by opcode mnemonics; the semantics are the same in either case. Some opcodes that allow for more than one operand may have special ordering requirements for the operands. For example, the "pv" (predicted variation) opcode requires its operands (moves) to appear in the order in which they would be played. All other opcodes that allow for more than one operand should have operands appearing in ASCII order. An example of the latter set is the "bm" (best move[s]) opcode; its operands are moves that are all immediately playable from the current position. Some opcodes require one or more operands that are chess moves. These moves should be represented using SAN. If a different representation is used, there is no guarantee that the EPD will be read correctly during subsequent processing. Some opcodes require one or more operands that are integers. Some opcodes may require that an integer operand must be within a given range; the details are described in the opcode list given below. A negative integer is formed with a hyphen (minus sign) preceding the integer digit sequence. An optional plus sign may be used for indicating a non-negative value, but such use is not required and is indeed discouraged. Some opcodes require one or more operands that are floating point numbers. Some opcodes may require that a floating point operand must be within a given range; the details are described in the opcode list given below. A floating point operand is constructed from an optional sign character ("+" or "-"), a digit sequence (with at least one digit), a radix point (always "."), and a final digit sequence (with at least one digit). 16.2.4.2 OPCODE MNEMONICS ------------------------- An opcode mnemonic used for archival storage and for interprogram communication starts with a lower case letter and is composed of only lower case letters, digits, and the underscore character (i.e., no upper case letters). These mnemonics will also all be at least two characters in length. Opcode mnemonics used only by a single program or an experimental suite of programs should start with an upper case letter. This is so they may be easily distinguished should they be inadvertently be encountered by other programs. When a such a "private" opcode be demonstrated to be widely useful, it should be brought into the official list (appearing below) in a lower case form. If a given program does not recognize a particular opcode, that operation is simply ignored; it is not signaled as an error. 16.2.5 OPCODE LIST ------------------ The opcodes are listed here in ASCII order of their mnemonics. Suggestions for new opcodes should be sent to the PGN standard coordinator listed near the start of this document. 16.2.5.1 OPCODE acn: ANALYSIS COUNT: NODES ------------------------------------------ The opcode "acn" takes a single non-negative integer operand. It is used to represent the number of nodes examined in an analysis. Note that the value may be quite large for some extended searches and so use of (at least) a long (four byte) representation is suggested. 16.2.5.2 OPCODE acs: ANALYSIS COUNT: SECONDS -------------------------------------------- The opcode "acs" takes a single non-negative integer operand. It is used to represent the number of seconds used for an analysis. Note that the value may be quite large for some extended searches and so use of (at least) a long (four byte) representation is suggested. 16.2.5.3 OPCODE am: AVOID MOVES ------------------------------- The opcode "am" indicates a set of zero or more moves, all immediately playable from the current position, that are to be avoided in the opinion of the EPD writer. Each operand is a SAN move; they appear in ASCII order. 16.2.5.4 OPCODE bm: BEST MOVES ------------------------------ The opcode "bm" indicates a set of zero or more moves, all immediately playable from the current position, that are judged to the best available by the EPD writer. Each operand is a SAN move; they appear in ASCII order. 16.2.5.5 OPCODE c0: COMMENT (PRIMARY, ALSO "c1" THOUGH "c9") ------------------------------------------------------------ The opcode "c0" (lower case letter "c", digit character zero) indicates a top level comment that applies to the given position. It is the first of ten ranked comments, each of which has a mnemonic formed from the lower case letter "c" followed by a single decimal digit. Each of these opcodes takes either a single string operand or no operand at all. This ten member comment family of opcodes is intended for use as descriptive commentary for a complete game or game fragment. The usual processing of these opcodes are as follows: 1. At the beginning of a game (or game fragment), a move sequence scanning program initializes each element of its set of ten comment string registers to be null. 2. As the EPD record for each position in the game is processed, the comment operations are interpreted from left to right. (Actually, all operations in n EPD record are interpreted from left to right.) Because operations appear in ASCII order according to their opcode mnemonics, opcode "c0" (if present) will be handled prior to all other opcodes, then opcode "c1" (if present), and so forth until opcode "c9" (if present). 3. The processing of opcode "cN" (0 <= N <= 9) involves two steps. First, all comment string registers with an index equal to or greater than N are set to null. (This is the set "cN" though "c9".) Second, and only if a string operand is present, the value of the corresponding comment string register is set equal to the string operand. 16.2.5.6 OPCODE ce: CENTIPAWN EVALUATION ---------------------------------------- The opcode "ce" indicates the evaluation of the indicated position in centipawn units. It takes a single operand, an optionally signed integer that gives an evaluation of the position from the viewpoint of the active player; i.e., the player with the move. Positive values indicate a position favorable to the moving player while negative values indicate a position favorable to the passive player; i.e., the player without the move. A centipawn evaluation value close to zero indicates a neutral positional evaluation. Values are restricted to integers that are equal to or greater than -32767 and are less than or equal to 32766. A value greater than 32000 indicates the availability of a forced mate to the active player. The number of plies until mate is given by subtracting the evaluation from the value 32767. Thus, a winning mate in N fullmoves is a mate in ((2 * N) - 1) halfmoves (or ply) and has a corresponding centipawn evaluation of (32767 - ((2 * N) - 1)). For example, a mate on the move (mate in one) has a centipawn evaluation of 32766 while a mate in five has a centipawn evaluation of 32758. A value less than -32000 indicates the availability of a forced mate to the passive player. The number of plies until mate is given by subtracting the evaluation from the value -32767 and then negating the result. Thus, a losing mate in N fullmoves is a mate in (2 * N) halfmoves (or ply) and has a corresponding centipawn evaluation of (-32767 + (2 * N)). For example, a mate after the move (losing mate in one) has a centipawn evaluation of -32765 while a losing mate in five has a centipawn evaluation of -32757. A value of -32767 indicates an illegal position. A stalemate position has a centipawn evaluation of zero as does a position drawn due to insufficient mating material. Any other position known to be a certain forced draw also has a centipawn evaluation of zero. 16.2.5.7 OPCODE dm: DIRECT MATE FULLMOVE COUNT ---------------------------------------------- The "dm" opcode is used to indicate the number of fullmoves until checkmate is to be delivered by the active color for the indicated position. It always takes a single operand which is a positive integer giving the fullmove count. For example, a position known to be a "mate in three" would have an operation of "dm 3;" to indicate this. This opcode is intended for use with problem sets composed of positions requiring direct mate answers as solutions. 16.2.5.8 OPCODE draw_accept: ACCEPT A DRAW OFFER ------------------------------------------------ The opcode "draw_accept" is used to indicate that a draw offer made after the move that lead to the indicated position is accepted by the active player. This opcode takes no operands. 16.2.5.9 OPCODE draw_claim: CLAIM A DRAW ---------------------------------------- The opcode "draw_claim" is used to indicate claim by the active player that a draw exists. The draw is claimed because of a third time repetition or because of the fifty move rule or because of insufficient mating material. A supplied move (see the opcode "sm") is also required to appear as part of the same EPD record. The draw_claim opcode takes no operands. 16.2.5.10 OPCODE draw_offer: OFFER A DRAW ----------------------------------------- The opcode "draw_offer" is used to indicate that a draw is offered by the active player. A supplied move (see the opcode "sm") is also required to appear as part of the same EPD record; this move is considered played from the indicated position. The draw_offer opcode takes no operands. 16.2.5.11 OPCODE draw_reject: REJECT A DRAW OFFER ------------------------------------------------- The opcode "draw_reject" is used to indicate that a draw offer made after the move that lead to the indicated position is rejected by the active player. This opcode takes no operands. 16.2.5.12 OPCODE eco: ENCYCLOPEDIA OF CHESS OPENINGS OPENING CODE ----------------------------------------------------------------- The opcode "eco" is used to associate an opening designation from the Encyclopedia of Chess Openings taxonomy with the indicated position. The opcode takes either a single string operand (the ECO opening name) or no operand at all. If an operand is present, its value is associated with an "ECO" string register of the scanning program. If there is no operand, the ECO string register of the scanning program is set to null. The usage is similar to that of the "ECO" tag pair of the PGN standard. 16.2.5.13 OPCODE fmvn: FULLMOVE NUMBER -------------------------------------- The opcode "fmvn" represents the fullmove n umber associated with the position. It always takes a single operand that is the positive integer value of the move number. This opcode is used to explicitly represent the fullmove number in EPD that is present by default in FEN as the sixth field. Fullmove number information is usually omitted from EPD because it does not affect move generation (commonly needed for EPD-using tasks) but it does affect game notation (commonly needed for FEN-using tasks). Because of the desire for space optimization for large EPD files, fullmove numbers were dropped from EPD's parent FEN. The halfmove clock information was similarly dropped. 16.2.5.14 OPCODE hmvc: HALFMOVE CLOCK ------------------------------------- The opcode "hmvc" represents the halfmove clock associated with the position. The halfmove clock of a position is equal to the number of plies since the last pawn move or capture. This information is used to implement the fifty move draw rule. It always takes a single operand that is the non-negative integer value of the halfmove clock. This opcode is used to explicitly represent the halfmove clock in EPD that is present by default in FEN as the fifth field. Halfmove clock information is usually omitted from EPD because it does not affect move generation (commonly needed for EPD-using tasks) but it does affect game termination issues (commonly needed for FEN-using tasks). Because of the desire for space optimization for large EPD files, halfmove clock values were dropped from EPD's parent FEN. The fullmove number information was similarly dropped. 16.2.5.15 OPCODE id: POSITION IDENTIFICATION -------------------------------------------- The opcode "id" is used to provide a simple identifying label for the indicated position. It takes a single string operand. This opcode is intended for use with test suites used for measuring chessplaying program strength. An example "id" operand for the seven hundred fifty seventh position of the one thousand one problems in Reinfeld's 1001 Winning Chess Sacrifices and Combinations would be "WCSAC.0757" while the fifteenth position in the twenty four problem Bratko-Kopec test suite would have an "id" operand of "BK.15". 16.2.5.16 OPCODE nic: NEW IN CHESS OPENING CODE ----------------------------------------------- The opcode "nic" is used to associate an opening designation from the New In Chess taxonomy with the indicated position. The opcode takes either a single string operand (the NIC opening name) or no operand at all. If an operand is present, its value is associated with an "NIC" string register of the scanning program. If there is no operand, the NIC string register of the scanning program is set to null. The usage is similar to that of the "NIC" tag pair of the PGN standard. 16.2.5.17 OPCODE noop: NO OPERATION ----------------------------------- The "noop" opcode is used to indicate no operation. It takes zero or more operands, each of which may be of any type. The operation involves no processing. It is intended for use by developers for program testing purposes. 16.2.5.18 OPCODE pm: PREDICTED MOVE ----------------------------------- The "pm" opcode is used to provide a single predicted move for the indicated position. It has exactly one operand, a move playable from the position. This move is judged by the EPD writer to represent the best move available to the active player. If a non-empty "pv" (predicted variation) line of play is also present in the same EPD record, the first move of the predicted variation is the same as the predicted move. The "pm" opcode is intended for use as a general "display hint" mechanism. 16.2.5.19 OPCODE pv: PREDICTED VARIATION ---------------------------------------- The "pv" opcode is used to provide a predicted variation for the indicated position. It has zero or more operands which represent a sequence of moves playable from the position. This sequence is judged by the EPD writer to represent the best play available. If a "pm" (predicted move) operation is also present in the same EPD record, the predicted move is the same as the first move of the predicted variation. 16.2.5.20 OPCODE rc: REPETITION COUNT ------------------------------------- The "rc" opcode is used to indicate the number of occurrences of the indicated position. It takes a single, positive integer operand. Any position, including the initial starting position, is considered to have an "rc" value of at least one. A value of three indicates a candidate for a draw claim by the position repetition rule. 16.2.5.21 OPCODE resign: GAME RESIGNATION ----------------------------------------- The opcode "resign" is used to indicate that the active player has resigned the game. This opcode takes no operands. 16.2.5.22 OPCODE sm: SUPPLIED MOVE ---------------------------------- The "sm" opcode is used to provide a single supplied move for the indicated position. It has exactly one operand, a move playable from the position. This move is the move to be played from the position. The "sm" opcode is intended for use to communicate the most recent played move in an active game. It is used to communicate moves between programs in automatic play via a network. This includes correspondence play using e-mail and also programs acting as network front ends to human players. 16.2.5.23 OPCODE tcgs: TELECOMMUNICATION: GAME SELECTOR ------------------------------------------------------- The "tcgs" opcode is one of the telecommunication family of opcodes used for games conducted via e-mail and similar means. This opcode takes a single operand that is a positive integer. It is used to select among various games in progress between the same sender and receiver. 16.2.5.24 OPCODE tcri: TELECOMMUNICATION: RECEIVER IDENTIFICATION ----------------------------------------------------------------- The "tcri" opcode is one of the telecommunication family of opcodes used for games conducted via e-mail and similar means. This opcode takes two order dependent string operands. The first operand is the e-mail address of the receiver of the EPD record. The second operand is the name of the player (program or human) at the address who is the actual receiver of the EPD record. 16.2.5.25 OPCODE tcsi: TELECOMMUNICATION: SENDER IDENTIFICATION --------------------------------------------------------------- The "tcsi" opcode is one of the telecommunication family of opcodes used for games conducted via e-mail and similar means. This opcode takes two order dependent string operands. The first operand is the e-mail address of the sender of the EPD record. The second operand is the name of the player (program or human) at the address who is the actual sender of the EPD record. 16.2.5.26 OPCODE v0: VARIATION NAME (PRIMARY, ALSO "V1" THOUGH "V9") -------------------------------------------------------------------- The opcode "v0" (lower case letter "v", digit character zero) indicates a top level variation name that applies to the given position. It is the first of ten ranked variation names, each of which has a mnemonic formed from the lower case letter "v" followed by a single decimal digit. Each of these opcodes takes either a single string operand or no operand at all. This ten member variation name family of opcodes is intended for use as traditional variation names for a complete game or game fragment. The usual processing of these opcodes are as follows: 1. At the beginning of a game (or game fragment), a move sequence scanning program initializes each element of its set of ten variation name string registers to be null. 2. As the EPD record for each position in the game is processed, the variation name operations are interpreted from left to right. (Actually, all operations in n EPD record are interpreted from left to right.) Because operations appear in ASCII order according to their opcode mnemonics, opcode "v0" (if present) will be handled prior to all other opcodes, then opcode "v1" (if present), and so forth until opcode "v9" (if present). 3. The processing of opcode "vN" (0 <= N <= 9) involves two steps. First, all variation name string registers with an index equal to or greater than N are set to null. (This is the set "vN" though "v9".) Second, and only if a string operand is present, the value of the corresponding variation name string register is set equal to the string operand. 17. ALTERNATIVE CHESSPIECE IDENTIFIER LETTERS ============================================= English language piece names are used to define the letter set for identifying chesspieces in PGN movetext. However, authors of programs which are used only for local presentation or scanning of chess move data may find it convenient to use piece letter codes common in their locales. This is not a problem as long as PGN data that resides in archival storage or that is exchanged among programs still uses the SAN (English) piece letter codes: "PNBRQK". For the above authors only, a list of alternative piece letter codes are provided; the piece codes are given in the order pawn, knight, bishop, rook, queen, and king. Czech P J S V D K Danish B S L T D K Dutch O P L T D K English P N B R Q K Estonian P R O V L K Finnish P R L T D K French P C F T D R German B S L T D K Hungarian G H F B V K Icelandic P R B H D K Italian P C A T D R Norwegian B S L T D K Polish P S G W H K Portuguese P C B T D R Romanian P C N T D R Spanish P C A T D R Swedish B S L T D K 18. FORMAL SYNTAX ================= ::= ::= ::= ::= [ ] ::= ::= ::= ::= ::= ::= ( ) ::= 1-0 0-1 1/2-1/2 * ::= 19. CANONICAL CHESS POSITION HASH CODING ======================================== *** This section is under development. 20. BINARY REPRESENTATION (PGC) =============================== *** This section is under development. The binary coded version of PGN is PGC (PGN Game Coding). PGC is a binary representation standard of PGN data designed for the dual goals of storage efficiency and program I/O. A file containing PGC data should have a name with a suffix of ".pgc". Unlike PGN text files that may have locale dependent representations for newlines, PGC files have data that does not vary due to local processing environment. This means that PGC files may be transferred among systems using general binary file methods. PGC files should be used only when the use of PGN is impractical due to time and space resource constraints. As the general level of processing capabilities increases, the need for PGC over PGN will decrease. Therefore, implementors are encouraged not to use PGC as the default representation because it is much more difficult (than PGN) to understand without proper software. PGC data is composed of a sequence of PGC records. Each record is composed of a sequence of one or more bytes. The first byte is the PGN record marker and it specifies the interpretation of the remaining portion of the record. This remaining portion is composed of zero or more PGN record items. Item types include move sequences, move sets, and character strings. 20.1 BYTES, WORDS, AND DOUBLEWORDS ---------------------------------- At the lowest level, PGC binary data is organized as bytes, words (two contiguous bytes), and doublewords (four contiguous bytes). All eight bits of a byte are used. Longwords (eight contiguous bytes) are not used. Integer values are stored using two's complement representation. Integers may be signed or unsigned depending on context. Multibyte integers are stored in low-endian format with the least significant byte appearing first. A one byte integer item is called "int-1". A two byte integer item is called "int-2". A four byte integer item is called "int-4". Characters are stored as bytes using the ISO 8859/1 Latin-1 (ECMA-94) code set. There is no provision for other characters sets or representations. 20.2 MOVE ORDINALS ------------------ A chess move is represented using a move ordinal. This is a single unsigned byte quantity with values from zero to 255. A move ordinal is interpreted as an index into the list of legal moves from the current position. This list is constructed by generating the legal moves from the current position, assigning SAN ASCII strings to each move, and then sorting these strings in ascending order. Note that a seven bit ordinal, as used by some inferior representation systems, is insufficient as there are some positions that have more than 128 moves available. Examples: From the initial position, there are twenty moves. Move ordinal 0 corresponds to the SAN move string "Na3"; move ordinal 1 corresponds to "Nc3", move ordinal 4 corresponds to "a3", and move ordinal 19 corresponds to "h4". Moves can be organized into sequences and sets. A move sequence is an ordered list of moves that are played, one after another from first to last. A move set is a list of moves that are all playable from the current position. Move sequence data is represented using a length header followed by move ordinal data. The length header is an unsigned integer that may be a byte or a word. The integer gives the number, possibly zero, of following move ordinal bytes. Most move sequences can be represented using just a byte header; these are called "mvseq-1" items. Move sequence data using a word header are called "mvseq-2" items. Move set data is represented using a length header followed by move ordinal data. The length header is an unsigned integer that is a byte. The integer gives the number, possibly zero, of following move ordinal bytes. All move sets are be represented using just a byte header; these are called "mvset-1" items. (Note the implied restriction that a move set can only have a maximum of 255 of the possible 256 ordinals present at one time.) 20.3 STRING DATA ---------------- PGC string data is represented using a length header followed by bytes of character data. The length header is an unsigned integer that may be a byte, a word, or a doubleword. The integer gives the number, possibly zero, of following character bytes. Most strings can be represented using just a byte header; these are called "string-1" items. String data using a word header are called "string-2" items and string data using a doubleword header are called "string-4" items. No special ASCII NUL termination byte is required for PGC storage of a string as the length is explicitly given in the item header. 20.4 MARKER CODES ----------------- PGC marker codes are given in hexadecimal format. PGC marker code zero (marker 0x00) is the "noop" marker and carries no meaning. Each additional marker code defined appears in its own subsection below. 20.4.1 MARKER 0x01: REDUCED EXPORT FORMAT SINGLE GAME ----------------------------------------------------- Marker 0x01 is used to indicate a single complete game in reduced export format. This refers to a game that has only the Seven Tag Roster data, played moves, and no annotations or comments. This record type is used as an alternative to the general game data begin/end record pairs described below. The general marker pair (0x05/0x06) is used to help represent game data that can't be adequately represented in reduced export format. There are eight items that follow marker 0x01 to form the "reduced export format single game" record. In order, these are: 1. string-1 (Event tag value) 2. string-1 (Site tag value) 3. string-1 (Date tag value) 4. string-1 (Round tag value) 5. string-1 (White tag value) 6. string-1 (Black tag value) 7. string-1 (Result tag value) 8. mvseq-2 (played moves) 20.4.2 MARKER 0x02: TAG PAIR ---------------------------- Marker 0x02 is used to indicate a single tag pair. There are two items that follow marker 0x02 to form the "tag pair" record; in order these are: 1. string-1 (tag pair name) 2. string-1 (tag pair value) 20.4.3 MARKER 0x03: SHORT MOVE SEQUENCE --------------------------------------- Marker 0x03 is used to indicate a short move sequence. There is one item that follows marker 0x03 to form the "short move sequence" record; this is: 1. mvseq-1 (played moves) 20.4.4 MARKER 0x04: LONG MOVE SEQUENCE -------------------------------------- Marker 0x04 is used to indicate a long move sequence. There is one item that follows marker 0x04 to form the "long move sequence" record; this is: 1. mvseq-2 (played moves) 20.4.5 MARKER 0x05: GENERAL GAME DATA BEGIN ------------------------------------------- Marker 0x05 is used to indicate the beginning of data for a game. It has no associated items; it is a complete record by itself. Instead, it marks the beginning of PGC records used to describe a game. All records up to the corresponding "general game data end" record are considered to be part of the same game. (PGC record type 0x01, "reduced export format single game", is not permitted to appear within a general game begin/end record pair. The general game construct is to be used as an alternative to record type 0x01 in those cases where the latter is too restrictive to contain the data for a game.) 20.4.6 MARKER 0x06: GENERAL GAME DATA END ----------------------------------------- Marker 0x06 is used to indicate the end of data for a game. It has no associated items; it is a complete record by itself. Instead, it marks the end of PGC records used to describe a game. All records after the corresponding (and earlier appearing) "general game data begin" record are considered to be part of the same game. 20.4.7 MARKER 0x07: SIMPLE-NAG ------------------------------ Marker 0x07 is used to indicate the presence of a simple NAG (Numeric Annotation Glyph). This is an annotation marker that has only a short type identification and no operands. There is one item that follows marker 0x07 to form the "simple-nag" record; this is: 1. int-1 (unsigned NAG value, from 0 to 255) 20.4.8 MARKER 0x08: RAV-BEGIN ----------------------------- Marker 0x08 is used to indicate the beginning of an RAV (Recursive Annotation Variation). It has no associated items; it is a complete record by itself. Instead, it marks the beginning of PGC records used to describe a recursive annotation. It is considered an opening bracket for a later rav-end record; the recursive annotation is completely described between the bracket pair. The rav-begin/data/rav-end structures can be nested. 20.4.9 MARKER 0x09: RAV-END --------------------------- Marker 0x09 is used to indicate the end of an RAV (Recursive Annotation Variation). It has no associated items; it is a complete record by itself. Instead, it marks the end of PGC records used to describe a recursive annotation. It is considered a closing bracket for an earlier rav-begin record; the recursive annotation is completely described between the bracket pair. The rav-begin/data/rav-end structures can be nested. 20.4.10 MARKER 0x0A: ESCAPE-STRING ---------------------------------- Marker 0x0a is used to indicate the presence of an escape string. This is a string represented by the use of the percent sign ("%") escape mechanism in PGN. The data that is escaped is the sequence of characters immediately follwoing the percent sign up to but not including the terminating newline. As is the case with the PGN percent sign escape, the use of a PGC escape-string record is limited to use for non-archival data. There is one item that follows marker 0x0a to form the "escape-string" record; this is the string data being escaped: 1. string-2 (escaped string data) SEE ALSO ======== New in Chess Encyclopedia of Chess Openings Reinfeld's 1001 Winning Chess Sacrifices and Combinations