https://github.com/youssef1313/chesssharp

ChessSharp - A chess library written in C#
https://github.com/youssef1313/chesssharp

chess chess-game chess-library chessharp csharp dotnet library

Last synced: 12 days ago
JSON representation

ChessSharp - A chess library written in C#

• Host: GitHub
• URL: https://github.com/youssef1313/chesssharp
• Owner: Youssef1313
• Created: 2019-07-18T18:44:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-28T12:21:32.000Z (6 months ago)
• Last Synced: 2024-10-13T20:29:58.252Z (26 days ago)
• Topics: chess, chess-game, chess-library, chessharp, csharp, dotnet, library
• Language: C#
• Homepage: https://youssef1313.github.io/ChessSharp/
• Size: 2.39 MB
• Stars: 25
• Watchers: 4
• Forks: 8
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Welcome to ChessSharp 👋

[![Build status](https://ci.appveyor.com/api/projects/status/fbrec04diyk4vf2s/branch/master?svg=true)](https://ci.appveyor.com/project/Youssef1313/chesssharp/branch/master)

ChessSharp is a chess library built in C#. The repository includes a simple WinForms application that consumes the library.

## Install the package

- To install the package from Package Manager Console, run the following command:

    ```

    Install-Package ChessSharp

    ```

- To install the package from .NET CLI, run the following command:

    ```

    dotnet add package ChessSharp

    ```

- To install using the PackageReference, add the following XML node into your project file. For more information about PackageReference, see [NuGet package reference format](https://docs.microsoft.com/nuget/consume-packages/package-references-in-project-files).

    ```xml

    

    ```

## Repository structure

The repository consists of three folders:

- `Documentation` folder: This folder is generated by [docFX](https://github.com/dotnet/docfx).

- `docs` folder: This is the actual website (defaultly called `_site`) generated by docFX. It's rendered by GitHub pages in [https://youssef1313.github.io/ChessSharp/](https://youssef1313.github.io/ChessSharp/).

- `src` folder: This folder contains the actual source code and contains four folders:

    - `ChessSharp.UnitTests`: *Currently, there are no unit tests for the library.*

    - `ChessSharp`: The source code of the library.

    - `ChessUI`: a WinForms project that consumes the library.

    - `ChessSharpWeb`: an ASP.NET Core MVC project that consumes the library. **Not completed, and not working currently.**

## Screenshot of the UI (WinForms) project

![Screenshot](https://user-images.githubusercontent.com/31348972/62772795-c8ecb300-baa0-11e9-80a0-fc334f643547.png)

## 🤝 Contributing

Contributions, issues, bug reports, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Youssef1313/ChessSharp/issues).

Can you make ChessSharp better ? Feel free to open a pull request.

## Show your support

Give a ⭐️ if this project helped you!

### Please note that this project is *still under development*, but it's working well!