Update config.yml

config.yml

@@ -1,146 +1,256 @@
-token: "lip_Qsl2M6Ys7xtmPMVyyvAq"                          # Your Lichess OAuth2 Token.
+token: "lip_tGdAiSZGLjYE2c5d2Dpj"    # Lichess OAuth2 Token.
 url: "https://lichess.org/"        # Lichess base URL.
 
 engine:                            # Engine settings.
-  dir: "./fairy"                 # Directory containing the engine.
-  name: "stockfish"      # Binary name of the engine.
-  debug: false
-  working_dir: ""
-  protocol: "uci"
-  ponder: false                    # Engine does not support pondering.
+  dir: "./fairy"                        # Tells the bot to look in the main folder instead of /engines/
+  name: "stockfish"                # Binary name of the engine to use.
+  debug: true
+
+# interpreter: "java"
+# interpreter_options:
+#    - "-jar"
+  working_dir: ""                  # Directory where the chess engine will read and write files. If blank or missing, the current directory is used.
+                                   # NOTE: If working_dir is set, the engine will look for files and directories relative to this directory, not where lichess-bot was launched. Absolute paths are unaffected.
+  protocol: "uci"                  # "uci", "xboard" or "homemade"
+  ponder: false                    # Think on opponent's time.
 
   polyglot:
-    enabled: false
+    enabled: false                   # Activate polyglot book.
     book:
-      standard:
+      standard:                      # List of book file paths for variant standard.
         - engines/book1.bin
-    min_weight: 1
-    selection: "weighted_random"
-    max_depth: 20
-    normalization: "none"
+        - engines/book2.bin
+#       atomic:                      # List of book file paths for variant atomic.
+#         - engines/atomicbook1.bin
+#         - engines/atomicbook2.bin
+#       etc.
+#       Use the same pattern for 'chess960', 'giveaway' (antichess), 'crazyhouse', 'horde', 'kingofthehill', 'racingkings' and '3check' as well.
+    min_weight: 1                    # Does not select moves with weight below min_weight (min 0, max: 100 if normalization isn't "none" else 65535).
+    selection: "weighted_random"    # Move selection is one of "weighted_random", "uniform_random" or "best_move" (but not below the min_weight in the 2nd and 3rd case).
+    max_depth: 20                    # How many moves from the start to take from the book.
+    normalization: "none"            # Normalization method for the book weights. One of "none", "sum", or "max".
 
   draw_or_resign:
-    resign_enabled: false
-    resign_score: -1000
-    resign_for_egtb_minus_two: true
-    resign_moves: 3
-    offer_draw_enabled: true
-    offer_draw_score: 0
-    offer_draw_for_egtb_zero: true
-    offer_draw_moves: 10
-    offer_draw_pieces: 10
+    resign_enabled: false            # Whether or not the bot should resign.
+    resign_score: -1000              # If the score is less than or equal to this value, the bot resigns (in cp).
+    resign_for_egtb_minus_two: true # If true the bot will resign in positions where the online_egtb returns a wdl of -2.
+    resign_moves: 3                  # How many moves in a row the score has to be below the resign value.
+    offer_draw_enabled: true         # Whether or not the bot should offer/accept draw.
+    offer_draw_score: 0              # If the absolute value of the score is less than or equal to this value, the bot offers/accepts draw (in cp).
+    offer_draw_for_egtb_zero: true # If true the bot will offer/accept draw in positions where the online_egtb returns a wdl of 0.
+    offer_draw_moves: 10             # How many moves in a row the absolute value of the score has to be below the draw value.
+    offer_draw_pieces: 10            # Only if the pieces on board are less than or equal to this value, the bot offers/accepts draw.
 
   online_moves:
-    max_out_of_book_moves: 10
-    max_retries: 2
+    max_out_of_book_moves: 10        # Stop using online opening books after they don't have a move for 'max_out_of_book_moves' positions. Doesn't apply to the online endgame tablebases.
+    max_retries: 2                   # The maximum amount of retries when getting an online move.
+    # max_depth: 10                  # How many moves from the start to take from online books. Default is no limit.
     chessdb_book:
