Skip to content

Latest commit

 

History

History
80 lines (54 loc) · 2.74 KB

README.md

File metadata and controls

80 lines (54 loc) · 2.74 KB
Raw

ChessKit

codebeat badge docs badge Tests ChessKit pod

Lightweight and fast chess framework written in Swift.

ChessKit is used as a base framework for Ladoga chess engine.

Installation

The ChessKit framework is avalable for installation via Swift Package Manager and CocoaPods.

Swift Package Manager

Add a dependency via Xcode, linking to https://github.com/aperechnev/ChessKit, or directly in your Package.swift file:

import PackageDescription

let package = Package(
    name: "MyPackage",
    platforms: [
        .macOS(.v10_12),
    ],
    dependencies: [
        .package(url: "https://github.com/aperechnev/ChessKit.git", from: "1.2.10"),
    ],
    targets: [
        .target(name: "MyPackage", dependencies: ["ChessKit"]),
    ]
)

CocoaPods

To install ChessKit via CocoaPods, just add a dependencie to your Podfile:

target 'MyApp' do
  pod 'ChessKit'
end

Getting Started

ChessKit is well covered by documentation. But anyway here you can find an example describing how to start working with ChessKit faster.

import ChessKit

let italianGameFen = "r1bqk1nr/pppp1ppp/2n5/2b1p3/2B1P3/5N2/PPPP1PPP/RNBQK2R w KQkq - 4 4"
let italianGamePosition = FenSerialization.default.deserialize(fen: italianGameFen)
let game = Game(position: italianGamePosition)

print("Number of available moves: \(game.legalMoves.count)")

game.make(move: "b2b4")
let evansGambitFen = FenSerialization.default.serialize(position: game.position)
print("Evans gambit fen: \(evansGambitFen)")

game.make(move: Move(string: "c5b4"))
let evansGambitAcceptedFen = FenSerialization.default.serialize(position: game.position)
print("Evans gambit accepted fen: \(evansGambitAcceptedFen)")

print("List of moves in game: \(game.movesHistory)")
print("List of pieces on board: \(game.position.board.enumeratedPieces())")

How To Contribute

Please follow the git-flow notation and make sure that all tests are passing before contributing. Your questions and pull requests are welcome.

Versioning

We are using semantic versioning.

License

ChessKit is released under the MIT license. See LICENSE for details.