Some tweaks to README for clarity

This commit is contained in:
Sebastian Lague 2023-07-23 16:43:34 +02:00 committed by GitHub
parent ee8db0ef9f
commit 0f021277c4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -6,10 +6,10 @@ I will then create a video exploring the implementations of the best and most un
I also plan to make a small game that features these most interesting/challenging entries, so that everyone can try playing against them.
## Change Log
I unfortunately missed a serious bug in the board.GetPiece() and PieceList functions and have had to update the project. Please keep an eye on the change log here in case I've made any other horrifying mistakes. Apologies for the inconvenience. The version you are currently using will be printed to the console when running the program (unless you are using v1.0, in which case nothing will be printed).
* V1.1 Bug fix for board.GetPiece() and PieceList functions. Added Board.CreateBoardFromFEN() function.
I unfortunately missed a serious bug in the API and have had to update the project. Please keep an eye on the change log here in case I've made any other horrifying mistakes. Apologies for the inconvenience. The version you are currently using will be printed to the console when running the program (unless you are using v1.0, in which case nothing will be printed).
* V1.1 Bug fix for `board.GetPiece()` and `PieceList` functions. Added `Board.CreateBoardFromFEN()` function.
* V1.11 UI changes: Added coordinate names to board UI and fixed human player input bug.
* V1.12 Small fixes to board.IsDraw(): Fifty move counter is now updated properly during search, and insufficient material is now detected for lone bishops on the same square colour.
* V1.12 Small fixes to `board.IsDraw()`: Fifty move counter is now updated properly during search, and insufficient material is now detected for lone bishops on the same square colour.
## Submission Due Date
October 1st 2023.<br>
@ -39,16 +39,15 @@ You can submit your entry [here](https://forms.gle/6jjj8jxNQ5Ln53ie6).
* Please only submit a second entry if it is significantly different from your first bot (not just a minor tweak).
* Note: you will need to log in with a second Google account if you want submit a second entry.
* Only the following namespaces are allowed:
* ChessChallenge.API
* System
* System.Numerics
* System.Collections.Generic
* System.Linq
* You may not use the AsParallel() function
* `ChessChallenge.API`
* `System`
* `System.Numerics`
* `System.Collections.Generic`
* `System.Linq`
* You may not use the `AsParallel()` function
* As implied by the allowed namespaces, you may not read data from a file or access the internet, nor may you create any new threads or tasks to run code in parallel/in the background.
* You may not use the unsafe keyword.
* You may not store data inside the name of a variable/function/class etc (to be extracted with nameof(), GetType().ToString(), Environment.StackTracks and so on).
* Very clever ideas though, thank you to [#12](https://github.com/SebLague/Chess-Challenge/issues/12) and [#24](https://github.com/SebLague/Chess-Challenge/issues/24).
* You may not store data inside the name of a variable/function/class etc (to be extracted with `nameof()`, `GetType().ToString()`, `Environment.StackTrace` and so on). Thank you to [#12](https://github.com/SebLague/Chess-Challenge/issues/12) and [#24](https://github.com/SebLague/Chess-Challenge/issues/24).
* If your bot makes an illegal move or runs out of time, it will lose the game.
* Games are played with 1 minute per side by default (this can be changed in the settings class). The final tournament time control is TBD, so your bot should not assume a particular time control, and instead respect the amount of time left on the timer (given in the Think function).
* Your bot may not use more than 256mb of memory for creating look-up tables (such as a transposition table).
@ -69,7 +68,7 @@ All names (variables, functions, etc.) are counted as a single token, regardless
* Issues with illegal moves or errors when making/undoing a move
* Make sure that you are making and undoing moves in the correct order, and that you don't forget to undo a move when exitting early from a function for example.
* How to tell what colour MyBot is playing
* You can look at board.IsWhiteToMove when the Think function is called
* GetPiece() function is giving a null piece after making a move
* You can look at `board.IsWhiteToMove` when the Think function is called
* `GetPiece()` function is giving a null piece after making a move
* Please make sure you are using the latest version of the project, there was a bug with this function in the original version