README
¶
Chess
A chess game that just works™.
How to use it
Run the code below
package main
import "github.com/jaxi/chess"
func main() {
b := chess.NewBoard()
b.Looping()
}
And then run the code above and it pretty much looks like this.
➜ examples git:(master) go run main.go
a b c d e f g h
+---+---+---+---+---+---+---+---+
8 | ♜ | ♞ | ♝ | ♛ | ♚ | ♝ | ♞ | ♜ | 8
+---+---+---+---+---+---+---+---+
7 | ♟ | ♟ | ♟ | ♟ | ♟ | ♟ | ♟ | ♟ | 7
+---+---+---+---+---+---+---+---+
6 | | | | | | | | | 6
+---+---+---+---+---+---+---+---+
5 | | | | | | | | | 5
+---+---+---+---+---+---+---+---+
4 | | | | | | | | | 4
+---+---+---+---+---+---+---+---+
3 | | | | | | | | | 3
+---+---+---+---+---+---+---+---+
2 | ♙ | ♙ | ♙ | ♙ | ♙ | ♙ | ♙ | ♙ | 2
+---+---+---+---+---+---+---+---+
1 | ♖ | ♘ | ♗ | ♕ | ♔ | ♗ | ♘ | ♖ | 1
+---+---+---+---+---+---+---+---+
a b c d e f g h
Move examples that use configurable interface in the examples folder. You can even play the game remotely!
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Board ¶
type Board struct {
// contains filtered or unexported fields
}
Board is where the chess is played on.
func (*Board) AdvanceLooping ¶
AdvanceLooping loop the gamve with more options returns the failed/disconnected player index
func (*Board) TerminalString ¶
TerminalString is a specific string returns for terminal
type EmptySquare ¶
type EmptySquare struct {
Piece
}
EmptySquare - aka no piece on the board
type Movable ¶
type Movable struct {
// contains filtered or unexported fields
}
Movable is used to attach to the piece that need recording if it's been moved or not
type Move ¶
type Move struct {
// contains filtered or unexported fields
}
Move - The Movement in one turn
type Piece ¶
type Piece struct {
// contains filtered or unexported fields
}
The Piece stand at wherever on the board
type Player ¶
type Player interface {
ShowTurn(b *Board)
RenderBoard(b *Board)
FetchMove() (Move, error)
ErrorMessage(b *Board)
}
Player is the standard protocol can connect to the game
type Position ¶
type Position struct {
// contains filtered or unexported fields
}
Position is the place where a piece stand
Source Files
Directories