-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b72eefb
commit f4f5cc4
Showing
8 changed files
with
118 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
[package] | ||
name = "chessboard" | ||
name = "cinder" | ||
version = "0.1.0" | ||
authors = ["Bruno Dutra <[email protected]>"] | ||
edition = "2021" | ||
description = "A chess engine" | ||
repository = "https://github.com/brunocodutra/chessboard.git" | ||
repository = "https://github.com/brunocodutra/cinder.git" | ||
license = "GPL-3.0" | ||
readme = "README.md" | ||
keywords = ["chess"] | ||
|
@@ -66,7 +66,7 @@ path = "lib/lib.rs" | |
bench = false | ||
|
||
[[bin]] | ||
name = "cli" | ||
name = "cinder" | ||
path = "bin/main.rs" | ||
bench = false | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
[tasks.dist] | ||
[tasks.cinder] | ||
command = "cargo" | ||
args = [ | ||
"build", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,56 @@ | ||
# Chessboard [![codecov.badge]][codecov.home] | ||
|
||
A sandbox for experimenting with chess engines. | ||
<div align="center"> | ||
<img src="logo.svg" width="250px" alt="Cinder"/> | ||
<h1>• C I N D E R •</h1> | ||
<br> | ||
</div> | ||
|
||
## Overview | ||
|
||
Cinder is an independent chess engine written in Rust from scratch. | ||
With a playing strength that is far superior to what humans are capable of, | ||
Cinder is primarily developed to play against other engines. It is regularly tested | ||
at the extremely short time control of 3s+25ms per game. The shorter the time control, | ||
the stronger Cinder tends to play. | ||
|
||
## Usage | ||
|
||
Cinder implements the UCI protocol and should be compatible with most current | ||
chess graphical user interfaces (GUI). Users who are familiar with the UCI protocol | ||
may also interact with Cinder directly on a terminal via its command line interface (CLI). | ||
In addition to the standard UCI commands, Cinder also implements a custom command `eval` | ||
that prints Cinder's evaluation of the current position in its own internal units. | ||
|
||
### Example | ||
|
||
``` | ||
uci | ||
id name Cinder | ||
id author Bruno Dutra | ||
option name Hash type spin default 16 min 0 max 33554432 | ||
option name Threads type spin default 1 min 1 max 65536 | ||
uciok | ||
go depth 15 | ||
info score cp +17 pv d2d4 g8f6 c2c4 e7e6 g1f3 d7d5 b1c3 f8b4 c4d5 e6d5 c1g5 b4c3 b2c3 h7h6 g5f6 | ||
bestmove d2d4 | ||
``` | ||
|
||
## Contribution | ||
|
||
Chessboard is an open source project and you're very welcome to contribute to this project by | ||
Cinder is an open source project and you're very welcome to contribute to this project by | ||
opening [issues] and/or [pull requests][pulls], see [CONTRIBUTING] for general guidelines. | ||
|
||
Building Cinder from source currently requires the nightly Rust compiler and [cargo-make]. | ||
To compile binaries optimized for your CPU architecture, simply run `cargo make cinder`. | ||
|
||
## License | ||
|
||
Chessboard is distributed under the terms of the GPL-3.0 license, see [LICENSE] for details. | ||
Cinder is distributed under the terms of the GPL-3.0 license, see [LICENSE] for details. | ||
|
||
[codecov.home]: https://codecov.io/gh/brunocodutra/chessboard | ||
[codecov.badge]: https://codecov.io/gh/brunocodutra/chessboard/branch/master/graph/badge.svg | ||
[issues]: https://github.com/brunocodutra/cinder/issues | ||
[pulls]: https://github.com/brunocodutra/cinder/pulls | ||
|
||
[issues]: https://github.com/brunocodutra/chessboard/issues | ||
[pulls]: https://github.com/brunocodutra/chessboard/pulls | ||
[cargo-make]: https://github.com/sagiegurari/cargo-make | ||
|
||
[LICENSE]: https://github.com/brunocodutra/chessboard/blob/master/LICENSE | ||
[CONTRIBUTING]: https://github.com/brunocodutra/chessboard/blob/master/CONTRIBUTING.md | ||
[LICENSE]: https://github.com/brunocodutra/cinder/blob/master/LICENSE | ||
[CONTRIBUTING]: https://github.com/brunocodutra/cinder/blob/master/CONTRIBUTING.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters