Skip to content

Commit

Permalink
Update docs for 2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
bernds committed Oct 14, 2020
1 parent f9dd1d5 commit d2e6920
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 31 deletions.
56 changes: 29 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## q5Go 1.1
## q5Go 2.0

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

![screenshot](screens/screenshot.png)

These are the major user-visible changes in 1.1:
* Performance improvements when loading and editing very large SGF files.
* q5go can now detect when an observed game on IGS is adjourned and restarted
and follow it in the same window. This requires the server to be set to
non-quiet mode.
* When playing an engine, there is now a "Play again" button.
* In an online match with Canadian time, time warnings can now be enabled
for remaining average time, not just remaining total time.
* In an online match, remaining seconds in low time situations can now be
shown on the opponent's last placed stone.
* Added a "Go terminology" SGF to the tutorials.
* The greeter window now has a hint to choose "Play online" for a full set
of menus.
* The program is more helpful when detecting a broken SGF written by Jago.
* Added more helpful error messages when editing servers in the preferences.
* Score evaluations are now shown in the board window when analysis is on.
* Added a feature to visualize connected stones by drawing thick lines
between them. May be helpful for beginners.
* GTP support was extended to support board sizes > 25, for KataGo.

Version 1.1.1 is mostly a bug-fix release to properly suppert saving and
loading large board sizes. But there are also a few additions:
* There is now a tool to manage and remove the information added by engine
analysis from a given SGF file.
* It is now possible to save all variations in a file into separate files.
* It is possible to choose a path for autosaving online games.
These are the major user-visible changes in 2.0:
* Pattern search is now available, similar to Kombilo. Use the settings
dialog to create a suitable database.
Unfortunately existing Kombilo databases can't be used for this because
of 32/64 bit compatibility issues.
* Database load times are reduced, and threading was added so that
the user interface remains responsive.
* Multiple online games can now be observed in a single window with
clickable previews to switch between them. The old mode of one game
per window is still available.
* There is a new "Tip of the day" dialog on startup, which displays
features that are maybe not easily discoverable. It can be disabled.
* There are several new high resolution wood textures for the board
to choose from.
* When playing engines that are capable of analysis, the evaluation is
now collected during the game and can be displayed live.
* Engine configuration now allows engines to be unrestricted in
board size and komi, catching up with improvements in KataGo over
Leela Zero.
* Some GTP bugs were fixed, which may improve compatibility with
certain engines.
* Window titles can now be overriden in the settings, which should help
with streaming setups.
* Performance improvements for the screen updates should now make it
feasible to turn off quiet mode when online, which allows the server
to send live player and game updates.
* There is a new option to highlight the user's own chat messages in
a different color.

See VERSION_HISTORY for a history of changes.

Expand Down
31 changes: 31 additions & 0 deletions VERSION_HISTORY
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
q5Go 2.0

These are the major user-visible changes in 2.0:
* Pattern search is now available, similar to Kombilo. Use the settings
dialog to create a suitable database.
Unfortunately existing Kombilo databases can't be used for this because
of 32/64 bit compatibility issues.
* Database load times are reduced, and threading was added so that
the user interface remains responsive.
* Multiple online games can now be observed in a single window with
clickable previews to switch between them. The old mode of one game
per window is still available.
* There is a new "Tip of the day" dialog on startup, which displays
features that are maybe not easily discoverable. It can be disabled.
* There are several new high resolution wood textures for the board
to choose from.
* When playing engines that are capable of analysis, the evaluation is
now collected during the game and can be displayed live.
* Engine configuration now allows engines to be unrestricted in
board size and komi, catching up with improvements in KataGo over
Leela Zero.
* Some GTP bugs were fixed, which may improve compatibility with
certain engines.
* Window titles can now be overriden in the settings, which should help
with streaming setups.
* Performance improvements for the screen updates should now make it
feasible to turn off quiet mode when online, which allows the server
to send live player and game updates.
* There is a new option to highlight the user's own chat messages in
a different color.

q5Go 1.1

These are the major user-visible changes in 1.1:
Expand Down
7 changes: 3 additions & 4 deletions src/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#define PACKAGE1 "q5goClient"

/* Version number of package */
#define VERSION_1 "1.1.1"
#define VERSION_1 "2.0"

#ifdef GITHUB_CI_BUILD
#define VERSION VERSION_1 " (GitHub action CI build on " __DATE__ ")"
Expand All @@ -16,9 +16,8 @@

#define NEWVERSIONWARNING "<p>Welcome to version " VERSION " of q5go.</p>\n" \
CIBUILD \
"<p>This is a minor bug fix release for version 1.1, which had issues saving and loading games with large board sizes.</p>" \
"<p>There is also a new dialog to remove engine analysis from a file, and a feature to save all variations from a file to separate files.</p>" \
"<p>It is now possible to choose an autosave path for online games.</p>" \
"<p>This version has a new pattern search feature, similar to Kombilo. Create databases in the settings dialog.</p>" \
"<p>There are also a number of improvements in online play, for example the option to observe multiple games in one window.</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 d2e6920

Please sign in to comment.