Categorygithub.com/freechessclub/icsgo
modulepackage
0.0.0-20220125052923-fceb78b03869
Repository: https://github.com/freechessclub/icsgo.git
Documentation: pkg.go.dev

# README

icsgo

Build Status GoDoc GoReportCard

icsgo is a Go client library to connect to Internet Chess Server (ICS). An ICS provides support for playing, watching and discussing chess games. Two popular, and among the earliest, examples of ICS include:

Although the ICS protocol is a simple variant of the TELNET protocol, it has not been standardised. As such, this has led to different ICS servers implementing non-standard extensions to the protocol.

Installation

To install this package, you need to have a working installation of Go. Assuming you have Go properly installed, simply do:

go get -u github.com/freechessclub/icsgo

Usage

If you're using Go modules (Go 1.11+), this library can be used by simply importing "github.com/freechessclub/icsgo" in your application. Using the usual Go commands go [build|run|test] will automatically download the required dependencies.

Documentation

  • See godoc for package documentation.
  • Examples on how to use the library can be found in the examples directory.

# Packages

No description provided by the author

# Functions

Dial creates a new connection.
NewClient creates a new ICS client.

# Constants

type of game end messages.
type of game end messages.
type of game end messages.
type of game end messages.
type of game end messages.
type of game end messages.
type of game end messages.
type of game end messages.

# Variables

DefaultConfig represents the default configuration of icsgo client.
No description provided by the author

# Structs

channel tell.
Client represents a new ICS client.
Config represents the configuration parameters supported by the icsgo client.
Conn represents a connection to the ICS server.
a game end message.
a game move message.
a game start message.
a generic message from the server.
private tell.