Skip to content

Commit

Permalink
Release 1.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@Geras1mleo
Geras1mleo committed May 28, 2022
1 parent cc1dce9 commit 8429abe
Show file tree
Hide file tree
Showing 2 changed files with 235 additions and 6 deletions.
16 changes: 10 additions & 6 deletions ChessLibrary/ChessLibrary.csproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@
<PackagePath>\</PackagePath>
</None>
<None Include="..\.editorconfig" Link=".editorconfig" />
<None Include="..\README.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
<None Include="..\LICENSE.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
Expand All @@ -26,6 +22,13 @@
<ItemGroup>
<PackageReference Include="Ardalis.SmartEnum" Version="2.0.1" />
</ItemGroup>

<ItemGroup>
<None Update="README_NUGET.md">
<Pack>True</Pack>
<PackagePath>\</PackagePath>
</None>
</ItemGroup>
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<DebugType>embedded</DebugType>
Expand All @@ -34,13 +37,14 @@
<Authors>Geras1mleo</Authors>
<Copyright>Copyright (c) 2022 Geras1mleo</Copyright>
<PackageProjectUrl></PackageProjectUrl>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageReadmeFile>README_NUGET.md</PackageReadmeFile>
<RepositoryUrl>https://github.com/Geras1mleo/Chess</RepositoryUrl>
<PackageTags>chess;chessboard;chess-game;chess-position;standard-algebraic-notation;chess-move;forsyth-edwards-notation;chess-validator;chess-variations</PackageTags>
<PackageReleaseNotes>First release</PackageReleaseNotes>
<PackageReleaseNotes></PackageReleaseNotes>
<PackageIcon>knight.png</PackageIcon>
<PackageId>Gera.Chess</PackageId>
<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
<RepositoryType>git</RepositoryType>
<Version>1.0.1</Version>
</PropertyGroup>
</Project>
225 changes: 225 additions & 0 deletions ChessLibrary/README_NUGET.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
# Gera Chess Library

Chess logic made with C# and &hearts; by Geras1mleo

## Chess lib includes:

- Chess board with 2-dimentional array of `Pieces`
- Generation, Validation and Execution of `Moves` on Chess board
- Logic to `Convert`:
- `Move` into `SAN` and back into Move object
- `Chess Board`into `FEN` and back into ChessBoard object
- `Chess Game` into `PGN` and back into ChessBoard object
- Event Handlers:
- `OnInvalidMoveKingChecked` - Raises when trying to execute move that places own king in check
- `OnWhiteKingCheckedChanged`/`OnBlackKingCheckedChanged` with state (checked or not) and its position
- `OnPromotePawn` with PromotionEventArgs.PromotionResult (default: PromotionToQueen)
- `OnEndGame` with according end game info (`Win`/`Loss`/`Draw`)
- `OnCaptured` with captured piece and all recently captured pieces (White/Black)
- `End Game` Declaration: `Draw` or `Resign` of one of sides
- `Navigation` between executed moves:
- `First`/`Last`
- `Next`/`Previous`
- Also: `board.MoveIndex` property to navigate direct to specific move
- `Cancelation` of last executed move

# Usage!

Example simple console chess game:

```csharp
using Chess;

var board = new ChessBoard();

while (!board.IsEndGame)
{
Console.WriteLine(board.ToAscii());
board.Move(Console.ReadLine());
}

Console.WriteLine(board.ToAscii());
Console.WriteLine(board.ToPgn());

// Outcome after last move:
// Qh5
// ┌────────────────────────┐
// 8 │ r n b q k b n r │
// 7 │ p p p p p . . p │
// 6 │ . . . . . . . . │
// 5 │ . . . . . p p Q │
// 4 │ . . . . P P . . │
// 3 │ . . . . . . . . │
// 2 │ P P P P . . P P │
// 1 │ R N B . K B N R │
// └────────────────────────┘
// a b c d e f g h
//
// 1. e4 f5 2. f4 g5 3. Qh5# 1-0
```

Example random chess game:

```csharp
while (!board.IsEndGame)
{
var moves = board.Moves();
board.Move(moves[Random.Shared.Next(moves.Length)]);
}

Console.WriteLine(board.ToAscii());
Console.WriteLine(board.ToPgn());

// Todo: End game Insufficient Material
```

## Track Pieces

Track pieces on position using indexers:

```csharp
board["c2"]... // => White Pawn
board['g', 8]... // => Black Bishop
// Counting from 0
board[0, 0]... // => White Rook
board[new Position(4, 7)]... // => Black King
```

