chijason99 / xiangqi-core

A class library for C# XiangQi project

Xiangqi-Core Nuget Package

Description

Xiangqi-Core is a comprehensive library designed to facilitate the development of applications related to Xiangqi (Chinese Chess). It provides a robust set of functionalities including move generation, move validation, game state management, etc. Built with flexibility and performance in mind, XiangqiCore aims to be the go-to solution for developers looking to integrate Xiangqi mechanics into their software.

Features

• Fluent API: Provides a fluent API for easy configuration and initialization of game instances.
• Game State Management: Easily manage game states, including piece positions, turn tracking, and game outcome detection.
• Parsing of Move Notations: Supports parsing of move notations in UCCI, Chinese, and English, allowing for versatile game command inputs.
• Move Validation: Validate player moves, ensuring moves adhere to the rules of Xiangqi.
• Utility Functions: A collection of utility functions for piece and board management, including piece movement simulation and position checking.

Installation

Xiangqi-Core is available as a NuGet package. You can install it using the NuGet Package Manager or the dotnet CLI.

dotnet add package Xiangqi-Core

Usage

To get started with Xiangqi-Core, first import the package into your project:

using XiangqiCore;

Here's a simple example of setting up a game board and making a move:

// Create a new game instance with the help of the XiangqiBuilder
XiangqiBuilder builder = new (); 
XiangqiGame game = builder.UseDefaultConfiguration().Build();
	
// Make a move
game.MakeMove("炮二平五", MoveNotationType.Chinese);

Refer to the documentation for more detailed examples and usage instructions.

Contributing

Contributions to Xiangqi-Core are welcome! If you have suggestions for improvements or bug fixes, please feel free to fork the repository and submit a pull request.

License

Xiangqi-Core is licensed under the MIT License. See the LICENSE file for more details.

Contact

For questions or support, please contact [email protected]

xiangqi-core's Issues

Fen Validation

Create a class called Fen Validator, that can validate the input FEN and return a boolean value.
Unit test for the validator as well

Move method in XiangqiGame

The move method should modify the board position

Move method should have several overloads:

1. Move notation + move notation enum
2. Starting coordinate and destination coordinate

Generate complete FEN with turn order, number of moves without capturing piece, and current round

ASCII diagram of xiangqi board state

can call a method to generate the ascii diagram of xiangqi board

Make attributes to help with piece validation

Make attributes to help with piece validation; finish the validationStrategy and unit tests

convert UCCI notation into Chinese notation

support random position of pieces to generate random endgames

Will expose king to danger validation

implement the logic about the will expose king to danger in the default validation strategy base class

Create board after creating the the game instance

After creating a xiangqi game instance with the xiangqi builder, there should be a board inside the Game object. It should be generated from the FEN, and there should be DIfferent pieces and validation. It would be a big feature

documenation

write the documentation for the apis and the project

Move notation

In the board, create a method called generate move notation, that would take the starting coordinate and ending coordinate, and making a move.

Should make custom attributes to simply the work

Note that the pawn would have a different move notation when there are more than two pieces in the same file

Bonus: able to provide options for different type of notation(english notation, chinese notation)

Allow user to create a game instance using a pgn game record

Create a game with Competition

Inside the Xiangqi builder, there should be a method that allows user to create a game with a competition name

export game in PGN format

add a new api, allowing users to export game in PGN format

ability to create a game instance by specifying the position of the piece

ability to create a game instance by specifying the position of the piece when using the xiangqi builder;