Skip to content

Commit

Permalink
Merge pull request #67 from roy7/readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
roy7 committed Apr 6, 2018
2 parents 5f03312 + 7f57ea3 commit f6aadc9
Showing 1 changed file with 88 additions and 3 deletions.
91 changes: 88 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ Installation
1. Use your systems package manager or otherwise install `node.js` from http://nodejs.org/
2. Run
```
npm install -g gtp2ogs
npm install gtp2ogs
```
3. Install any missing node.js packages if basic usage below fails, such as:
3. Optionally install any missing node.js packages if basic usage below fails, such as:
```
npm install socket.io-client optimist tracer
npm install socket.io-client
npm install optimist
npm install tracer
```


Expand All @@ -24,3 +26,86 @@ Basic usage
```
gtp2ogs --botid <id> --apikey <apikey> <arguments> -- <bot command> <bot arguments>
```
The space in front of ```<bot command>``` is important

Options
=======
The following options are placed in the above ```<arguments>``` section. Put a space in between options when there are more than one. Also put a space in between the option and the parameter like:
```--startupbuffer 2 --boardsize 13,19 --ban UserX,playerY ```

```--ban``` Comma separated list of user names or IDs (e.g. UserA,UserB,UserC do not put spaces in between)

```--banranked``` Comma separated list of user names or IDs who are banned from playing ranked games

```--banunranked``` Comma separated list of user names or IDs who are banned from playing unranked game

```--beta``` Connect to the beta server (sets ggs/rest hosts to the beta server)

```--boardsize``` Board size(s) to accept (default 9,13,19)

```--debug``` Output GTP command and responses from your Go engine to the log

```--hidden``` Hides the botname from the OGS game creation bot list

```--insecure``` Don't use ssl to connect to the ggs/rest servers

```--json``` Send and receive GTP commands in a JSON encoded format

```--kgstime``` Set this if bot understands the kgs-time_settings command

```--noclock``` Do not send any clock/time data to the bot

```--minmaintime``` Minimum seconds of main time (rejects time control simple and none)

```--maxmaintime``` Maximum seconds of main time (rejects time control simple and none)

```--minperiodtime``` Minimum seconds per period (per stone in canadian)

```--maxperiodtime``` Maximum seconds per period (per stone in canadian)

```--minperiods``` Minimum number of periods

```--minperiodsranked``` Minimum number of ranked periods

```--minperiodsunranked``` Minimum number of unranked periods

```--maxperiods``` Maximum number of periods

```--maxperiodsranked``` Maximum number of ranked periods

```--maxperiodsunranked``` Maximum number of unranked periods

```--minrank``` Minimum opponent rank to accept (e.g. 15k)

```--maxrank``` Maximum opponent rank to accept (e.g. 1d)

```--proonly``` Only accept matches from professionals

```--rankedonly``` Only accept ranked matches

```--unrankedonly``` Only accept unranked matches

```--maxhandicap``` Max handicap for all games

```--maxrankedhandicap``` Max handicap for ranked games

```--maxunrankedhandicap``` Max handicap for unranked games

```--nopause``` Do not allow games to be paused

```--nopauseranked``` Do not allow ranked games to be paused

```--nopauseunranked``` Do not allow unranked games to be paused

```--persist``` Bot process remains running between moves

```--rejectnew``` Reject all new challenges

```--rejectnewfile ~/rejectnew.status``` Reject new challenges if this file exists

```--startupbuffer``` Subtract this many seconds from time available on first move (default 5)

```--speed``` Comma separated list of Game speed(s) to accept (default blitz,live,correspondence)

```--timecontrol``` Time control(s) to accept
(default fischer,byoyomi,simple,canadian,absolute,none)

0 comments on commit f6aadc9

Please sign in to comment.