-      enabled: false
-      min_time: 20
-      max_time: 10800
-      move_quality: "good"
-      min_depth: 20
+      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
-      min_time: 20
-      max_time: 10800
-      move_quality: "best"
-      max_score_difference: 50
+      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
-      source: "masters"
-      player_name: ""
-      sort: "winrate"
-      min_games: 10
+      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
-      min_time: 20
-      max_time: 10800
-      max_pieces: 8
-      source: "lichess"
-      move_quality: "best"
+      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: 8                  # 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).
 
-  lichess_bot_tbs:
+  lichess_bot_tbs:                    # The tablebases list here will be read by lichess-bot, not the engine.
     syzygy:
-      enabled: false
-      paths:
+      enabled: false                 # Whether or not to use local syzygy endgame tablebases.
+      paths:                         # Paths to Syzygy endgame tablebases.
         - "engines/syzygy"
-      max_pieces: 7
-      move_quality: "best"
+      max_pieces: 7                  # Maximum number of pieces in the endgame tablebase.
+      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).
     gaviota:
-      enabled: false
+      enabled: false                 # Whether or not to use local gaviota endgame tablebases.
       paths:
         - "engines/gaviota"
       max_pieces: 5
-      min_dtm_to_consider_as_wdl_1: 120
-      move_quality: "best"
+      min_dtm_to_consider_as_wdl_1: 120 # The minimum DTM to consider as syzygy WDL=1/-1. Set to 100 to disable.
+      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).
+
+# engine_options:                    # Any custom command line params to pass to the engine.
+#   cpuct: 3.1
 
-  uci_options:                     # UCI options passed to the engine.
-    Skill Level: 5                 # 1=1000 Elo, 5=1500 Elo (default), 10=2000 Elo
+  homemade_options:
+#   Hash: 256
 
-  silence_stderr: false
+    uci_options:                     # Arbitrary UCI options passed to the engine.
+    Move Overhead: 100               # Increase if your bot flags games too often.
+    Threads: 2                       # Max CPU threads the engine can use.
+    Hash: 256                        # Max memory (in megabytes) the engine can allocate.
+    SyzygyPath: "./syzygy/"        # Paths to Syzygy endgame tablebases that the engine reads.
+    UCI_ShowWDL: true                # Show the chance of the engine winning.
+    go_commands:                     # Additional options to pass to the UCI go command.
+#      nodes: 1000                       # Search so many nodes only.
+#      depth: 10                      # Search depth ply only.
+      movetime: 1000                 # Integer. Search exactly movetime milliseconds.
+#        d
+# xboard_options:                   # Arbitrary XBoard options passed to the engine.
+#   cores: "4"
+#   memory: "4096"
+#   egtpath:                         # Directory containing egtb (endgame tablabases), relative to this project. For 'xboard' engines.
+#      gaviota: "Gaviota path"
+#      nalimov: "Nalimov Path"
+#      scorpio: "Scorpio Path"
+#      syzygy: "Syzygy Path"
+#   go_commands:                     # Additional options to pass to the XBoard go command.
+#      depth: 5                       # Search depth ply only.
+#   Do note that the go commands 'movetime' and 'nodes' are invalid and may cause bad time management for XBoard engines.
 
-abort_time: 30
-fake_think_time: false
-rate_limiting_delay: 0
-move_overhead: 2000
-max_takebacks_accepted: 0
-quit_after_all_games_finish: false
+  silence_stderr: false              # Some engines (yes you, Leela) are very noisy.
+
+abort_time: 30                       # Time to abort a game in seconds when there is no activity.
+fake_think_time: false               # Artificially slow down the bot to pretend like it's thinking.
+rate_limiting_delay: 0               # Time (in ms) to delay after sending a move to prevent "Too Many Requests" errors.
+move_overhead: 2000                  # Increase if your bot flags games too often.
+max_takebacks_accepted: 0            # The number of times to allow an opponent to take back a move in a game.
+quit_after_all_games_finish: false # If set to true, then pressing Ctrl-C to quit will only stop lichess-bot after all current games have finished.
 
 correspondence:
-  move_time: 60
-  checkin_period: 300
-  disconnect_time: 150
-  ponder: false
-
-challenge:
-  concurrency: 10000
-  sort_by: "best"
-  preference: "none"
-  accept_bot: true
-  accept_human: true
-  only_bot: false
-  max_increment: 20
-  min_increment: 0
-  max_base: 1800
-  min_base: 0
-  max_days: 14
-  min_days: 1
-  variants:
+  move_time: 60                       # Time in seconds to search in correspondence games.
+  checkin_period: 300                # How often to check for opponent moves in correspondence games after disconnecting.
+  disconnect_time: 150               # Time before disconnecting from a correspondence game.
+  ponder: false                       # Ponder in correspondence games the bot is connected to.
+
+challenge:                           # Incoming challenges.
+  concurrency: 1                     # Number of games to play simultaneously.
+  sort_by: "best"                    # Possible values: "best" and "first".
+  preference: "none"               # Possible values: "none", "human", "bot".
+  accept_bot: true                   # Accepts challenges coming from other bots.
+  accept_human: true                 # Kept true so other people can challenge you.
+  only_bot: false                    # Kept false so humans can challenge you.
+  max_increment: 20                  # Maximum amount of increment to accept a challenge in seconds. The max is 180. Set to 0 for no increment.
+  min_increment: 0                   # Minimum amount of increment to accept a challenge in seconds.
+  max_base: 1800                     # Maximum amount of base time to accept a challenge in seconds. The max is 10800 (3 hours).
+  min_base: 0                        # Minimum amount of base time to accept a challenge in seconds.
+  max_days: 14                       # Maximum number of days per move to accept a challenge for a correspondence game.
+                                     # Unlimited games can be accepted by removing this field or specifying .inf
+  min_days: 1                        # Minimum number of days per move to accept a challenge for a correspondence game.
+  variants:                          # Chess variants to accept (https://lichess.org/variant).
     - standard
-  time_controls:
+#   - fromPosition
+#   - antichess
+#   - atomic
+    - chess960
+#   - crazyhouse
+#   - horde
+#   - kingOfTheHill
+#   - racingKings
+#   - threeCheck
+  time_controls:                     # Time controls to accept (bots are not allowed to play ultraBullet).
     - bullet
     - blitz
     - rapid
     - classical
-  modes:
-    - casual
-    - rated
-  bullet_requires_increment: false
-  max_simultaneous_games_per_user: 5
+    - correspondence
+  modes:                             # Game modes to accept.
+    - casual                         # Unrated games.
+    - rated                          # Rated games - must comment if the engine doesn't try to win.
+# block_list:                      # List of users from which the challenges are always declined.
+#   - user1
+#   - user2
+# online_block_list:               # The urls from which to retrieve a list of bot names that will not be challenged. The list should be a text file where each line contains the name of a blocked bot
+#   - example.com/blocklist
+# allow_list:                      # List of users from which challenges are exclusively accepted, all others being declined. If empty, challenges from all users may be accepted.
+#   - user3
+#   - user4
+# recent_bot_challenge_age: 60     # Maximum age of a bot challenge to be considered recent in seconds
+# max_recent_bot_challenges: 2     # Maximum number of recent challenges that can be accepted from the same bot
+# min_rating: 0                    # Minimum rating of the challenger to accept a challenge.
+# max_rating: 4000                 # Maximum rating of the challenger to accept a challenge. The maximum rating in lichess is 4000.
+# rating_difference: 300           # Maximum rating difference between the bot and the challenger. Overrides min_rating and max_rating if set.
+  bullet_requires_increment: false # Require that bullet game challenges from bots have a non-zero increment
+  max_simultaneous_games_per_user: 5  # Maximum number of simultaneous games with the same user
 
 greeting:
-  hello: "Hi! I'm {me}, I am a Chess Engine created using C++. Typer !help for commands ."
-  goodbye: "Good game!"
-  hello_spectators: "Hi! I'm {me}, I am a Chess Engine created using C++. If you want to play me, challenge me! Type !help for commands."
-  goodbye_spectators: "Thanks for watching!"
+  # Optional substitution keywords (include curly braces):
+  #    {opponent} to insert opponent's name
+  #    {me} to insert bot's name
+  # Any other words in curly braces will be removed.
+  hello: "Hi! I'm {me}. I am a good bot. I also like winning! type !help for more info" # Message to send to opponent chat at the start of a game
+  goodbye: "Good game! See you next time!" # Message to send to opponent chat at the end of a game
+  hello_spectators: "Hi! I'm {me}. Hi spectators! Type !help for a list of commands I can respond to." # Message to send to spectator chat at the start of a game
+  goodbye_spectators: "Thanks for watching!" # Message to send to spectator chat at the end of a game
+
+# pgn_directory: "game_records"    # A directory where PGN-format records of the bot's games are kept
+# pgn_file_grouping: "game"        # How to group games into files. Options are "game", "opponent", and "all"
+                                     # "game" (default) - every game is written to a different file named "{White name} vs. {Black name} - {lichess game ID}.pgn"
+                                     # "opponent" - every game with a given opponent is written to a file named "{Bot name} games vs. {Opponent name}.pgn"
+                                     # "all" - every game is written to a single file named "{Bot name} games.pgn"
 
 matchmaking:
-  allow_matchmaking: false
-  allow_during_games: false
-  challenge_variant: "random"
-  challenge_timeout: 30
-  challenge_initial_time:
-    - 60
+  allow_matchmaking: true          # Set to true to allow your bot to send challenges
+  allow_during_games: false         # Keeps the bot focused on its current game
+  challenge_variant: "standard"     # Match Maia's supported variant
+  challenge_timeout: 1              # How many minutes to wait before challenging maia1 when idle
+  challenge_initial_time:         # Pick a time control maia1 accepts (e.g., 3-minute blitz)
     - 180
+    - 300
+    - 600
   challenge_increment:
-    - 1
+    - 0
     - 2
-  opponent_rating_difference: 300
-  rating_preference: "none"
-  challenge_mode: "random"
-  challenge_filter: none
-  include_challenge_block_list: false
+  challenge_filter: coarse
+  block_list: []
+#   challenge_days:                # Days for correspondence challenge (to be chosen at random).
+#     - 1
+#     - 2
+# opponent_min_rating: 600         # Opponents rating should be above this value (600 is the minimum rating in lichess).
+# opponent_max_rating: 4000        # Opponents rating should be below this value (4000 is the maximum rating in lichess).
+  opponent_rating_difference: 300  # The maximum difference in rating between the bot's rating and opponent's rating.
+  rating_preference: "none"        # One of "none", "high", "low".
+  challenge_mode: "rated"          # Set it to the mode in which challenges are sent. Possible options are 'casual', 'rated' and 'random'.
+# block_list:                      # The list of bots that will not be challenged
+#   - user1
+#   - user2
+# online_block_list:               # The urls from which to retrieve a list of bot names that will not be challenged. The list should be a text file where each line contains the name of a blocked bot
+#   - example.com/blocklist
+
+# overrides:                       # List of overrides for the matchmaking specifications above. When a challenge is created, either the default specification above or one of the overrides will be randomly chosen.
+#   bullet_only_horde:             # Name of the override. Can be anything as long as each override has a unique name ("bullet_only_horde" and "easy_chess960" in these examples).
+#     challenge_variant: "horde"   # List of options to override. Only the options mentioned will change when making the challenge. The rest will follow the default matchmaking options above.
+#     challenge_initial_time:
+#       - 1
+#       - 2
+#     challenge_increment:
+#       - 0
+#       - 1
+#
+#   easy_chess960:
+#     challenge_variant: "chess960"
+#     opponent_min_rating: 400
+#     opponent_max_rating: 1200
+#     opponent_rating_difference:
+#     challenge_mode: casual
+#
+#   no_pressure_correspondence:
+#     challenge_initial_time:
+#     challenge_increment:
+#     challenge_days:
+#       - 2
+#       - 3
+#     challenge_mode: casual
+#
+# The following configurations cannot be overridden: allow_matchmaking, challenge_timeout, challenge_filter and block_list.