Track captured pieces:

```csharp
board.CapturedWhite... // => White pieces that has been captured by black player
board.CapturedBlack... // => Black pieces that has been captured by white player
// Properties above work just fine when board has been loaded from FEN
```

Track kings and their state (Checked/Unchecked):

```csharp
board.WhiteKing... // => White king position on chess board (Calculated property)
board.BlackKing... // => Black king position on chess board (Calculated property)
board.WhiteKingChecked... // => State of White king (Referred property)
board.BlackKingChecked... // => State of Black king (Referred property)
```

## Move Pieces

Move pieces using SAN/LAN:

```csharp
board.Move("e4"); // => Good
board.Move("N-f6"); // => Good
board.Move("NXf6"); // => Good
board.Move("dxc3 e.p.");// => Good
board.Move("Pe4"); // => Good
board.Move("Pe5xd6"); // => Good
board.Move("O-O-O+"); // => Good
board.Move("ne5"); // => Bad
board.Move("e8=K"); // => Bad
board.Move("0-0"); // => Bad
```

Move pieces using Move object and corresponding positions:

```csharp
board.Move(new Move("b1", "c3"));
```

Ambiguity:

```csharp
board.LoadPgn("1. e4 e5 2. Ne2 f6");
board.ToAscii();
// ┌────────────────────────┐
// 8 │ r n b q k b n r │
// 7 │ p p p p . . p p │
// 6 │ . . . . . p . . │
// 5 │ . . . . p . . . │
// 4 │ . . . . P . . . │
// 3 │ . . . . . . . . │
// 2 │ P P P P N P P P │
// 1 │ R N B Q K B . R │
// └────────────────────────┘
// a b c d e f g h
board.Move("Nc3"); // => Throws exception: ChessSanTooAmbiguousException. Both knights can move to c3
board.Move("Nc4"); // => Throws exception: ChessSanNotFoundException. None of knights can move to c3
```

## Load Chess game/board

Load chess board Variant: From Position (FEN):

```csharp
board.LoadFen("1nbqkb1r/pppp1ppp/2N5/4p3/3P4/8/PPP1PPPP/RN2KB1R w KQk - 0 1");
board.ToAscii();
// ┌────────────────────────┐
// 8 │ . n b q k b . r │
// 7 │ p p p p . p p p │
// 6 │ . . N . . . . . │
// 5 │ . . . . p . . . │
// 4 │ . . . P . . . . │
// 3 │ . . . . . . . . │
// 2 │ P P P . P P P P │
// 1 │ R N . . K B . R │
// └────────────────────────┘
// a b c d e f g h
board.CapturedWhite... // => { White Bishop, White Queen }
board.CapturedBlack... // => { Black Rook, Black Knight }
// Stalemate
board.LoadFen("rnb1kbnr/pppppppp/8/8/8/8/5q2/7K w kq - 0 1");
board.EndGame... // => { EndgameType = Stalemate, WonSide = null }
```

Load full chess game from PGN:

```csharp
board.LoadPgn(
@"[Variant ""From Position""]
[FEN ""rnbqkbnr/ppp1pppp/8/3p4/4P3/8/PPPP1PPP/RNBQKBNR w KQkq - 0 1""]
1.exd5 e6 2.dxe6 fxe6 3.d4(3.f4 g5 4.fxg5) 3... c5 4.b4");

board.ToAscii();
// ┌────────────────────────┐
// 8 │ r n b q k b n r │
// 7 │ p p . . . . p p │
// 6 │ . . . . p . . . │
// 5 │ . . p . . . . . │
// 4 │ . P . P . . . . │
// 3 │ . . . . . . . . │
// 2 │ P . P . . P P P │
// 1 │ R N B Q K B N R │
// └────────────────────────┘
// a b c d e f g h
```

Alternative moves and comments are getting (temporary) skipped
In further versions:
Navigate between alternative branches
Saving and adding of comments to each move

## End Game

Declare Draw/Resign:

```csharp
board.Draw();
board.EndGame... // => { EndgameType = DrawDeclared, WonSide = null }
board.Clear();

board.Resign(PieceColor.Black);
board.EndGame... // => { EndgameType = Resigned, WonSide = White }
```

## Found a bug?

Drop to [Issues](https://github.com/Geras1mleo/Chess/issues)
Or to: sviatoslav.harasymchuk@gmail.com
Thanks in advance!

0 comments on commit 8429abe

Please sign in to comment.