core_2.13

core

License	Apache-2.0
GroupId	io.github.ghostbuster91
ArtifactId	core_2.13
Last Version	v0.0.2
Release Date	Mar 15, 2021
Type	jar
Description	core_2.13 core
Project URL	https://github.com/ghostbuster91/pgn-parser
Source Code Management	https://github.com/ghostbuster91/pgn-parser

Download core_2.13

Filename	Size
core_2.13-v0.0.2.pom
core_2.13-v0.0.2.jar	39 KB
core_2.13-v0.0.2-sources.jar	1 KB
core_2.13-v0.0.2-javadoc.jar	1 MB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.ghostbuster91/core_2.13/ -->
<dependency>
    <groupId>io.github.ghostbuster91</groupId>
    <artifactId>core_2.13</artifactId>
    <version>v0.0.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.ghostbuster91/core_2.13/
implementation 'io.github.ghostbuster91:core_2.13:v0.0.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.ghostbuster91/core_2.13/
implementation ("io.github.ghostbuster91:core_2.13:v0.0.2")

Apache Buildr

'io.github.ghostbuster91:core_2.13:jar:v0.0.2'

Apache Ivy

<dependency org="io.github.ghostbuster91" name="core_2.13" rev="v0.0.2">
  <artifact name="core_2.13" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.ghostbuster91', module='core_2.13', version='v0.0.2')
)

Scala SBT

libraryDependencies += "io.github.ghostbuster91" % "core_2.13" % "v0.0.2"

Leiningen

[io.github.ghostbuster91/core_2.13 "v0.0.2"]

Dependencies

compile (1)

Group / Artifact	Type	Version
io.github.ghostbuster91 : chessModel_2.13	jar	v0.0.2

Project Modules

There are no modules declared in this project.

pgn-parser

parser

Parser can simply parse chess games stored in PGN format.

val inputGame = "1. e4 e5 2. Bc4 Bc5 3. Qh5 Nf6 4. Qxf7# 1-0"
PgnParser.pgnGame.parseAll(inputGame)
res1: Either[cats.parse.Parser.Error, io.github.ghostbuster91.pgnparser.parser.PgnGame] =
Right(
  PgnGame(
    List(),
    List(
      Round(
        1,
        PawnMove(Position('e', '4'), NoCheck, None),
        Some(PawnMove(Position('e', '5'), NoCheck, None))
      ),
      Round(
        2,
        FigureMove(Bishop, Position('c', '4'), NoCheck, None, None, false),
        Some(FigureMove(Bishop, Position('c', '5'), NoCheck, None, None, false))
      ),
      Round(
        3,
        FigureMove(Queen, Position('h', '5'), NoCheck, None, None, false),
        Some(FigureMove(Knight, Position('f', '6'), NoCheck, None, None, false))
      ),
      Round(4, FigureMove(Queen, Position('f', '7'), Checkmate, None, None, true), None)
    ),
    WhiteWins
  )
)

In case of malformed input an error will be returned:

val malformedGame = "1. e4 e5 2. Bc4 Bc5 3. Qh5 Nf6asdasd"
PgnParser.pgnGame.parseAll(malformedGame)
res6: Either[cats.parse.Parser.Error, io.github.ghostbuster91.pgnparser.parser.PgnGame] = Left(
  Error(
    20,
    NonEmptyList(Str(20, "0-1"), List(Str(20, "1-0"), Str(20, "1/2-1/2"), InRange(20, '*', '*')))
  )
)

reader

Reader is an abstraction build on top of parser. Apart from parsing the game, reader also converts it to unambiogious LAN format. It does that by partially implementing chess rules needed to filter out incorrect movements.

val inputGame = "1. e4 e5 2. Bc4 Bc5 3. Qh5 Nf6 4. Qxf7# 1-0"
new PgnReader().read(inputGame)
res2: Either[io.github.ghostbuster91.pgnparser.core.ParsingException, io.github.ghostbuster91.pgnparser.core.ChessGame] = Right(
  ChessGame(
    Board(
      HashMap(
        Coordinate(1, 0) -> PlayerPiece(Knight, White),
        Coordinate(4, 3) -> PlayerPiece(Pawn, White),
        Coordinate(4, 7) -> PlayerPiece(King, Black),
        Coordinate(3, 7) -> PlayerPiece(Queen, Black),
        Coordinate(7, 1) -> PlayerPiece(Pawn, White),
        Coordinate(4, 0) -> PlayerPiece(King, White),
        Coordinate(1, 1) -> PlayerPiece(Pawn, White),
        Coordinate(0, 1) -> PlayerPiece(Pawn, White),
        Coordinate(0, 0) -> PlayerPiece(Rook, White),
...

The whole output is actually to big to be included in the readme as reader outputs the game as a list of state transistions of a chess board. The structer of the result looks as follows:

case class ChessGame(
    board: Board,
    currentPlayer: Player,
    previousState: Option[(ChessGame, LanMove)]
)

Reader does not verify game's correctness. The game is assumed to be valid.

Versions

Version
v0.0.2 Mar 15, 2021