Skip to content

Lightweight, blazingly fast (overly optimized) CLI for reading .pgn files

License

Notifications You must be signed in to change notification settings

PogSmok/pgn-reader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Screenshot

PGN Reader

Lightweight, blazingly fast (overly optimized) CLI for reading .pgn files


Report a bug Suggest a feature


License Version Latest Release

Overview

PGN Reader is a user-friendly and efficient application that allows you to read .pgn files smoothly through a terminal. The application is incredibly fast and lightweight, which means it can work on almost any device or system. It supports Chess 960 and can handle variations, comments, and annotations with clean and readable formatting. PGN Reader provides a simple way to access all the necessary information from your .pgn files.

Files

PGN reader consists of:

  • README.md > File explaning everything about the application
  • LICENSE > License under which the program must be used
  • EXAMPLE.png > Screenshot of a terminal while viewing a game in PGN Reader
  • example.pgn > Annotated PGN file containing The Game Of The Century
  • src > Directory with source code of the application

Usage

Using and compiling PGN Reader is as easy as it gets. Download the entire project and then compile the source code.
NOTE: you have to compile all .c files, not only main.c

  gcc -o pgn-reader ./src/*.c

After the program is compiled, view .pgn file as follows

  <executable> <path to .pgn file>
  ./pgn-reader ./example.pgn

FAQ

Q: What is a .pgn file?

A: It's a file extension specifically used for saving chess games. More information on wikipedia


Q: How do I save my game as a .pgn file?

A: The quickest way is to use lichess and import a game to their site (you can get a computer analysis for free too). Then, in an analysis tab, you can export your game as a .pgn.


Q: When will I ever need this program?

A: If ever an alien civilization destroys all network infrastructure and asks you to present them The Game of the Century within a few milliseconds, or otherwise they will destroy everything you know and love, only then will your gratitude be immeasurable.