tanczosm / LichessApi

A .Net REST client for the Lichess API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Lichess .Net Api Client



Lichess is a free and open-source Internet chess server run by a non-profit organization of the same name. This project implements a .Net client for the Lichess Api.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

LichessApi was originally started to be utilized to create a chess league manager that could create team vs team pairings. It is worth noting that there is additionally an OAuth Asp.net provider that I have written over on the third-party https://github.com/aspnet-contrib/AspNet.Security.OAuth.Providers project that can be utilized in conjunction with this client.

Features

  • Easy integration with OAuth2

  • Token Auth session compatible

  • Well-typed data structures for all responses and requests

Getting Started

LichessApi is an API client library for .NET and is available on NuGet (IN PROGRESS):

Install-Package LichessApi.Web

Usage

using System;
using LichessApi.Web;

class Program
{
    static async Task Main()
    {
      var client = new LichessApiClient("YourAccessToken");

      var email = await client.Account.GetEmailAddress();
	  
      Console.WriteLine(email);
    }
}

More examples can be found in the LichessApi.Web.Examples directory.

Roadmap

The following Api areas have been completed so far:

  • Authentication
  • Account
  • Users
  • Relations
  • Games
  • Puzzles
  • Teams
  • Board
  • Bot
  • Bulk Pairings
  • Challenges
  • Arena Tournaments
  • Swiss Tournaments
  • Simuls
  • Studies
  • Messaging
  • Broadcasts
  • Analysis
  • Opening Explorer

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Michael Tanczos

Project Link: https://github.com/tanczosm/LichessApi

Acknowledgements

About

A .Net REST client for the Lichess API

License:Other


Languages

Language:C# 99.1%Language:HTML 0.4%Language:JavaScript 0.3%Language:CSS 0.1%