Add PGN output format support with backward compatibility#4
Draft
Add PGN output format support with backward compatibility#4
Conversation
Contributor
Author
|
@ianfab 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: ianfab <12969303+ianfab@users.noreply.github.com>
Co-authored-by: ianfab <12969303+ianfab@users.noreply.github.com>
Co-authored-by: ianfab <12969303+ianfab@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] PGN output format
Add PGN output format support with backward compatibility
Aug 13, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds support for PGN output format to the bookgen tool while maintaining full backward compatibility with the existing EPD format.
Overview
Previously, bookgen only supported EPD (Extended Position Description) format output, which provides FEN positions but lacks the complete game context. This enhancement adds PGN (Portable Game Notation) format support, allowing users to generate opening books as complete games with proper headers and algebraic notation.
Key Features
New UCI Options
BookFormat: Choose between "epd" (default) and "pgn" output formatsBookPath: Generic path for book files with automatic extension detectionEPDPathfor backward compatibilityEnhanced Data Structures
BookEntrystructure to store both FEN positions and complete move sequencesPGN Output Format
Usage Examples
EPD Format (unchanged, backward compatible):
PGN Format (new functionality):
Testing
The implementation includes comprehensive tests that verify:
Example PGN output:
Implementation Details
The changes are minimal and surgical:
This enhancement makes bookgen more versatile by supporting engines and analysis tools that prefer game-based input over position-based input, while ensuring zero impact on existing users.
Fixes #1.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.