Add max_time option to online books (#1114)

Author: AttackingOrDefending

config.yml.default

@@ -46,25 +46,29 @@ engine:                            # Engine settings.
     chessdb_book:
       enabled: false               # Whether or not to use chessdb book.
       min_time: 20                 # Minimum time (in seconds) to use chessdb book.
+      max_time: 10800              # Maximum starting game time (in seconds) to use chessdb book.
       move_quality: "good"         # One of "all", "good", "best".
       min_depth: 20                # Only for move_quality: "best".
     lichess_cloud_analysis:
       enabled: false               # Whether or not to use lichess cloud analysis.
       min_time: 20                 # Minimum time (in seconds) the bot must have to use cloud analysis.
+      max_time: 10800              # Maximum starting game time (in seconds) the bot must have to use cloud analysis.
       move_quality: "best"         # One of "good", "best".
       max_score_difference: 50     # Only for move_quality: "good". The maximum score difference (in cp) between the best move and the other moves.
       min_depth: 20
       min_knodes: 0
     lichess_opening_explorer:
       enabled: false
       min_time: 20
+      max_time: 10800              # Maximum starting game time (in seconds) the bot must have to use the lichess opening explorer.
       source: "masters"            # One of "lichess", "masters", "player"
       player_name: ""              # The lichess username. Leave empty for the bot's username to be used. Used only when source is "player".
       sort: "winrate"              # One of "winrate", "games_played"
       min_games: 10                # Minimum number of times a move must have been played to be chosen.
     online_egtb:
       enabled: false               # Whether or not to enable online endgame tablebases.
       min_time: 20                 # Minimum time (in seconds) the bot must have to use online EGTBs.
+      max_time: 10800              # Maximum starting game time (in seconds) the bot must have to use online EGTBs.
       max_pieces: 7                # Maximum number of pieces on the board to use endgame tablebases.
       source: "lichess"            # One of "lichess", "chessdb".
       move_quality: "best"         # One of "best" or "suggest" (it takes all the moves with the same WDL and tells the engine to only consider these; will move instantly if there is only 1 "good" move).

lib/config.py

@@ -169,20 +169,24 @@ def insert_default_values(CONFIG: CONFIG_DICT_TYPE) -> None:
     set_config_default(CONFIG, "engine", "online_moves", "online_egtb", key="enabled", default=False)
     set_config_default(CONFIG, "engine", "online_moves", "online_egtb", key="source", default="lichess")
     set_config_default(CONFIG, "engine", "online_moves", "online_egtb", key="min_time", default=20)
+    set_config_default(CONFIG, "engine", "online_moves", "online_egtb", key="max_time", default=10800)
     set_config_default(CONFIG, "engine", "online_moves", "online_egtb", key="max_pieces", default=7)
     set_config_default(CONFIG, "engine", "online_moves", "online_egtb", key="move_quality", default="best")
     set_config_default(CONFIG, "engine", "online_moves", "chessdb_book", key="enabled", default=False)
     set_config_default(CONFIG, "engine", "online_moves", "chessdb_book", key="min_time", default=20)
+    set_config_default(CONFIG, "engine", "online_moves", "chessdb_book", key="max_time", default=10800)
     set_config_default(CONFIG, "engine", "online_moves", "chessdb_book", key="move_quality", default="good")
     set_config_default(CONFIG, "engine", "online_moves", "chessdb_book", key="min_depth", default=20)
     set_config_default(CONFIG, "engine", "online_moves", "lichess_cloud_analysis", key="enabled", default=False)
     set_config_default(CONFIG, "engine", "online_moves", "lichess_cloud_analysis", key="min_time", default=20)
+    set_config_default(CONFIG, "engine", "online_moves", "lichess_cloud_analysis", key="max_time", default=10800)
     set_config_default(CONFIG, "engine", "online_moves", "lichess_cloud_analysis", key="move_quality", default="best")
     set_config_default(CONFIG, "engine", "online_moves", "lichess_cloud_analysis", key="min_depth", default=20)
     set_config_default(CONFIG, "engine", "online_moves", "lichess_cloud_analysis", key="min_knodes", default=0)
     set_config_default(CONFIG, "engine", "online_moves", "lichess_cloud_analysis", key="max_score_difference", default=50)
     set_config_default(CONFIG, "engine", "online_moves", "lichess_opening_explorer", key="enabled", default=False)
     set_config_default(CONFIG, "engine", "online_moves", "lichess_opening_explorer", key="min_time", default=20)
+    set_config_default(CONFIG, "engine", "online_moves", "lichess_opening_explorer", key="max_time", default=10800)
     set_config_default(CONFIG, "engine", "online_moves", "lichess_opening_explorer", key="source", default="masters")
     set_config_default(CONFIG, "engine", "online_moves", "lichess_opening_explorer", key="player_name", default="")
     set_config_default(CONFIG, "engine", "online_moves", "lichess_opening_explorer", key="sort", default="winrate")

lib/engine_wrapper.py

@@ -835,7 +835,8 @@ def get_chessdb_move(li: lichess.Lichess, board: chess.Board, game: model.Game,
     use_chessdb = chessdb_cfg.enabled
     time_left = msec(game.state[wbtime(board)])
     min_time = seconds(chessdb_cfg.min_time)
-    if not use_chessdb or time_left < min_time or board.uci_variant != "chess":
+    max_time = seconds(chessdb_cfg.max_time)
+    if not use_chessdb or time_left < min_time or game.clock_initial > max_time or board.uci_variant != "chess":
         return None, {}
 
     move = None
@@ -872,8 +873,9 @@ def get_lichess_cloud_move(li: lichess.Lichess, board: chess.Board, game: model.
     side = wbtime(board)
     time_left = msec(game.state[side])
     min_time = seconds(lichess_cloud_cfg.min_time)
+    max_time = seconds(lichess_cloud_cfg.max_time)
     use_lichess_cloud = lichess_cloud_cfg.enabled
-    if not use_lichess_cloud or time_left < min_time:
+    if not use_lichess_cloud or time_left < min_time or game.clock_initial > max_time:
         return None, {}
 
     move = None
@@ -925,8 +927,10 @@ def get_opening_explorer_move(li: lichess.Lichess, board: chess.Board, game: mod
     side = wbtime(board)
     time_left = msec(game.state[side])
     min_time = seconds(opening_explorer_cfg.min_time)
+    max_time = seconds(opening_explorer_cfg.max_time)
     source = opening_explorer_cfg.source
-    if not opening_explorer_cfg.enabled or time_left < min_time or source == "master" and board.uci_variant != "chess":
+    if (not opening_explorer_cfg.enabled or time_left < min_time or game.clock_initial > max_time or source == "master"
+            and board.uci_variant != "chess"):
         return None, {}
 
     move = None
@@ -980,9 +984,11 @@ def get_online_egtb_move(li: lichess.Lichess, board: chess.Board, game: model.Ga
     pieces = chess.popcount(board.occupied)
     source = online_egtb_cfg.source
     minimum_time = seconds(online_egtb_cfg.min_time)
+    maximum_time = seconds(online_egtb_cfg.max_time)
     time_left = game.state[wbtime(board)]
     if (not use_online_egtb
             or msec(time_left) < minimum_time
+            or game.clock_initial > maximum_time
             or board.uci_variant not in ["chess", "antichess", "atomic"]
             and source == "lichess"
             or board.uci_variant != "chess"

wiki/Configure-lichess-bot.md

@@ -103,6 +103,7 @@ will precede the `go` command to start thinking with `sd 5`. The other `go_comma
     - Configurations common to all:
         - `enabled`: Whether to use the database at all.
         - `min_time`: The minimum time in seconds on the game clock necessary to allow the online database to be consulted.
+        - `max_time`: The maximum starting game time in seconds on the game clock necessary to allow the online database to be consulted.
         - `move_quality`: Choice of `"all"` (`chessdb_book` only), `"good"` (all except `online_egtb`), `"best"`, or `"suggest"` (`online_egtb` only).
             - `all`: Choose a random move from all legal moves.
             - `best`: Choose only the highest scoring move.