├── .github └── workflows │ └── main.yaml ├── .gitignore ├── .gitpod.yml ├── LICENSE ├── README.md ├── dist └── awaken.html ├── package.json ├── src ├── Game.js ├── LichessApi.js ├── Main.js ├── RobotUser.js ├── bots │ ├── AntiPatzerPlayer.js │ ├── PatzerPlayer.js │ ├── RandomPlayer.js │ └── SwarmKingPlayer.js ├── tournament │ ├── Main.js │ ├── PlayOff.js │ └── Tournament.js └── utils │ └── ChessUtils.js ├── test ├── TestAntiPatzerPlayer.js ├── TestChessUtils.js ├── TestIntegration.js ├── TestLichessApi.js ├── TestPatzerPlayer.js ├── TestPlayOff.js ├── TestRandomPlayer.js ├── TestSwarmKingPlayer.js └── TestTournament.js └── yarn.lock /.github/workflows/main.yaml: -------------------------------------------------------------------------------- 1 | # Basic workflow 2 | 3 | name: Coverage 4 | 5 | on: 6 | # Triggers the workflow on push or pull request events but only for the "master" branch 7 | push: 8 | branches: ["master"] 9 | pull_request: 10 | branches: ["master"] 11 | 12 | # Allows you to run this workflow manually from the Actions tab 13 | workflow_dispatch: 14 | 15 | jobs: 16 | build: 17 | runs-on: ubuntu-latest 18 | 19 | steps: 20 | # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it 21 | - uses: actions/checkout@v3 22 | 23 | - name: install dependencies 24 | run: yarn install 25 | 26 | - name: generate coverage 27 | run: | 28 | yarn coverage 29 | echo done 30 | 31 | - name: Upload coverage reports to Codecov 32 | uses: codecov/codecov-action@v3 33 | env: 34 | CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} 35 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (http://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # Typescript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | .theia/ 61 | 62 | api_token.sh -------------------------------------------------------------------------------- /.gitpod.yml: -------------------------------------------------------------------------------- 1 | # This configuration file was automatically generated by Gitpod. 2 | # Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml) 3 | # and commit this file to your remote git repository to share the goodness with others. 4 | 5 | # Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart 6 | 7 | tasks: 8 | - init: yarn install && yarn run build 9 | command: yarn install 10 | 11 | 12 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # bot-o-tron 2 | 3 | [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=tailuge_bot-o-tron&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=tailuge_bot-o-tron) 4 | [![codecov](https://codecov.io/gh/tailuge/bot-o-tron/branch/master/graph/badge.svg?token=qlSyYVeGdi)](https://codecov.io/gh/tailuge/bot-o-tron) 5 | [![CodeFactor](https://www.codefactor.io/repository/github/tailuge/bot-o-tron/badge)](https://www.codefactor.io/repository/github/tailuge/bot-o-tron) 6 | [![Open in Gitpod](https://img.shields.io/badge/Gitpod-Open%20in%20Gitpod-%230092CF.svg)](https://gitpod.io/#https://github.com/tailuge/bot-o-tron) 7 | 8 | This project creates a simple chess bot using javascript that 9 | connects to [lichess'](https://lichess.org) 10 | bot interface . 11 | This project can be hosted free on cloud providers such as [render.com](https://render.com). 12 | 13 | * Play against this bot unrated now on lichess at [@bot-o-tron](https://lichess.org/@/bot-o-tron) 14 | 15 | ## Setup 16 | 17 | * Get an [API token](https://lichess.org/account/oauth/token) from lichess.org 18 | and add it as an environment variable on your machine or cloud hosting provider. 19 | 20 | ```bash 21 | $ nvm use v18.16.1 22 | $ yarn install 23 | 24 | # Linux 25 | $ export API_TOKEN=xxxxxxxxxx 26 | 27 | # Windows 28 | $ setx API_TOKEN xxxxxxxxxx 29 | ``` 30 | 31 | ## Run 32 | 33 | The project runs as an express node server that connects 34 | to the lichess BOT account using the API_TOKEN 35 | 36 | ```bash 37 | yarn start 38 | ``` 39 | 40 | ## Local unit tests and code coverage 41 | 42 | ```bash 43 | yarn test 44 | ``` 45 | 46 | To implement your chess bot you only need to create one class 47 | that implements the method: 48 | 49 | ```js 50 | getNextMove(moves) { 51 | return uciMove; 52 | } 53 | ``` 54 | 55 | Where moves is a list of moves so far in uci format e.g. `["e2e4", "b8c6", "f2f4"]` 56 | 57 | See [`RandomPlayer`](src/bots/RandomPlayer.js) for minimal implementation 58 | using [chess.js](https://github.com/jhlywa/chess.js/blob/master/README.md) 59 | 60 | ## Free Cloud Hosting 61 | 62 | If you register a free render.com account you can host a BOT like this one 63 | as is - just add your `API_TOKEN` to the environment property configuration. 64 | This code auto deploys and is live at 65 | 66 | [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy) 67 | 68 | ## Tournaments 69 | 70 | Compare bots locally in a round-robin tournament 71 | 72 | ```bash 73 | $ yarn tournament 74 | 75 | Results 76 | [ { player: 'AntiPatzerPlayer ', score: 32.5 }, 77 | { player: 'PatzerPlayer ', score: 23 }, 78 | { player: 'RandomPlayer ', score: 22.5 }, 79 | { player: 'SwarmKingPlayer ', score: 18 } ] 80 | ``` 81 | -------------------------------------------------------------------------------- /dist/awaken.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Awaken Bot-O-Tron 6 | 7 | 36 | 37 | 38 |
39 | Waiting for server to start on render.com 40 |
41 |
42 | 43 | https://bot-o-tron.onrender.com/ 45 |
46 | 47 |
48 | 49 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "lichess-node-bot", 3 | "version": "1.0.0", 4 | "description": "Lichess bot event and game code example", 5 | "main": "src/Main.js", 6 | "scripts": { 7 | "test": "nyc tap test/*", 8 | "coverage": "nyc --reporter=lcov tap test/*", 9 | "start": "node src/Main.js", 10 | "tournament": "node src/tournament/Main.js", 11 | "build": "echo 'runs directly with node'", 12 | "deps": "npx yarn-check --skip-unused", 13 | "markdownlint": "npx markdownlint-cli2 README.md --fix", 14 | "prettify": "prettier --write --trailing-comma es5 --no-semi {src,test}/**/*.[jt]s dist/*.html" 15 | }, 16 | "keywords": [], 17 | "author": "", 18 | "license": "ISC", 19 | "devDependencies": { 20 | "moxios": "^0.4.0", 21 | "nock": "13.5.4", 22 | "nyc": "^15.1.0", 23 | "sinon": "17.0.1", 24 | "tap": "^16.3.8", 25 | "tape": "5.7.5" 26 | }, 27 | "dependencies": { 28 | "axios": "1.6.8", 29 | "chess.js": "^1.0.0-beta.6", 30 | "express": "4.19.2", 31 | "ndjson": "^2.0.0", 32 | "oboe": "^2.1.5", 33 | "prettier": "3.2.5" 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /src/Game.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Game subscribes to gameId events and handles them posting moves 3 | * generated by player object that must implement two methods: 4 | * 5 | * getNextMove(array of uciMoves) returns uciMove 6 | * getReply(chat event) returns chat message 7 | * 8 | */ 9 | class Game { 10 | /** 11 | * Initialise with interface to lichess. 12 | */ 13 | constructor(api, name, player) { 14 | this.api = api 15 | this.name = name 16 | this.player = player 17 | } 18 | 19 | start(gameId) { 20 | this.gameId = gameId 21 | this.api.streamGame(gameId, (event) => this.handler(event)) 22 | } 23 | 24 | handleChatLine(event) { 25 | if (event.username !== this.name) { 26 | const reply = this.player.getReply(event) 27 | if (reply) { 28 | this.api.chat(this.gameId, event.room, reply) 29 | } 30 | } 31 | } 32 | 33 | handler(event) { 34 | switch (event.type) { 35 | case "chatLine": 36 | this.handleChatLine(event) 37 | break 38 | case "gameFull": 39 | this.colour = this.playingAs(event) 40 | this.playNextMove(event.state.moves) 41 | break 42 | case "gameState": 43 | this.playNextMove(event.moves) 44 | break 45 | default: 46 | console.log("Unhandled game event : " + JSON.stringify(event)) 47 | } 48 | } 49 | 50 | playNextMove(previousMoves) { 51 | const moves = previousMoves === "" ? [] : previousMoves.split(" ") 52 | if (this.isTurn(this.colour, moves)) { 53 | const nextMove = this.player.getNextMove(moves) 54 | if (nextMove) { 55 | console.log(this.name + " as " + this.colour + " to move " + nextMove) 56 | this.api.makeMove(this.gameId, nextMove) 57 | } 58 | } 59 | } 60 | 61 | playingAs(event) { 62 | return event.white.name === this.name ? "white" : "black" 63 | } 64 | 65 | isTurn(colour, moves) { 66 | const parity = moves.length % 2 67 | return colour === "white" ? parity === 0 : parity === 1 68 | } 69 | } 70 | 71 | module.exports = Game 72 | -------------------------------------------------------------------------------- /src/LichessApi.js: -------------------------------------------------------------------------------- 1 | const axios = require("axios") 2 | const oboe = require("oboe") 3 | /** 4 | * Programatic interface to the web API of lichess https://lichess.org/api#tag/Bot 5 | * 6 | */ 7 | class LichessApi { 8 | /** 9 | * Initialise with access token from https://lichess.org/account/oauth/token/create. 10 | */ 11 | constructor(token) { 12 | this.baseURL = "https://lichess.org/" 13 | this.headers = { Authorization: `Bearer ${token}` } 14 | this.axiosConfig = { 15 | baseURL: this.baseURL, 16 | headers: this.headers, 17 | } 18 | } 19 | 20 | acceptChallenge(challengeId) { 21 | return this.post(`api/challenge/${challengeId}/accept`) 22 | } 23 | 24 | declineChallenge(challengeId) { 25 | return this.post(`api/challenge/${challengeId}/decline`) 26 | } 27 | 28 | upgrade() { 29 | return this.post("api/bot/account/upgrade") 30 | } 31 | 32 | accountInfo() { 33 | return this.get("api/account") 34 | } 35 | 36 | makeMove(gameId, move) { 37 | return this.post(`api/bot/game/${gameId}/move/${move}`) 38 | } 39 | 40 | abortGame(gameId) { 41 | return this.post(`api/bot/game/${gameId}/abort`) 42 | } 43 | 44 | resignGame(gameId) { 45 | return this.post(`api/bot/game/${gameId}/resign`) 46 | } 47 | 48 | streamEvents(handler) { 49 | return this.stream("api/stream/event", handler) 50 | } 51 | 52 | streamGame(gameId, handler) { 53 | return this.stream(`api/bot/game/stream/${gameId}`, handler) 54 | } 55 | 56 | chat(gameId, room, text) { 57 | return this.post(`api/bot/game/${gameId}/chat`, { 58 | room, 59 | text, 60 | }) 61 | } 62 | 63 | logAndReturn(data) { 64 | console.log(JSON.stringify(data.data)) 65 | return data 66 | } 67 | 68 | get(URL) { 69 | console.log(`GET ${URL}`) 70 | return axios 71 | .get(URL + "?v=" + Date.now(), this.axiosConfig) 72 | .then(this.logAndReturn) 73 | .catch((err) => console.log(err)) 74 | } 75 | 76 | post(URL, body) { 77 | console.log(`POST ${URL} ` + JSON.stringify(body || {})) 78 | return axios 79 | .post(URL, body || {}, this.axiosConfig) 80 | .then(this.logAndReturn) 81 | .catch((err) => console.log(err.response || err)) 82 | } 83 | 84 | /** 85 | * Connect to stream with handler. 86 | * 87 | * The axios library does not support streams in the browser so use oboe. 88 | */ 89 | stream(URL, handler) { 90 | console.log(`GET ${URL} stream`) 91 | oboe({ 92 | method: "GET", 93 | url: this.baseURL + URL, 94 | headers: this.headers, 95 | }) 96 | .node("!", function (data) { 97 | console.log("STREAM data : " + JSON.stringify(data)) 98 | handler(data) 99 | }) 100 | .fail(function (errorReport) { 101 | console.error(JSON.stringify(errorReport)) 102 | }) 103 | } 104 | } 105 | 106 | module.exports = LichessApi 107 | -------------------------------------------------------------------------------- /src/Main.js: -------------------------------------------------------------------------------- 1 | const LichessApi = require("./LichessApi") 2 | 3 | const RobotUser = require("./RobotUser") 4 | const PatzerPlayer = require("./bots/PatzerPlayer") 5 | 6 | /** 7 | * Start a RobotUser (lichess account defined by API_TOKEN) that listens for challenges 8 | * and spawns games for unrated challenges. A player object must be supplied that can 9 | * produce the next move to play given the previous moves. 10 | * 11 | * Token can be created on BOT accounts at https://lichess.org/account/oauth/token/create 12 | * Put the token in the shell environment with 13 | * 14 | * export API_TOKEN=xxxxxxxxxxxxxx 15 | * yarn install 16 | * yarn start 17 | * 18 | */ 19 | 20 | async function startBot(token, player) { 21 | if (token) { 22 | const robot = new RobotUser(new LichessApi(token), player) 23 | const username = (await robot.start()).data.username 24 | return `${username} on lichess.
` 25 | } 26 | } 27 | 28 | async function begin() { 29 | let links = "

Challenge:


" 30 | 31 | links += await startBot(process.env.API_TOKEN, new PatzerPlayer()) 32 | 33 | // wakeup server (not necessary otherwise) 34 | 35 | const express = require("express") 36 | const PORT = process.env.PORT || 5000 37 | 38 | express() 39 | .get("/", (req, res) => res.send(links)) 40 | .listen(PORT, () => console.log(`Wake up server listening on ${PORT}`)) 41 | } 42 | 43 | begin() 44 | -------------------------------------------------------------------------------- /src/RobotUser.js: -------------------------------------------------------------------------------- 1 | const LichessApi = require("./LichessApi") 2 | const Game = require("./Game") 3 | 4 | /** 5 | * RobotUser listens for challenges and spawns Games on accepting. 6 | * 7 | */ 8 | class RobotUser { 9 | /** 10 | * Initialise with access token to lichess and a player algorithm. 11 | */ 12 | constructor(api, player) { 13 | this.api = api 14 | this.player = player 15 | } 16 | 17 | async start() { 18 | this.account = await this.api.accountInfo() 19 | console.log("Playing as " + this.account.data.username) 20 | this.api.streamEvents((event) => this.eventHandler(event)) 21 | return this.account 22 | } 23 | 24 | eventHandler(event) { 25 | switch (event.type) { 26 | case "challenge": 27 | this.handleChallenge(event.challenge) 28 | break 29 | case "gameStart": 30 | this.handleGameStart(event.game.id) 31 | break 32 | default: 33 | console.log("Unhandled event : " + JSON.stringify(event)) 34 | } 35 | } 36 | 37 | handleGameStart(id) { 38 | const game = new Game(this.api, this.account.data.username, this.player) 39 | game.start(id) 40 | } 41 | 42 | async handleChallenge(challenge) { 43 | if (challenge.rated) { 44 | console.log("Declining rated challenge from " + challenge.challenger.id) 45 | const response = await this.api.declineChallenge(challenge.id) 46 | console.log("Declined", response.data || response) 47 | } else { 48 | console.log("Accepting unrated challenge from " + challenge.challenger.id) 49 | const response = await this.api.acceptChallenge(challenge.id) 50 | console.log("Accepted", response.data || response) 51 | } 52 | } 53 | } 54 | 55 | module.exports = RobotUser 56 | -------------------------------------------------------------------------------- /src/bots/AntiPatzerPlayer.js: -------------------------------------------------------------------------------- 1 | const ChessUtils = require("../utils/ChessUtils") 2 | 3 | /** 4 | * Do not play moves that leave opponent with mate in one or checks or captures. 5 | * else random. 6 | * 7 | */ 8 | class AntiPatzerPlayer { 9 | getNextMove(moves) { 10 | const chess = new ChessUtils() 11 | chess.applyMoves(moves) 12 | const legalMoves = chess.legalMoves() 13 | 14 | if (legalMoves.length) { 15 | legalMoves.forEach((m) => { 16 | chess.move(m) 17 | const opponentsMoves = chess.legalMoves() 18 | const opponentsMates = opponentsMoves.filter((move) => 19 | /#/.test(move.san) 20 | ) 21 | const opponentsChecks = opponentsMoves.filter((move) => 22 | /\+/.test(move.san) 23 | ) 24 | const opponentsCaptures = opponentsMoves.filter((move) => 25 | /x/.test(move.san) 26 | ) 27 | m.metric = -opponentsMoves.length 28 | m.metric += -opponentsCaptures.length * 10 29 | m.metric += -opponentsChecks.length * 100 30 | m.metric += -opponentsMates.length * 1000 31 | chess.undo() 32 | }) 33 | 34 | // choose move that maximises metric 35 | return chess.uci(legalMoves.reduce(this.randomMax)) 36 | } 37 | } 38 | 39 | randomMax(a, b) { 40 | return a.metric + Math.random() > b.metric + Math.random() ? a : b 41 | } 42 | 43 | getReply(chat) { 44 | return "AntiPatzerPlayer" 45 | } 46 | } 47 | 48 | module.exports = AntiPatzerPlayer 49 | -------------------------------------------------------------------------------- /src/bots/PatzerPlayer.js: -------------------------------------------------------------------------------- 1 | const ChessUtils = require("../utils/ChessUtils") 2 | 3 | /** 4 | * Pick a random legal move but prefer mates, checks and captures. 5 | */ 6 | class PatzerPlayer { 7 | getNextMove(moves) { 8 | const chess = new ChessUtils() 9 | chess.applyMoves(moves) 10 | const legalMoves = chess.legalMoves() 11 | const forcing = chess.filterForcing(legalMoves) 12 | const captures = legalMoves.filter((move) => /x/.test(move.san)) 13 | 14 | if (forcing.length) { 15 | return chess.pickRandomMove(forcing) 16 | } 17 | 18 | if (captures.length) { 19 | return chess.pickRandomMove(captures) 20 | } 21 | 22 | if (legalMoves.length) { 23 | return chess.pickRandomMove(legalMoves) 24 | } 25 | } 26 | 27 | getReply(chat) { 28 | return "hi" 29 | } 30 | } 31 | 32 | module.exports = PatzerPlayer 33 | -------------------------------------------------------------------------------- /src/bots/RandomPlayer.js: -------------------------------------------------------------------------------- 1 | const ChessUtils = require("../utils/ChessUtils") 2 | 3 | /** 4 | * Pick a random legal move. 5 | */ 6 | class RandomPlayer { 7 | getNextMove(moves) { 8 | const chess = new ChessUtils() 9 | chess.applyMoves(moves) 10 | const legalMoves = chess.legalMoves() 11 | if (legalMoves.length) { 12 | return chess.pickRandomMove(legalMoves) 13 | } 14 | } 15 | 16 | getReply(chat) { 17 | return "hi" 18 | } 19 | } 20 | 21 | module.exports = RandomPlayer 22 | -------------------------------------------------------------------------------- /src/bots/SwarmKingPlayer.js: -------------------------------------------------------------------------------- 1 | const ChessUtils = require("../utils/ChessUtils") 2 | 3 | /** 4 | * Move pieces closer to own king - mate and check if possible. 5 | */ 6 | class SwarmKingPlayer { 7 | getNextMove(moves) { 8 | const chess = new ChessUtils() 9 | chess.applyMoves(moves) 10 | let legalMoves = chess.legalMoves() 11 | const forcing = chess.filterForcing(legalMoves) 12 | 13 | if (forcing.length) { 14 | return chess.pickRandomMove(forcing) 15 | } 16 | 17 | legalMoves = this.removeReverseMoves(moves, legalMoves) 18 | 19 | if (legalMoves.length) { 20 | const colour = chess.turn() 21 | 22 | // get distance to king in all successor states 23 | legalMoves.forEach((m) => { 24 | chess.move(m) 25 | const squareOfKing = chess.squareOfOpponentsKing() 26 | m.metric = this.distanceMetric(chess, squareOfKing, colour) 27 | chess.undo() 28 | }) 29 | 30 | // choose move that maximises metric 31 | return chess.uci(legalMoves.reduce(this.randomMax)) 32 | } 33 | } 34 | 35 | randomMax(a, b) { 36 | return a.metric + Math.random() > b.metric + Math.random() ? a : b 37 | } 38 | 39 | removeReverseMoves(previousUciMoves, legalMoves) { 40 | const filtered = legalMoves.filter( 41 | (move) => !previousUciMoves.includes(move.to + move.from) 42 | ) 43 | return filtered.length === 0 ? legalMoves : filtered 44 | } 45 | 46 | /** 47 | * Sum of (16 - manhattan distance to king) for each piece of given colour. 48 | */ 49 | distanceMetric(chess, targetSquare, colour) { 50 | const target = chess.coordinates(targetSquare) 51 | const distances = chess 52 | .squaresOf(colour) 53 | .map( 54 | (square) => 55 | 16 - chess.manhattanDistance(target, chess.coordinates(square)) 56 | ) 57 | return distances.reduce((a, b) => a + b, 0) 58 | } 59 | 60 | getReply(chat) { 61 | return "swarm the king!" 62 | } 63 | } 64 | 65 | module.exports = SwarmKingPlayer 66 | -------------------------------------------------------------------------------- /src/tournament/Main.js: -------------------------------------------------------------------------------- 1 | const Tournament = require("./Tournament") 2 | const PatzerPlayer = require("../bots/PatzerPlayer") 3 | const SwarmKingPlayer = require("../bots/SwarmKingPlayer") 4 | const RandomPlayer = require("../bots/RandomPlayer") 5 | const AntiPatzerPlayer = require("../bots/AntiPatzerPlayer") 6 | 7 | const players = [ 8 | new PatzerPlayer(), 9 | new SwarmKingPlayer(), 10 | new RandomPlayer(), 11 | new AntiPatzerPlayer(), 12 | ] 13 | 14 | /** 15 | * Run tournament and report results to console. 16 | */ 17 | 18 | const tournament = new Tournament(players, 16) 19 | 20 | console.log("Start") 21 | 22 | const rounds = 8 23 | let round = 1 24 | 25 | console.log(players) 26 | 27 | while (round++ <= rounds) { 28 | tournament.playRound() 29 | console.log(tournament.getScores()) 30 | } 31 | 32 | console.log("Results") 33 | console.log(tournament.getRank()) 34 | -------------------------------------------------------------------------------- /src/tournament/PlayOff.js: -------------------------------------------------------------------------------- 1 | const ChessUtils = require("../utils/ChessUtils") 2 | 3 | /** 4 | * Play off two players and capture result after maximum number of moves. 5 | */ 6 | class PlayOff { 7 | constructor(player1, player2, moves = []) { 8 | this.player1 = player1 9 | this.player2 = player2 10 | this.moves = moves 11 | this.result = 0.5 12 | } 13 | 14 | play(max) { 15 | while (this.moves.length < max) { 16 | if ( 17 | !this.makeMove( 18 | this.moves.length % 2 === 0 ? this.player1 : this.player2 19 | ) 20 | ) { 21 | return 22 | } 23 | } 24 | this.adjudicate() 25 | } 26 | 27 | makeMove(player) { 28 | this.moves.push(player.getNextMove(this.moves)) 29 | const chess = new ChessUtils() 30 | chess.applyMoves(this.moves) 31 | if (chess.inCheckmate()) { 32 | this.setScore(player, 1) 33 | return false 34 | } else if (chess.inStalemate()) { 35 | this.setScore(player, 0.5) 36 | return false 37 | } 38 | return true 39 | } 40 | 41 | score(player) { 42 | return player === this.player1 ? this.result : 1 - this.result 43 | } 44 | 45 | setScore(player, value) { 46 | this.result = player === this.player1 ? value : 1 - value 47 | } 48 | 49 | adjudicate() { 50 | const chess = new ChessUtils() 51 | chess.applyMoves(this.moves) 52 | const materialEval = chess.materialEval() 53 | if (Math.abs(materialEval) < 2) { 54 | this.result = 0.5 55 | } else if (materialEval > 0) { 56 | this.result = 1 57 | } else { 58 | this.result = 0 59 | } 60 | } 61 | } 62 | 63 | module.exports = PlayOff 64 | -------------------------------------------------------------------------------- /src/tournament/Tournament.js: -------------------------------------------------------------------------------- 1 | const PlayOff = require("./PlayOff") 2 | 3 | /** 4 | * Play 5 | */ 6 | class Tournament { 7 | constructor(players, maxMoves) { 8 | this.players = players 9 | this.maxMoves = maxMoves 10 | this.scores = players.map((p) => 0) 11 | } 12 | 13 | playRound() { 14 | this.players.forEach((a) => 15 | this.players.forEach((b) => { 16 | if (a !== b) { 17 | const playOff = new PlayOff(a, b) 18 | playOff.play(this.maxMoves) 19 | this.scores[this.players.indexOf(a)] += playOff.score(a) 20 | this.scores[this.players.indexOf(b)] += playOff.score(b) 21 | } 22 | }) 23 | ) 24 | } 25 | 26 | getScores() { 27 | return this.scores 28 | } 29 | 30 | getRank() { 31 | return this.players 32 | .map((p) => ({ player: this.playerName(p), score: this.playerScore(p) })) 33 | .sort((a, b) => a.score < b.score) 34 | } 35 | 36 | playerName(p) { 37 | return p.constructor.name.padEnd(20) 38 | } 39 | 40 | playerScore(p) { 41 | return this.scores[this.players.indexOf(p)] 42 | } 43 | } 44 | 45 | module.exports = Tournament 46 | -------------------------------------------------------------------------------- /src/utils/ChessUtils.js: -------------------------------------------------------------------------------- 1 | const Chess = require("chess.js").Chess 2 | 3 | /** 4 | * Wraps chess.js with useful extras. 5 | */ 6 | class ChessUtils { 7 | constructor( 8 | fen = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1" 9 | ) { 10 | this.chess = new Chess(fen) 11 | // prettier-ignore 12 | this.SQUARES = [ 13 | 'a8', 'b8', 'c8', 'd8', 'e8', 'f8', 'g8', 'h8', 14 | 'a7', 'b7', 'c7', 'd7', 'e7', 'f7', 'g7', 'h7', 15 | 'a6', 'b6', 'c6', 'd6', 'e6', 'f6', 'g6', 'h6', 16 | 'a5', 'b5', 'c5', 'd5', 'e5', 'f5', 'g5', 'h5', 17 | 'a4', 'b4', 'c4', 'd4', 'e4', 'f4', 'g4', 'h4', 18 | 'a3', 'b3', 'c3', 'd3', 'e3', 'f3', 'g3', 'h3', 19 | 'a2', 'b2', 'c2', 'd2', 'e2', 'f2', 'g2', 'h2', 20 | 'a1', 'b1', 'c1', 'd1', 'e1', 'f1', 'g1', 'h1' 21 | ] 22 | } 23 | 24 | reset() { 25 | this.chess.reset() 26 | } 27 | 28 | applyMoves(moves) { 29 | moves.forEach((move) => this.chess.move(move, { sloppy: true })) 30 | } 31 | 32 | /** 33 | * Convert a chess.js move to a uci move 34 | */ 35 | uci(move) { 36 | return move.from + move.to + (move.flags === "p" ? move.piece : "") 37 | } 38 | 39 | /** 40 | * Legal moves from current position. 41 | */ 42 | legalMoves() { 43 | return this.chess.moves({ verbose: true }) 44 | } 45 | 46 | fen() { 47 | return this.chess.fen() 48 | } 49 | 50 | move(move) { 51 | this.chess.move(move) 52 | } 53 | 54 | undo() { 55 | this.chess.undo() 56 | } 57 | 58 | turn() { 59 | return this.chess.turn() 60 | } 61 | 62 | squaresOf(colour) { 63 | return this.SQUARES.filter((square) => { 64 | const r = this.chess.get(square) 65 | return r && r.color === colour 66 | }) 67 | } 68 | 69 | squareOfKing() { 70 | return this.squaresOfPiece(this.chess.turn(), "k") 71 | } 72 | 73 | squareOfOpponentsKing() { 74 | return this.squaresOfPiece(this.otherPlayer(this.chess.turn()), "k") 75 | } 76 | 77 | squaresOfPiece(colour, pieceType) { 78 | return this.squaresOf(colour).find( 79 | (square) => this.chess.get(square).type.toLowerCase() === pieceType 80 | ) 81 | } 82 | 83 | coordinates(square) { 84 | return { 85 | x: square.charCodeAt(0) - "a".charCodeAt(0) + 1, 86 | y: Number(square.substring(1, 2)), 87 | } 88 | } 89 | 90 | distance(a, b) { 91 | return Math.max(Math.abs(a.x - b.x), Math.abs(a.y - b.y)) 92 | } 93 | 94 | manhattanDistance(a, b) { 95 | return Math.abs(a.x - b.x) + Math.abs(a.y - b.y) 96 | } 97 | 98 | euclideanDistance(a, b) { 99 | const dx = a.x - b.x 100 | const dy = a.y - b.y 101 | return Math.sqrt(dx * dx + dy * dy) 102 | } 103 | 104 | otherPlayer(colour) { 105 | return colour === "w" ? "b" : "w" 106 | } 107 | 108 | pickRandomMove(moves) { 109 | return this.uci(moves[Math.floor(Math.random() * moves.length)]) 110 | } 111 | 112 | filterForcing(legalMoves) { 113 | const mates = legalMoves.filter((move) => /#/.test(move.san)) 114 | return mates.length 115 | ? mates 116 | : legalMoves.filter((move) => /\+/.test(move.san)) 117 | } 118 | 119 | inCheckmate() { 120 | return this.chess.isCheckmate() 121 | } 122 | 123 | inStalemate() { 124 | return this.chess.isStalemate() 125 | } 126 | 127 | materialEval() { 128 | return this.material("w") - this.material("b") 129 | } 130 | 131 | material(colour) { 132 | const valueOf = { p: 1, n: 3, b: 3, r: 6, q: 9, k: 0 } 133 | return this.squaresOf(colour) 134 | .map((square) => valueOf[this.chess.get(square).type]) 135 | .reduce((a, b) => a + b) 136 | } 137 | } 138 | 139 | module.exports = ChessUtils 140 | -------------------------------------------------------------------------------- /test/TestAntiPatzerPlayer.js: -------------------------------------------------------------------------------- 1 | const tap = require("tap") 2 | const AntiPatzerPlayer = require("../src/bots/AntiPatzerPlayer") 3 | 4 | const player = new AntiPatzerPlayer() 5 | 6 | tap.test("getReply", function (t) { 7 | t.equal(player.getReply({}), "AntiPatzerPlayer", "chat implemented") 8 | t.end() 9 | }) 10 | 11 | tap.test("getNextMove", function (t) { 12 | t.ok(player.getNextMove([]), "uci move played from initial position") 13 | t.notOk( 14 | player.getNextMove([ 15 | "e2e4", 16 | "a7a6", 17 | "f1c4", 18 | "a8a7", 19 | "d1h5", 20 | "a7a8", 21 | "c4f7", 22 | ]), 23 | "no moves available" 24 | ) 25 | t.end() 26 | }) 27 | 28 | tap.test("getNextMove mate blocked", function (t) { 29 | t.match( 30 | player.getNextMove(["e4", "e5", "Bc4", "Na6", "Qf3"]), 31 | /d8f6|g8f6/, 32 | "mate is blocked" 33 | ) 34 | t.end() 35 | }) 36 | -------------------------------------------------------------------------------- /test/TestChessUtils.js: -------------------------------------------------------------------------------- 1 | const tap = require("tap") 2 | const ChessUtils = require("../src/utils/ChessUtils") 3 | const chess = new ChessUtils() 4 | 5 | const a1 = chess.coordinates("a1") 6 | const a8 = chess.coordinates("a8") 7 | const b8 = chess.coordinates("b8") 8 | 9 | const initialPosition = 10 | "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1" 11 | 12 | tap.beforeEach(function (_) { 13 | chess.reset() 14 | }) 15 | 16 | tap.test("uci", function (t) { 17 | t.equal(chess.uci({ from: "e2", to: "e4" }), "e2e4", "pawn to e4") 18 | t.equal( 19 | chess.uci({ from: "a7", to: "a8", flags: "p", piece: "q" }), 20 | "a7a8q", 21 | "promote to queen on a8" 22 | ) 23 | t.end() 24 | }) 25 | 26 | tap.test("fen", function (t) { 27 | chess.applyMoves([]) 28 | t.equal(chess.fen(), initialPosition, "no moves gives initial position") 29 | t.end() 30 | }) 31 | 32 | tap.test("legalMoves", function (t) { 33 | t.equal(chess.legalMoves().length, 20, "20 legal moves at start of game") 34 | t.end() 35 | }) 36 | 37 | tap.test("squaresOfColour", function (t) { 38 | t.equal(chess.squaresOf("w").length, 16, "16 white squares") 39 | t.equal(chess.squaresOf("b").length, 16, "16 black squares") 40 | t.end() 41 | }) 42 | 43 | tap.test("squareOfKing", function (t) { 44 | t.equal(chess.squareOfKing(), "e1", "white king on e1") 45 | t.equal(chess.squareOfOpponentsKing(), "e8", "black king on e8") 46 | t.end() 47 | }) 48 | 49 | tap.test("coordinates", function (t) { 50 | t.deepEqual(chess.coordinates("a1"), { x: 1, y: 1 }, "at at 1,1") 51 | t.end() 52 | }) 53 | 54 | tap.test("distance", function (t) { 55 | t.equal(chess.distance(a1, a1), 0, "0 distance same square") 56 | t.equal(chess.distance(a1, a8), 7, "7 distance between a1 a8") 57 | t.equal(chess.distance(a1, b8), 7, "7 distance between a1 b8") 58 | t.end() 59 | }) 60 | 61 | tap.test("manhattanDistance", function (t) { 62 | t.equal(chess.manhattanDistance(a1, a1), 0, "0 manhattanDistance same square") 63 | t.equal( 64 | chess.manhattanDistance(a1, a8), 65 | 7, 66 | "7 manhattanDistance between a1 a8" 67 | ) 68 | t.equal( 69 | chess.manhattanDistance(a1, b8), 70 | 8, 71 | "8 manhattanDistance between a1 a8" 72 | ) 73 | t.end() 74 | }) 75 | 76 | tap.test("euclideanDistance", function (t) { 77 | t.equal(chess.euclideanDistance(a1, a1), 0, "0 euclideanDistance same square") 78 | t.equal( 79 | chess.euclideanDistance(a1, a8), 80 | 7, 81 | "7 euclideanDistance between a1 a8" 82 | ) 83 | t.equal( 84 | chess.euclideanDistance(a1, b8), 85 | Math.sqrt(7 * 7 + 1), 86 | "7.071 euclideanDistance between a1 a8" 87 | ) 88 | t.end() 89 | }) 90 | 91 | tap.test("otherPlayer", function (t) { 92 | t.equal(chess.otherPlayer("w"), "b", "w -> b") 93 | t.equal(chess.otherPlayer("b"), "w", "b -> w") 94 | t.end() 95 | }) 96 | 97 | tap.test("material", function (t) { 98 | t.equal(chess.material("w"), chess.material("b"), "material equal at start") 99 | t.end() 100 | }) 101 | 102 | tap.test("materialEval", function (t) { 103 | t.equal(chess.materialEval(), 0, "eval 0 at start") 104 | t.end() 105 | }) 106 | -------------------------------------------------------------------------------- /test/TestIntegration.js: -------------------------------------------------------------------------------- 1 | const tap = require("tap") 2 | const sinon = require("sinon") 3 | 4 | const RobotUser = require("../src/RobotUser") 5 | const RandomPlayer = require("../src/bots/RandomPlayer") 6 | const LichessApi = require("../src/LichessApi") 7 | 8 | const gameId = "gid001" 9 | const challengeId = "cid001" 10 | const token = "api token" 11 | const id = "bot-o-tron" 12 | const name = "bot-o-tron" 13 | const ratedChallenge = { 14 | type: "challenge", 15 | challenge: { 16 | id: challengeId, 17 | challenger: { id: "lovlas" }, 18 | destUser: { id, name }, 19 | variant: { key: "standard", name: "Standard", short: "Std" }, 20 | rated: true, 21 | timeControl: { type: "clock", limit: 300, increment: 25, show: "5+25" }, 22 | color: "random", 23 | }, 24 | } 25 | const unratedChallenge = JSON.parse(JSON.stringify(ratedChallenge)) 26 | unratedChallenge.challenge.rated = false 27 | const gameStart = { type: "gameStart", game: { id: gameId } } 28 | const gameFullWhite = { 29 | type: "gameFull", 30 | id: gameId, 31 | rated: false, 32 | variant: { key: "standard", name: "Standard", short: "Std" }, 33 | clock: { initial: 1200000, increment: 10000 }, 34 | white: { id, name }, 35 | black: { id: "leela", name: "Leela" }, 36 | initialFen: "startpos", 37 | state: { type: "gameState", moves: "" }, 38 | } 39 | const gameFullBlack = JSON.parse(JSON.stringify(gameFullWhite)) 40 | gameFullBlack.white.id = "other" 41 | gameFullBlack.white.name = "Other" 42 | const chatOther = { 43 | type: "chatLine", 44 | username: "Other", 45 | text: "Hello", 46 | room: "player", 47 | } 48 | const chatSelf = { 49 | type: "chatLine", 50 | username: name, 51 | text: "Hello", 52 | room: "player", 53 | } 54 | 55 | /** 56 | * The idea of this test suite is to take the ensemble of classes through a 57 | * login, accept challenge and game play sequence of actions against a mock lichess. 58 | */ 59 | 60 | let robotUser 61 | let lichessApi 62 | let accountInfo 63 | let declineChallenge 64 | let acceptChallenge 65 | let streamEvents 66 | let streamGame 67 | let makeMove 68 | let chat 69 | 70 | tap.beforeEach(function (_) { 71 | lichessApi = new LichessApi(token) 72 | accountInfo = sinon.stub(lichessApi, "accountInfo") 73 | declineChallenge = sinon.stub(lichessApi, "declineChallenge") 74 | acceptChallenge = sinon.stub(lichessApi, "acceptChallenge") 75 | makeMove = sinon.stub(lichessApi, "makeMove") 76 | chat = sinon.stub(lichessApi, "chat") 77 | streamEvents = sinon.stub(lichessApi, "streamEvents") 78 | streamGame = sinon.stub(lichessApi, "streamGame") 79 | 80 | accountInfo.returns({ data: { id: "bot-o-tron", username: "bot-o-tron" } }) 81 | declineChallenge.returns({ data: { ok: true } }) 82 | acceptChallenge.returns({ data: { ok: true } }) 83 | 84 | robotUser = new RobotUser(lichessApi, new RandomPlayer()) 85 | }) 86 | 87 | async function startAndGetEventHandler(t) { 88 | const response = await robotUser.start() 89 | t.equal(response.data.id, "bot-o-tron", "user id returned") 90 | t.ok(accountInfo.calledOnce, "accountInfo called once") 91 | t.ok(streamEvents.calledOnce, "streamEvents called once") 92 | return streamEvents.getCall(0).args[0] 93 | } 94 | 95 | async function startGameAndGetGameHandler(t) { 96 | const eventHandler = await startAndGetEventHandler(t) 97 | eventHandler(gameStart) 98 | t.ok(streamGame.calledOnce, "streamGame called once") 99 | t.equal(streamGame.getCall(0).args[0], gameId) 100 | return streamGame.getCall(0).args[1] 101 | } 102 | 103 | tap.test("decline rated game", async function (t) { 104 | const eventHandler = await startAndGetEventHandler(t) 105 | eventHandler(ratedChallenge) 106 | t.ok(declineChallenge.calledOnce, "declineChallenge called once") 107 | t.equal( 108 | declineChallenge.getCall(0).args[0], 109 | challengeId, 110 | "called with correct challenge id" 111 | ) 112 | t.end() 113 | }) 114 | 115 | tap.test("accept unrated game", async function (t) { 116 | const eventHandler = await startAndGetEventHandler(t) 117 | eventHandler(unratedChallenge) 118 | t.ok(acceptChallenge.calledOnce, "acceptChallenge called once") 119 | t.equal( 120 | acceptChallenge.getCall(0).args[0], 121 | challengeId, 122 | "called with correct challenge id" 123 | ) 124 | t.end() 125 | }) 126 | 127 | tap.test("game start as white", async function (t) { 128 | const gameEventHandler = await startGameAndGetGameHandler(t) 129 | gameEventHandler(gameFullWhite) 130 | t.ok(makeMove.calledOnce, "makeMove called once") 131 | t.end() 132 | }) 133 | 134 | tap.test("game start as black", async function (t) { 135 | const gameEventHandler = await startGameAndGetGameHandler(t) 136 | gameEventHandler(gameFullBlack) 137 | t.ok(makeMove.notCalled, "makeMove notCalled") 138 | gameEventHandler({ type: "gameState", moves: "e2e4" }) 139 | t.ok(makeMove.calledOnce, "makeMove called once") 140 | t.end() 141 | }) 142 | 143 | tap.test("game chat", async function (t) { 144 | const gameEventHandler = await startGameAndGetGameHandler(t) 145 | gameEventHandler(chatSelf) 146 | t.ok(chat.notCalled, "chat not called") 147 | gameEventHandler(chatOther) 148 | t.ok(chat.calledOnce, "chat called once") 149 | t.end() 150 | }) 151 | -------------------------------------------------------------------------------- /test/TestLichessApi.js: -------------------------------------------------------------------------------- 1 | const tap = require("tap") 2 | const moxios = require("moxios") 3 | const nock = require("nock") 4 | const ndjson = require("ndjson") 5 | const LichessApi = require("../src/LichessApi") 6 | 7 | const gameId = "gid001" 8 | const challengeId = "cid001" 9 | const secret = "secret api token" 10 | const accountResponse = { 11 | status: 200, 12 | response: { id: "bot-o-tron", username: "bot-o-tron" }, 13 | } 14 | const okResponse = { status: 200, response: { ok: true } } 15 | const eventResponse = { id: "1", type: "event" } 16 | const gameEventResponse = { id: "2", type: "move" } 17 | 18 | const api = new LichessApi(secret) 19 | 20 | function assertRequest(t, method, pathregexp, response) { 21 | moxios.wait(function () { 22 | let request = moxios.requests.mostRecent() 23 | t.equal(request.config.method, method, "correct method") 24 | t.ok(pathregexp.test(request.config.url), "correct path") 25 | t.equal( 26 | request.headers.Authorization, 27 | "Bearer " + secret, 28 | "credentials are correct" 29 | ) 30 | request.respondWith(response) 31 | }) 32 | } 33 | 34 | tap.beforeEach(function (_) { 35 | moxios.install() 36 | }) 37 | 38 | tap.afterEach(function (_) { 39 | moxios.uninstall() 40 | }) 41 | 42 | tap.test("streamEvents", function (t) { 43 | const serialize = ndjson.stringify() 44 | nock("https://lichess.org").get("/api/stream/event").reply(200, serialize) 45 | 46 | serialize.write(eventResponse) 47 | 48 | api.streamEvents((x) => { 49 | console.log("Callback") 50 | t.ok(true, "callback called") 51 | t.end() 52 | }) 53 | }) 54 | 55 | tap.test("streamEventsEnd", function (t) { 56 | t.end() 57 | }) 58 | 59 | tap.test("streamGame", function (t) { 60 | const serialize = ndjson.stringify() 61 | nock("https://lichess.org") 62 | .get(`/api/bot/game/stream/${gameId}`) 63 | .reply(200, serialize) 64 | serialize.write(gameEventResponse) 65 | api.streamGame(gameId, (x) => { 66 | console.log("Callback") 67 | t.ok(true, "callback called") 68 | t.end() 69 | }) 70 | }) 71 | 72 | tap.test("streamGameEnd", function (t) { 73 | t.end() 74 | }) 75 | 76 | tap.test("acceptChallenge", async function (t) { 77 | assertRequest( 78 | t, 79 | "post", 80 | new RegExp(`api/challenge/${challengeId}/accept`), 81 | okResponse 82 | ) 83 | const response = await api.acceptChallenge(challengeId) 84 | t.equal(response.data.ok, true, "response correct") 85 | t.end() 86 | }) 87 | 88 | tap.test("declineChallenge", async function (t) { 89 | assertRequest( 90 | t, 91 | "post", 92 | new RegExp(`api/challenge/${challengeId}/decline`), 93 | okResponse 94 | ) 95 | const response = await api.declineChallenge(challengeId) 96 | t.equal(response.data.ok, true, "response correct") 97 | t.end() 98 | }) 99 | 100 | tap.test("upgrade", async function (t) { 101 | assertRequest(t, "post", new RegExp("api/bot/account/upgrade"), okResponse) 102 | const response = await api.upgrade() 103 | t.equal(response.data.ok, true, "response correct") 104 | t.end() 105 | }) 106 | 107 | tap.test("accountInfo", async function (t) { 108 | assertRequest(t, "get", new RegExp("api/account"), accountResponse) 109 | const response = await api.accountInfo() 110 | t.equal(response.data.id, "bot-o-tron", "user id returned") 111 | t.end() 112 | }) 113 | 114 | tap.test("makeMove", async function (t) { 115 | const move = "e2e4" 116 | assertRequest( 117 | t, 118 | "post", 119 | new RegExp(`api/bot/game/${gameId}/move/${move}`), 120 | okResponse 121 | ) 122 | const response = await api.makeMove(gameId, move) 123 | t.equal(response.data.ok, true, "response correct") 124 | t.end() 125 | }) 126 | 127 | tap.test("abortGame", async function (t) { 128 | assertRequest( 129 | t, 130 | "post", 131 | new RegExp(`api/bot/game/${gameId}/abort`), 132 | okResponse 133 | ) 134 | const response = await api.abortGame(gameId) 135 | t.equal(response.data.ok, true, "response correct") 136 | t.end() 137 | }) 138 | 139 | tap.test("resignGame", async function (t) { 140 | assertRequest( 141 | t, 142 | "post", 143 | new RegExp(`api/bot/game/${gameId}/resign`), 144 | okResponse 145 | ) 146 | const response = await api.resignGame(gameId) 147 | t.equal(response.data.ok, true, "response correct") 148 | t.end() 149 | }) 150 | 151 | tap.test("chat", async function (t) { 152 | assertRequest( 153 | t, 154 | "post", 155 | new RegExp(`api/bot/game/${gameId}/chat`), 156 | okResponse 157 | ) 158 | const response = await api.chat(gameId, "lobby", "hi") 159 | t.equal(response.data.ok, true, "response correct") 160 | t.end() 161 | }) 162 | -------------------------------------------------------------------------------- /test/TestPatzerPlayer.js: -------------------------------------------------------------------------------- 1 | const test = require("tape") 2 | const PatzerPlayer = require("../src/bots/PatzerPlayer") 3 | 4 | const player = new PatzerPlayer() 5 | 6 | test("getReply", function (t) { 7 | t.equal(player.getReply({}), "hi", "chat says hi") 8 | t.end() 9 | }) 10 | 11 | test("getNextMove", function (t) { 12 | t.ok(player.getNextMove([]), "uci move played from initial position") 13 | t.equal( 14 | player.getNextMove(["e2e4", "a7a6", "f1c4", "a8a7"]), 15 | "c4f7", 16 | "check is played when available" 17 | ) 18 | t.equal( 19 | player.getNextMove(["e2e4", "g8f6", "f2f4"]), 20 | "f6e4", 21 | "capture is played" 22 | ) 23 | t.notOk( 24 | player.getNextMove([ 25 | "e2e4", 26 | "a7a6", 27 | "f1c4", 28 | "a8a7", 29 | "d1h5", 30 | "a7a8", 31 | "c4f7", 32 | ]), 33 | "no moves available" 34 | ) 35 | const mate = player.getNextMove([ 36 | "e2e4", 37 | "a7a6", 38 | "f1c4", 39 | "a8a7", 40 | "d1h5", 41 | "a7a8", 42 | ]) 43 | t.ok(mate === "h5f7" || mate === "c4f7", "mate is played when available") 44 | t.end() 45 | }) 46 | -------------------------------------------------------------------------------- /test/TestPlayOff.js: -------------------------------------------------------------------------------- 1 | const test = require("tape") 2 | 3 | const PlayOff = require("../src/tournament/PlayOff") 4 | const PatzerPlayer = require("../src/bots/PatzerPlayer") 5 | 6 | const player1 = new PatzerPlayer() 7 | const player2 = new PatzerPlayer() 8 | 9 | test("playOff draw", function (t) { 10 | const playOff = new PlayOff(player1, player2) 11 | t.equal(playOff.score(player1), 0.5, "score starts at 0.5") 12 | t.equal(playOff.score(player2), 0.5, "score starts at 0.5") 13 | playOff.play(2) 14 | t.equal(playOff.score(player1), 0.5, "draw after 1 move each") 15 | t.equal(playOff.score(player2), 0.5, "draw after 1 move each") 16 | t.end() 17 | }) 18 | 19 | test("playOff white win", function (t) { 20 | const playOff = new PlayOff(player1, player2, [ 21 | "e2e4", 22 | "a7a6", 23 | "f1c4", 24 | "a8a7", 25 | "d1h5", 26 | "a7a8", 27 | ]) 28 | playOff.play(8) 29 | t.equal(playOff.score(player1), 1, "white win checkmate") 30 | t.equal(playOff.score(player2), 0, "black loss checkmate") 31 | t.end() 32 | }) 33 | 34 | test("playOff black win", function (t) { 35 | const playOff = new PlayOff( 36 | player1, 37 | player2, 38 | "e4 e5 Na3 Qh4 b3 Bc5 Bc4".split(" ") 39 | ) 40 | playOff.play(9) 41 | t.equal(playOff.score(player1), 0, "white lose checkmate") 42 | t.equal(playOff.score(player2), 1, "black win checkmate") 43 | t.end() 44 | }) 45 | 46 | const stalemate = 47 | "e3 a5 Qh5 Ra6 Qxa5 h5 h4 Rah6 Qxc7 f6 Qxd7+ Kf7 Qxb7 Qd3 Qxb8 Qh7 Qxc8".split( 48 | " " 49 | ) 50 | 51 | test("playOff white stalemate", function (t) { 52 | const playOff = new PlayOff( 53 | { 54 | getNextMove() { 55 | return "Qe6" 56 | }, 57 | }, 58 | { 59 | getNextMove() { 60 | return "Kg6" 61 | }, 62 | }, 63 | stalemate 64 | ) 65 | playOff.play(20) 66 | t.equal(playOff.score(player1), 0.5, "white played stalemate") 67 | t.end() 68 | }) 69 | 70 | test("adjudicate for black", function (t) { 71 | const playOff = new PlayOff(player1, player2, "e4 Nf6 Qh5 Nxh5".split(" ")) 72 | playOff.adjudicate() 73 | t.equal(playOff.score(player1), 0, "white down a queen") 74 | t.equal(playOff.score(player2), 1, "black up a queen") 75 | t.end() 76 | }) 77 | 78 | test("adjudicate for white", function (t) { 79 | const playOff = new PlayOff(player1, player2, "d3 Nh6 Bxh6".split(" ")) 80 | playOff.adjudicate() 81 | t.equal(playOff.score(player1), 1, "white up a knight") 82 | t.equal(playOff.score(player2), 0, "black down a knight") 83 | t.end() 84 | }) 85 | -------------------------------------------------------------------------------- /test/TestRandomPlayer.js: -------------------------------------------------------------------------------- 1 | const test = require("tape") 2 | const RandomPlayer = require("../src/bots/RandomPlayer") 3 | 4 | const player = new RandomPlayer() 5 | 6 | test("getReply", function (t) { 7 | t.equal(player.getReply({}), "hi", "says hi") 8 | t.end() 9 | }) 10 | 11 | test("getNextMove", function (t) { 12 | t.ok(player.getNextMove([]), "move played from initial position") 13 | t.notOk( 14 | player.getNextMove([ 15 | "e2e4", 16 | "a7a6", 17 | "f1c4", 18 | "a8a7", 19 | "d1h5", 20 | "a7a8", 21 | "c4f7", 22 | ]), 23 | "no moves available" 24 | ) 25 | t.end() 26 | }) 27 | -------------------------------------------------------------------------------- /test/TestSwarmKingPlayer.js: -------------------------------------------------------------------------------- 1 | const test = require("tape") 2 | const SwarmKingPlayer = require("../src/bots/SwarmKingPlayer") 3 | const ChessUtils = require("../src/utils/ChessUtils") 4 | 5 | const player = new SwarmKingPlayer() 6 | const chess = new ChessUtils() 7 | 8 | test("getReply", function (t) { 9 | t.equal(player.getReply({}), "swarm the king!", "chat says swarm the king!") 10 | t.end() 11 | }) 12 | 13 | test("getNextMove", function (t) { 14 | const mate = player.getNextMove([ 15 | "e2e4", 16 | "a7a6", 17 | "f1c4", 18 | "a8a7", 19 | "d1h5", 20 | "a7a8", 21 | ]) 22 | t.ok(mate === "h5f7" || mate === "c4f7", "mate is played when available") 23 | t.equal( 24 | player.getNextMove(["e2e4", "a7a6", "f1c4", "a8a7"]), 25 | "c4f7", 26 | "check is played when available" 27 | ) 28 | t.ok(player.getNextMove([]), "a move is played when available") 29 | t.notOk( 30 | player.getNextMove([ 31 | "e2e4", 32 | "a7a6", 33 | "f1c4", 34 | "a8a7", 35 | "d1h5", 36 | "a7a8", 37 | "c4f7", 38 | ]), 39 | "no moves available" 40 | ) 41 | t.end() 42 | }) 43 | 44 | test("distanceMetric", function (t) { 45 | chess.reset() 46 | const colour = chess.turn() 47 | const opponentsKingSquare = chess.squareOfOpponentsKing() 48 | t.equals( 49 | player.distanceMetric(chess, opponentsKingSquare, colour), 50 | 120, 51 | "distance to king metric is 120" 52 | ) 53 | chess.applyMoves(["e2e4"]) 54 | t.equals( 55 | player.distanceMetric(chess, opponentsKingSquare, colour), 56 | 122, 57 | "distance to king metric is 122" 58 | ) 59 | chess.applyMoves(["a7a6"]) 60 | t.equals( 61 | player.distanceMetric(chess, opponentsKingSquare, colour), 62 | 122, 63 | "distance to king invariant to opponents move" 64 | ) 65 | t.end() 66 | }) 67 | 68 | test("removeReverseMoves", function (t) { 69 | chess.reset() 70 | chess.applyMoves(["g1f3", "a7a6"]) 71 | const legalMoves = chess.legalMoves() 72 | const noReverse = player.removeReverseMoves(["g1f3", "a7a6"], legalMoves) 73 | t.equals(noReverse.length, legalMoves.length - 1, "reverse move removed") 74 | t.end() 75 | }) 76 | -------------------------------------------------------------------------------- /test/TestTournament.js: -------------------------------------------------------------------------------- 1 | const test = require("tape") 2 | 3 | const Tournament = require("../src/tournament/Tournament") 4 | const RandomPlayer = require("../src/bots/RandomPlayer") 5 | 6 | const player1 = new RandomPlayer() 7 | const player2 = new RandomPlayer() 8 | 9 | test("Tournament starts at zero", function (t) { 10 | const tournament = new Tournament([player1, player2], 2) 11 | t.deepEqual(tournament.getScores(), [0, 0], "scores starts at [0,0]") 12 | tournament.playRound() 13 | t.deepEqual( 14 | tournament.getScores(), 15 | [1, 1], 16 | "scores after 2 rounds of draws is [1,1]" 17 | ) 18 | t.equal(tournament.getRank().length, 2, "two players ranked") 19 | t.end() 20 | }) 21 | --------------------------------------------------------------------------------