├── .gitignore ├── LICENSE ├── README.md ├── collections.go ├── go-sweep ├── go-sweep-ascii.gif ├── go-sweep.gif ├── go.mod ├── go.sum ├── main.go └── model.go /.gitignore: -------------------------------------------------------------------------------- 1 | # If you prefer the allow list template instead of the deny list, see community template: 2 | # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore 3 | # 4 | # Binaries for programs and plugins 5 | *.exe 6 | *.exe~ 7 | *.dll 8 | *.so 9 | *.dylib 10 | 11 | # Test binary, built with `go test -c` 12 | *.test 13 | 14 | # Output of the go coverage tool, specifically when used with LiteIDE 15 | *.out 16 | 17 | # Dependency directories (remove the comment below to include it) 18 | # vendor/ 19 | 20 | # Go workspace file 21 | go.work 22 | -------------------------------------------------------------------------------- /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 | # go-sweep: Minesweeper in your terminal 2 | 3 | I needed to learn go in preparation for advent of code this year, so I thought I would make one of my favorite games using go! I also wanted to learn how to make terminal UI apps, so I opted to use the [bubbletea tui framework](https://github.com/charmbracelet/bubbletea) to accomplish that. For future reference, this whole project took about 3 nights to accomplish. 4 | 5 | ## To Install and Run 6 | 1. Make sure your $GOPATH is set 7 | 1. `go install github.com/maxpaulus43/go-sweep@latest` 8 | 1. `go-sweep` 9 | 10 | ## Demo 11 | 12 | ### emoji view 13 | 14 | ![go-sweep gif](./go-sweep.gif) 15 | 16 | ### ascii view 17 | 18 | ![go-sweep ascii gif](./go-sweep-ascii.gif) 19 | 20 | ## To Run 21 | 22 | 1. `go build .` 23 | 2. `./go-sweep` 24 | 25 | ### Options 26 | 27 | - `-w 30`: width of the minefield. default 30 28 | - `-h 30`: height of the minefield. default 30 29 | - `-n 90`: number of mines. default 99 30 | - `-e`: use emoji characters instead. by default, uses ascii to render cells 31 | 32 | Please feel free to make an issue if you find any problems with the game! Sweep on! 33 | -------------------------------------------------------------------------------- /collections.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | type stack[T comparable] []T 4 | 5 | func (s *stack[T]) pop() T { 6 | tmp := (*s)[len(*s)-1] 7 | *s = (*s)[:len(*s)-1] 8 | return tmp 9 | } 10 | func (s *stack[T]) push(elem T) { 11 | *s = append(*s, elem) 12 | } 13 | func (s stack[T]) peek() T { 14 | return s[len(s)-1] 15 | } 16 | 17 | type set[T comparable] map[T]struct{} 18 | 19 | func (s set[T]) has(value T) bool { 20 | _, ok := s[value] 21 | return ok 22 | } 23 | func (s *set[T]) add(value T) { 24 | (*s)[value] = struct{}{} 25 | } 26 | func (s *set[T]) remove(value T) { 27 | delete(*s, value) 28 | } 29 | func (s set[T]) intersection(otherSet set[T]) []T { 30 | result := make([]T, 0) 31 | for v := range s { 32 | if otherSet.has(v) { 33 | result = append(result, v) 34 | } 35 | } 36 | return result 37 | } 38 | -------------------------------------------------------------------------------- /go-sweep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/maxpaulus43/go-sweep/06c04302bdc2545d88c4f7c9934be6f29d9bab3f/go-sweep -------------------------------------------------------------------------------- /go-sweep-ascii.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/maxpaulus43/go-sweep/06c04302bdc2545d88c4f7c9934be6f29d9bab3f/go-sweep-ascii.gif -------------------------------------------------------------------------------- /go-sweep.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/maxpaulus43/go-sweep/06c04302bdc2545d88c4f7c9934be6f29d9bab3f/go-sweep.gif -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/maxpaulus43/go-sweep 2 | 3 | go 1.20 4 | 5 | require ( 6 | github.com/charmbracelet/bubbletea v0.24.2 7 | github.com/charmbracelet/lipgloss v0.9.1 8 | ) 9 | 10 | require ( 11 | github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect 12 | github.com/containerd/console v1.0.4-0.20230313162750-1ae8d489ac81 // indirect 13 | github.com/lucasb-eyer/go-colorful v1.2.0 // indirect 14 | github.com/mattn/go-isatty v0.0.18 // indirect 15 | github.com/mattn/go-localereader v0.0.1 // indirect 16 | github.com/mattn/go-runewidth v0.0.15 // indirect 17 | github.com/muesli/ansi v0.0.0-20211018074035-2e021307bc4b // indirect 18 | github.com/muesli/cancelreader v0.2.2 // indirect 19 | github.com/muesli/reflow v0.3.0 // indirect 20 | github.com/muesli/termenv v0.15.2 // indirect 21 | github.com/rivo/uniseg v0.2.0 // indirect 22 | golang.org/x/sync v0.1.0 // indirect 23 | golang.org/x/sys v0.12.0 // indirect 24 | golang.org/x/term v0.6.0 // indirect 25 | golang.org/x/text v0.3.8 // indirect 26 | ) 27 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k= 2 | github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8= 3 | github.com/charmbracelet/bubbletea v0.24.2 h1:uaQIKx9Ai6Gdh5zpTbGiWpytMU+CfsPp06RaW2cx/SY= 4 | github.com/charmbracelet/bubbletea v0.24.2/go.mod h1:XdrNrV4J8GiyshTtx3DNuYkR1FDaJmO3l2nejekbsgg= 5 | github.com/charmbracelet/lipgloss v0.9.1 h1:PNyd3jvaJbg4jRHKWXnCj1akQm4rh8dbEzN1p/u1KWg= 6 | github.com/charmbracelet/lipgloss v0.9.1/go.mod h1:1mPmG4cxScwUQALAAnacHaigiiHB9Pmr+v1VEawJl6I= 7 | github.com/containerd/console v1.0.4-0.20230313162750-1ae8d489ac81 h1:q2hJAaP1k2wIvVRd/hEHD7lacgqrCPS+k8g1MndzfWY= 8 | github.com/containerd/console v1.0.4-0.20230313162750-1ae8d489ac81/go.mod h1:YynlIjWYF8myEu6sdkwKIvGQq+cOckRm6So2avqoYAk= 9 | github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= 10 | github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= 11 | github.com/mattn/go-isatty v0.0.18 h1:DOKFKCQ7FNG2L1rbrmstDN4QVRdS89Nkh85u68Uwp98= 12 | github.com/mattn/go-isatty v0.0.18/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= 13 | github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4= 14 | github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88= 15 | github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= 16 | github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZgg3U= 17 | github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= 18 | github.com/muesli/ansi v0.0.0-20211018074035-2e021307bc4b h1:1XF24mVaiu7u+CFywTdcDo2ie1pzzhwjt6RHqzpMU34= 19 | github.com/muesli/ansi v0.0.0-20211018074035-2e021307bc4b/go.mod h1:fQuZ0gauxyBcmsdE3ZT4NasjaRdxmbCS0jRHsrWu3Ho= 20 | github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA= 21 | github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo= 22 | github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s= 23 | github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8= 24 | github.com/muesli/termenv v0.15.2 h1:GohcuySI0QmI3wN8Ok9PtKGkgkFIk7y6Vpb5PvrY+Wo= 25 | github.com/muesli/termenv v0.15.2/go.mod h1:Epx+iuz8sNs7mNKhxzH4fWXGNpZwUaJKRS1noLXviQ8= 26 | github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= 27 | github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY= 28 | github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= 29 | golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o= 30 | golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 31 | golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 32 | golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 33 | golang.org/x/sys v0.12.0 h1:CM0HF96J0hcLAwsHPJZjfdNzs0gftsLfgKt57wWHJ0o= 34 | golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 35 | golang.org/x/term v0.6.0 h1:clScbb1cHjoCkyRbWwBEUZ5H/tIFu5TAXIqaZD0Gcjw= 36 | golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U= 37 | golang.org/x/text v0.3.8 h1:nAL+RVCQ9uMn3vJZbV+MRnydTJFPf8qqY42YiA6MrqY= 38 | golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ= 39 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | "math/rand" 7 | "os" 8 | "strings" 9 | "time" 10 | 11 | tea "github.com/charmbracelet/bubbletea" 12 | "github.com/charmbracelet/lipgloss" 13 | "github.com/charmbracelet/lipgloss/table" 14 | ) 15 | 16 | const ( 17 | DEFAULT_WIDTH = 30 18 | DEFAULT_HEIGHT = 30 19 | DEFAULT_MINES = 99 20 | ) 21 | 22 | var wFlag, hFlag, numMinesFlag int 23 | var shouldUseEmoji bool 24 | 25 | func main() { 26 | flag.IntVar(&wFlag, "w", DEFAULT_WIDTH, "minefield width") 27 | flag.IntVar(&hFlag, "h", DEFAULT_HEIGHT, "minefield height") 28 | flag.IntVar(&numMinesFlag, "n", DEFAULT_MINES, "number of mines") 29 | flag.BoolVar(&shouldUseEmoji, "e", false, "use emoji characters") 30 | 31 | flag.Parse() 32 | 33 | m := initialModel(wFlag, hFlag, numMinesFlag, shouldUseEmoji) 34 | p := tea.NewProgram(m) 35 | if _, err := p.Run(); err != nil { 36 | fmt.Printf("There's been an error: %v", err) 37 | os.Exit(1) 38 | } 39 | } 40 | 41 | func initialModel(width int, height int, numMines int, shouldUseEmoji bool) model { 42 | positions := make(stack[point], 0, width*height) 43 | minefield := make([][]cell, height) 44 | 45 | for y := range minefield { 46 | minefield[y] = make([]cell, width) 47 | for x := range minefield[y] { 48 | minefield[y][x] = cell{} 49 | positions.push(point{x: x, y: y}) 50 | } 51 | } 52 | 53 | // TODO instantiate the mines after the first sweep to make sure first 54 | // click never hits a mine 55 | r := rand.New(rand.NewSource(time.Now().UnixNano())) 56 | r.Shuffle(len(positions), func(i, j int) { 57 | positions[i], positions[j] = positions[j], positions[i] 58 | }) 59 | numMines = min(numMines, width*height) 60 | for i := 0; i < numMines && i < width*height; i++ { 61 | p := positions.pop() 62 | minefield[p.y][p.x].isMine = true 63 | } 64 | 65 | return model{ 66 | prefs: preferences{ 67 | width: width, 68 | height: height, 69 | numberOfMines: numMines, 70 | showHelp: true, 71 | shouldUseEmoji: shouldUseEmoji, 72 | }, 73 | minefield: minefield, 74 | cursorX: width/2 - 1, 75 | cursorY: height/2 - 1, 76 | } 77 | } 78 | 79 | type tickMsg struct{} 80 | 81 | func (m model) Init() tea.Cmd { 82 | return tick() 83 | } 84 | 85 | func tick() tea.Cmd { 86 | return func() tea.Msg { 87 | time.Sleep(1 * time.Second) 88 | return tickMsg{} 89 | } 90 | } 91 | 92 | func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) { 93 | 94 | cursorMine := &m.minefield[m.cursorY][m.cursorX] 95 | 96 | switch msg := msg.(type) { 97 | case tickMsg: 98 | if m.isGameOver { 99 | break 100 | } 101 | m.secondsElapsed++ 102 | return m, tick() 103 | case tea.KeyMsg: 104 | switch msg.String() { 105 | case "ctrl+c", "q": 106 | return m, tea.Quit 107 | case "up", "k": 108 | m.cursorY-- 109 | if m.cursorY < 0 { 110 | m.cursorY = m.prefs.height - 1 111 | } 112 | case "down", "j": 113 | m.cursorY++ 114 | if m.cursorY > m.prefs.height-1 { 115 | m.cursorY = 0 116 | } 117 | case "left", "h": 118 | m.cursorX-- 119 | if m.cursorX < 0 { 120 | m.cursorX = m.prefs.width - 1 121 | } 122 | case "right", "l": 123 | m.cursorX++ 124 | if m.cursorX > m.prefs.width-1 { 125 | m.cursorX = 0 126 | } 127 | case "r": 128 | isDebug := m.prefs.isDebug 129 | y, x := m.cursorY, m.cursorX 130 | showHelp := m.prefs.showHelp 131 | isEmoji := m.prefs.shouldUseEmoji 132 | m = initialModel(wFlag, hFlag, numMinesFlag, isEmoji) 133 | m.prefs.isDebug = isDebug 134 | m.cursorY, m.cursorX = y, x 135 | m.prefs.showHelp = showHelp 136 | break 137 | case "enter", " ": 138 | if m.isGameOver { 139 | break 140 | } 141 | sweep(m.cursorX, m.cursorY, &m, true, make(set[point])) 142 | if checkDidWin(m) { 143 | m.isGameOver = true 144 | } 145 | case "f": 146 | if m.isGameOver { 147 | break 148 | } 149 | if cursorMine.isRevealed { 150 | sweep(m.cursorX, m.cursorY, &m, true, make(set[point])) 151 | } else { 152 | cursorMine.isFlagged = !cursorMine.isFlagged 153 | } 154 | case "d": 155 | m.prefs.isDebug = !m.prefs.isDebug 156 | case "?": 157 | m.prefs.showHelp = !m.prefs.showHelp 158 | case "e": 159 | m.prefs.shouldUseEmoji = !m.prefs.shouldUseEmoji 160 | } 161 | } 162 | 163 | return m, nil 164 | } 165 | 166 | func (m model) View() string { 167 | var sb strings.Builder 168 | writeHeader(&sb, m) 169 | sb.WriteString("\n\n") 170 | if m.prefs.shouldUseEmoji { 171 | writeMinefield(&sb, m) 172 | } else { 173 | writeAsciiMinefield(&sb, m) 174 | } 175 | sb.WriteString("\n\n") 176 | writeHelp(&sb, m) 177 | return sb.String() 178 | } 179 | 180 | func writeHeader(sb *strings.Builder, m model) { 181 | if m.isGameOver { 182 | sb.WriteString("Game Over! ") 183 | if checkDidWin(m) { 184 | sb.WriteString("You WON!!") 185 | } else { 186 | sb.WriteString("You lost...") 187 | } 188 | } else { 189 | sb.WriteString("...go sweep...") 190 | sb.WriteString(fmt.Sprintf("\n%v mines left", minesLeft(m))) 191 | } 192 | sb.WriteString(fmt.Sprintf("\n%v seconds elapsed", m.secondsElapsed)) 193 | } 194 | 195 | func writeMinefield(sb *strings.Builder, m model) { 196 | for y, row := range m.minefield { 197 | for x, mine := range row { 198 | switch { 199 | case x == m.cursorX && y == m.cursorY: 200 | sb.WriteString("🔳") 201 | case (m.isGameOver || m.prefs.isDebug) && mine.isMine: 202 | sb.WriteString("💣") 203 | case mine.isRevealed: 204 | sb.WriteString(viewForMineAtPosition(x, y, m)) 205 | case mine.isFlagged: 206 | sb.WriteString("🟨") 207 | default: 208 | sb.WriteString("⬜️") 209 | } 210 | } 211 | sb.WriteString("\n") 212 | } 213 | } 214 | 215 | func writeAsciiMinefield(sb *strings.Builder, m model) { 216 | strs := make([][]string, m.prefs.height) 217 | for y, row := range m.minefield { 218 | strs[y] = make([]string, m.prefs.width) 219 | for x, mine := range row { 220 | switch { 221 | case x == m.cursorX && y == m.cursorY: 222 | strs[y][x] = "*" 223 | case (m.isGameOver || m.prefs.isDebug) && mine.isMine: 224 | strs[y][x] = "B" 225 | case mine.isRevealed: 226 | strs[y][x] = asciiViewForMineAtPosition(x, y, m) 227 | case mine.isFlagged: 228 | strs[y][x] = "F" 229 | default: 230 | strs[y][x] = " " 231 | } 232 | } 233 | } 234 | t := table.New(). 235 | Border(lipgloss.NormalBorder()). 236 | BorderRow(true). 237 | BorderColumn(true). 238 | Rows(strs...). 239 | StyleFunc(func(row, col int) lipgloss.Style { 240 | var fg lipgloss.TerminalColor = lipgloss.NoColor{} 241 | var bg lipgloss.TerminalColor = lipgloss.NoColor{} 242 | 243 | switch strs[row-1][col] { 244 | case "0": 245 | fg = lipgloss.Color("#292929") 246 | case "1": 247 | fg = lipgloss.Color("#74adf2") 248 | case "2": 249 | fg = lipgloss.Color("#00FF00") 250 | case "3": 251 | fg = lipgloss.Color("#FF0000") 252 | case "4": 253 | fg = lipgloss.Color("#28706d") 254 | case "5": 255 | fg = lipgloss.Color("#b06446") 256 | case "6": 257 | fg = lipgloss.Color("#FF0000") 258 | case "7": 259 | fg = lipgloss.Color("#8a7101") 260 | case "8": 261 | fg = lipgloss.Color("#111") 262 | bg = lipgloss.Color("#bfbfbf") 263 | case "*": 264 | fg = lipgloss.Color("#FF33FF") 265 | case "F": 266 | bg = lipgloss.Color("#ffee00") 267 | fg = lipgloss.Color("#111") 268 | case "B": 269 | bg = lipgloss.Color("#FF0000") 270 | fg = lipgloss.Color("#111") 271 | case " ": 272 | bg = lipgloss.Color("#bfbfbf") 273 | } 274 | 275 | return lipgloss.NewStyle(). 276 | Foreground(fg). 277 | Background(bg). 278 | Padding(0, 1) 279 | }) 280 | sb.WriteString(t.Render()) 281 | } 282 | 283 | func writeHelp(sb *strings.Builder, m model) { 284 | if m.prefs.showHelp { 285 | if !m.isGameOver { 286 | sb.WriteString("Press h/j/k/l or ←↓↑→ to move\n") 287 | sb.WriteString("Press enter or space to sweep\n") 288 | sb.WriteString("Press f to toggle flag.\n") 289 | sb.WriteString("Press d to toggle debug.\n") 290 | } 291 | sb.WriteString("Press q to quit.\n") 292 | sb.WriteString("Press r to start a new game.\n") 293 | sb.WriteString("Press ? to toggle help text\n") 294 | sb.WriteString("Press a to toggle ascii view\n") 295 | } 296 | } 297 | 298 | func sweep(x, y int, m *model, userInitiatedSweep bool, swept set[point]) { 299 | cell := &m.minefield[y][x] 300 | 301 | if cell.isRevealed && userInitiatedSweep { 302 | adjMines := countAdjacentMines(x, y, *m) 303 | adjFlags := countAdjacentFlags(x, y, *m) 304 | if adjFlags >= adjMines { 305 | autoSweep(x, y, m) 306 | } 307 | return 308 | } 309 | 310 | if cell.isMine { 311 | if userInitiatedSweep { 312 | m.isGameOver = true 313 | } 314 | return 315 | } 316 | 317 | touching := countAdjacentMines(x, y, *m) 318 | 319 | p := point{x: x, y: y} 320 | if touching == 0 && !swept.has(p) { 321 | swept.add(p) 322 | forEachSurroundingCellDo(x, y, m, func(x, y int, m *model) { 323 | sweep(x, y, m, false, swept) 324 | }) 325 | } 326 | 327 | cell.isRevealed = true 328 | } 329 | 330 | func minesLeft(m model) int { 331 | flags := 0 332 | for y := range m.minefield { 333 | for _, mine := range m.minefield[y] { 334 | if mine.isFlagged && !mine.isRevealed { 335 | flags++ 336 | } 337 | } 338 | } 339 | return m.prefs.numberOfMines - flags 340 | } 341 | 342 | func checkDidWin(m model) bool { 343 | for y := range m.minefield { 344 | for _, mine := range m.minefield[y] { 345 | if !mine.isMine && !mine.isRevealed { 346 | return false 347 | } 348 | } 349 | } 350 | return true 351 | } 352 | 353 | func asciiViewForMineAtPosition(x, y int, m model) string { 354 | if m.minefield[y][x].isMine { 355 | return "B" 356 | } 357 | return fmt.Sprint(countAdjacentMines(x, y, m)) 358 | } 359 | 360 | func viewForMineAtPosition(x, y int, m model) string { 361 | if m.minefield[y][x].isMine { 362 | return "💣" 363 | } 364 | touching := countAdjacentMines(x, y, m) 365 | numViewMap := map[int]string{ 366 | 0: "⬛️", 367 | 1: "1️⃣", 368 | 2: "2️⃣", 369 | 3: "3️⃣", 370 | 4: "4️⃣", 371 | 5: "5️⃣", 372 | 6: "6️⃣", 373 | 7: "7️⃣", 374 | 8: "8️⃣", 375 | } 376 | return numViewMap[touching] 377 | } 378 | 379 | func forEachSurroundingCellDo(x, y int, m *model, do func(x, y int, m *model)) { 380 | w := m.prefs.width 381 | h := m.prefs.height 382 | for dx := -1; dx <= 1; dx++ { 383 | for dy := -1; dy <= 1; dy++ { 384 | if (dx == 0 && dy == 0) || x+dx < 0 || x+dx > w-1 || y+dy < 0 || y+dy > h-1 { 385 | continue 386 | } 387 | do(x+dx, y+dy, m) 388 | } 389 | } 390 | } 391 | 392 | func autoSweep(x, y int, m *model) { 393 | forEachSurroundingCellDo(x, y, m, func(x, y int, m *model) { 394 | cell := m.minefield[y][x] 395 | if !cell.isRevealed && !cell.isFlagged { 396 | sweep(x, y, m, true, make(set[point])) 397 | } 398 | }) 399 | } 400 | 401 | func countAdjacentFlags(x, y int, m model) int { 402 | adj := 0 403 | forEachSurroundingCellDo(x, y, &m, func(x, y int, m *model) { 404 | if m.minefield[y][x].isFlagged { 405 | adj++ 406 | } 407 | }) 408 | return adj 409 | } 410 | 411 | func countAdjacentMines(x, y int, m model) int { 412 | adj := 0 413 | forEachSurroundingCellDo(x, y, &m, func(x, y int, m *model) { 414 | if m.minefield[y][x].isMine { 415 | adj++ 416 | } 417 | }) 418 | return adj 419 | } 420 | 421 | func min(x, y int) int { 422 | if x < y { 423 | return x 424 | } else { 425 | return y 426 | } 427 | } 428 | -------------------------------------------------------------------------------- /model.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | type model struct { 4 | prefs preferences 5 | minefield [][]cell 6 | cursorX int 7 | cursorY int 8 | isGameOver bool 9 | secondsElapsed int 10 | } 11 | 12 | type preferences struct { 13 | width int 14 | height int 15 | numberOfMines int 16 | isDebug bool 17 | showHelp bool 18 | shouldUseEmoji bool 19 | } 20 | 21 | type cell struct { 22 | isMine bool 23 | isFlagged bool 24 | isRevealed bool 25 | } 26 | 27 | type point struct { 28 | x int 29 | y int 30 | } 31 | --------------------------------------------------------------------------------