Skip to content

Commit

Permalink
Doc update for version 0.9
Browse files Browse the repository at this point in the history
  • Loading branch information
bernds committed Jul 18, 2019
1 parent 527d483 commit 3e6c789
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 42 deletions.
67 changes: 28 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## q5Go 0.8.1
## q5Go 0.9

This is a tool for Go players which performs the following functions:
- SGF editor
Expand All @@ -19,50 +19,36 @@ and modernized.

![screenshot](screens/screenshot.png)

Version 0.8.1 is just a compatibility fix for the Leela Zero "next" branch
that will become 0.17. These are the major user-visible changes in 0.8:
* Analyzing games with multiple engines now produces sensible results.
q5go remembers winrates for each engine name and komi combination and
displays multiple winrate graphs.
* For engines with fixed komi, batch analysis can now flip the position
to effectively analyze with reverse komi.
* For live analysis, it is now possible to choose the analysis engine.
* There is a new slide export feature which combines the board and
comments into a single image for use in slide shows or videos.
File name sequences can be generated automatically.
* It is now possible to choose between area and territory scoring in
off-line games.

Minor fixes and improvements include:
* The board coordinates now scales with the size of the display, their
size relative to the stones is configurable in the preferences.
* It is now possible to choose whether to tile or scale the wood
background image used for the board.
* The evaluation graph is automatically displayed when a game obtains
an evaluation for the first time.
* In online match games, remaining time is now saved to the SGF for both
player and opponent.
* It is now possible to hold down LMB and drag in the evaluation graph
to move to a different position.
* In the database dialog, "Open" and "Cancel" now work (previously
only double clicks opened the game).
* In off-line mode, scoring a scored position again now keeps liveness
and seki status.
* A bug was fixed that caused the "Update" button to disappear when
scoring or editing an off-line copy of an observed game.
* Loading an SGF file for a game against an engine is now implemented.
These are the major user-visible changes in 0.9:
* Support for KataGo analysis. The evaluation graph can be switched between
score and win rate.
* A new option to start a game against an engine game from the current
board position.
* A new AI vs AI play mode. The number of games to be played is
configurable, and an opening book can be used.
* It is now possible to hide/show the analysis markup of the board rather
than having it displayed at all times.
* The variant game dialog now supports removing intersections from the board,
allowing new variations of the game.
* Several bug fixes related to scoring mode when playing games on IGS.
* There are now a few presets for the stone visual appearance to make it
quicker and easier to arrive at a nice look. The darkness of the shadows
can now also be configured.
* Sounds should be a little more reliable, the samples used for stones were
too short to be played on some systems.

See VERSION_HISTORY for a history of changes.

## Overview of features

### Analysis mode

q5Go supports not only play against AI engines, but can also connect to
Leela Zero to use it as an an analysis tool, displaying statistics such
as win-rates and visit counts, and displaying variations. This is
available both for local SGF editing, and for observing on-line games.
By middle-clicking or shift-clicking on a displayed variation, it can
be added to the game record.
KataGo or Leela Zero to use it as an an analysis tool, displaying statistics
such as win-rates, scores (when using KataGo), and visit counts, and
displaying variations. This is available both for local SGF editing, and
for observing on-line games. By middle-clicking or shift-clicking on a
displayed variation, it can be added to the game record.

![screenshot](screens/analysis.png)

Expand Down Expand Up @@ -147,7 +133,10 @@ to extend the board past its regular dimensions, duplicating parts of
the position for a better overview. Also, the board can be dragged
with the middle mouse button.

![screenshot](screens/variants.jpg)
In addition to that, it is possible to set up a board with some of the
intersections removed.

![screenshot](screens/variants.png)

The screenshot shows the variant game dialog and a (different) position
with both axes set to be toroidal.
Expand Down
22 changes: 21 additions & 1 deletion VERSION_HISTORY
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
q5Go 0.9

These are the major user-visible changes in 0.9:
* Support for KataGo analysis. The evaluation graph can be switched between
score and win rate.
* A new option to start a game against an engine game from the current
board position.
* A new AI vs AI play mode. The number of games to be played is
configurable, and an opening book can be used.
* It is now possible to hide/show the analysis markup of the board rather
than having it displayed at all times.
* The variant game dialog now supports removing intersections from the board,
allowing new variations of the game.
* Several bug fixes related to scoring mode when playing games on IGS.
* There are now a few presets for the stone visual appearance to make it
quicker and easier to arrive at a nice look. The darkness of the shadows
can now also be configured.
* Sounds should be a little more reliable, the samples used for stones were
too short to be played on some systems.

q5Go 0.8.1
* Adjusted analysis mode to work with the upcoming Leela Zero 0.17.

Expand All @@ -17,7 +37,7 @@ These are the major user-visible changes in 0.8:
off-line games.

Minor fixes and improvements include:
* The board coordinates now scales with the size of the display, their
* The board coordinates now scale with the size of the display, their
size relative to the stones is configurable in the preferences.
* It is now possible to choose whether to tile or scale the wood
background image used for the board.
Expand Down
Binary file removed screens/variants.jpg
Binary file not shown.
Binary file added screens/variants.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions src/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@
#define PACKAGE1 "q5goClient"

/* Version number of package */
#define VERSION "0.8.1"
#define VERSION "0.9"

#define NEWVERSIONWARNING "<p>Welcome to version " VERSION " of q5go.</p>\n" \
"<p>This version adds two major features: multi-engine analysis and slide export, as well as many small enhancements.</p>" \
"<p>This adds support for analysis using KataGo, a new AI that can estimate scores during the game.</p>" \
"<p>Other changes include support for AI vs AI play, time controls when playing an AI, more Go variants, and a few bug fixes.</p>" \
"<p>For a full list of changes, please refer to the README.</p>" \
"<p>This message will not be shown anymore on startup.</p>"

Expand Down

0 comments on commit 3e6c789

Please sign in to comment.