Introduction

This is the home page for the pgn-extract program, which is a command-line program for searching, manipulating and formatting chess games recorded in the Portable Game Notation (PGN) or something close. It is capable of handling files containing millions of games. It also recognises Chess960 encodings.

A full description of pgn-extract's functionality is available and included with the sources.

Here you can find the C source code and win32 binary for the current version. pgn-extract compiles and runs under Windows, Linux and Mac OS X. This program is made available under the terms of the GNU General Public License (Version 1).

Overview

The program is designed to make it easy to extract selected games from a PGN format data file based on a wide variety of criteria. The criteria include:

  • textual move sequences;

  • the position reached after a sequence of moves;

  • information in the tag fields;

  • fuzzy board position;

  • and material balance in the ending.

Over the on-going 20-year course of its development, it has also added lots of features for controlling what is output (e.g., different algebraic formats, EPD, no move numbers, restricting game length, etc.)

The program includes a semantic analyser which will report errors in game scores and it is also able to detect duplicate games found in its input files.

The range of input move formats accepted is fairly wide and includes recognition of lower-case piece letters for English and upper-case piece letters for Dutch and German. The output is normally in English Standard Algebraic Notation (SAN), but this can be varied.

Extracted games may be written out either including or excluding comments, NAGs, variations, move numbers, tags and/or results. Games may be given ECO classifications derived from the accompanying file eco.pgn, or a customised version provided by the user.

The program is designed to be relatively memory-friendly, so it does not retain a game's moves in memory once it has been processed. This also makes it suitable for bulk processing very large collections of games - it can efficiently process files containing several millions of games.

Use the --help argument to the program to get the full lists of arguments.

New in recent versions

These are the main changes in the most recent versions:

  • Adds --splitvariants for functionality similar to pgnsplit.

  • Fixes failure when -x and -n are used together;

  • Fixes lack of output with -W;

  • Extends --selectonly to multiple games and ranges;

  • Adds --skipmatching to suppress games;

  • Added Zobrist hashcodes for matching games;

  • Corrects some missing PGN info from games.

  • Stop after matching a required number of games.

  • Only output games of a limited number of ply.

  • Filter out (or in) games with a SetUp tag.

  • Output a FEN comment at a specific position within a game.

Available Files

You can take a copy of the full source and documentation as either pgn-extract.tgz or pgn-extract.zip. Alternatively, a win32 binary is available.

Name Description Size Date
pgn-extract.tgz
GZipped tar file of the complete source of the latest version of the program.
Includes usage documentation, Makefile for compilation and eco.pgn file for ECO classification.
360K bytes  Apr 1st 2017
pgn-extract.zip Zipped file of the complete source of the latest version of the program.
Includes usage documentation, Makefile for compilation and eco.pgn file for ECO classification.
500K bytes  Apr 1st 2017
pgn-extract.exe win32 binary of the latest version of the program. 620K bytes  Apr 1st 2017
eco.zip Zipped version of eco.pgn. 32K bytes  May 24 2013
eco.pgn File of openings with PGN classification.
This file is already included in the source archives.
254K bytes  May 24 2013
COPYING GNU General Public License (version 1). 12K bytes  Dec 05 1997

Feedback

Feedback and suggestions for further features are always welcome, although I can't always promise to undertake significant development work.