├── .github └── FUNDING.yml ├── .gitignore ├── LICENSE ├── README.md ├── build-win.bat ├── download.py ├── gog-plugins.bat ├── plugins.yaml ├── requirements.txt └── update-plugin-manifest.py /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | ko_fi: slashbunny 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | 106 | # Testing output directory 107 | output/ 108 | 109 | # Test script to download all plugins 110 | download-all.sh 111 | -------------------------------------------------------------------------------- /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 | # GOG Galaxy Plugins Downloader 2 | 3 | ## Summary 4 | 5 | This program downloads GOG Galaxy 2.0 Plugins and installs them to the proper location. 6 | 7 | You _probably_ do not want to use this software anymore. 8 | 9 | As of the Galaxy 2.0 Euporie update, released November 19th, 2019, the GOG Galaxy 10 | client automatically downloads and updates plugins from within the Integrations 11 | screens. You should install plugins using GOG Galaxy itself, not this software. 12 | 13 | However, not all plugins are available from the GOG Galaxy interface. If you are 14 | interested in those other plugins, this program may be beneficial to you. 15 | 16 | The plugins are from Mixaill's excellent [Awesome GOG Galaxy](https://github.com/Mixaill/awesome-gog-galaxy) 17 | repository. If you'd like to see a plugin included in this program, please 18 | request it be added to that project _first_. 19 | 20 | # Usage 21 | 22 | This section is meant for Windows users only. If you are using another OS, 23 | you will need to follow the Advanced instructions below. 24 | 25 | * Download the latest release from the [Releases](https://github.com/Slashbunny/gog-galaxy-plugin-downloader/releases) page. 26 | * Extract the zip file anywhere on your PC. 27 | * Within the zip file, there is a single executable: 28 | * `gog-plugins-downloader.exe`: Downloads and installs all Friends of Galaxy plugins 29 | * If you want to install other plugins, you'll need to create a `.bat` file with the plugins you are interested in (see "Customizing the list..." section below) 30 | * Run the program regularly to keep your plugins up to date 31 | 32 | ## Install through Scoop 33 | 34 | Alternatively, on Windows, [Scoop](https://scoop.sh/) package manager can be used to install and update this tool: 35 | 36 | ``` 37 | scoop bucket add extras 38 | scoop install gog-galaxy-plugin-downloader 39 | ``` 40 | 41 | ## Customizing the list of plugins being downloaded 42 | 43 | If you want to download a specific set of plugins, refer to the `gog-plugins.bat` file that comes with the 44 | release. Open it in Notepad. Plugins are specified via a comma-separated list, using the `-p` flag. For example: 45 | 46 | ``` 47 | gog-plugins-downloader.exe -p steam,battlenet,humblebundle,ffxiv,gw2,minecraft,poe,snes,nes 48 | ``` 49 | 50 | For a full list of available plugin names, view the [plugins.yaml](https://github.com/Slashbunny/gog-galaxy-plugin-downloader/blob/master/plugins.yaml) file in this repository. 51 | Change the list in the `.bat` file to include the plugins you want to install or update. 52 | Save the `.bat` file. Double click on the `.bat` file to install or update your plugins. 53 | 54 | # Advanced Usage 55 | 56 | ## Requirements 57 | 58 | Install Python 3 on your OS. Clone or [download](https://github.com/Slashbunny/gog-galaxy-plugin-downloader/archive/master.zip), 59 | then extract this repository into a directory of your choice. 60 | 61 | ## Running the Program 62 | 63 | Open a command line terminal and navigate to the directory where you downloaded 64 | or cloned this repository. In this example, it was extracted to a folder on the 65 | Desktop. 66 | 67 | ``` 68 | cd Desktop\gog-galaxy-plugin-downloader-master 69 | ``` 70 | 71 | Next, install python dependencies: 72 | 73 | ``` 74 | pip install -r requirements.txt 75 | ``` 76 | 77 | To download default plugins to Galaxy's "installed" directory on Windows (`%localappdata%\GOG.com\Galaxy\plugins\installed`): 78 | 79 | ``` 80 | python download.py 81 | ``` 82 | 83 | ### List Available Plugins 84 | 85 | ``` 86 | python download.py -l 87 | ``` 88 | 89 | ## Custom Parameters 90 | 91 | ### Custom Output Directory 92 | 93 | You can download to a custom directory (This is required on non-Windows systems): 94 | 95 | ``` 96 | python download.py -d output-folder 97 | ``` 98 | 99 | For example, on MacOS, to install Store plugins to the default Galaxy plugins folder: 100 | 101 | ``` 102 | python download.py -d "${HOME}/Library/Application Support/GOG.com/Galaxy/plugins/installed/" 103 | ``` 104 | 105 | ### Custom Plugin Lists 106 | 107 | You can use your own local plugins YAML file like this: 108 | 109 | ``` 110 | python download.py -c plugins.yaml 111 | ``` 112 | 113 | Or use your own remote plugins YAML file hosted at any URL: 114 | 115 | ``` 116 | python download.py -c https://www.mydomain.com/gog-plugins.yaml 117 | ``` 118 | 119 | ### Filtering Plugins 120 | 121 | Rather than install all the plugins referenced in a `yaml` file, you can filter 122 | the list using the `-p` option: 123 | 124 | ``` 125 | python download.py -p battlenet,steam,rockstar,humblebundle 126 | ``` 127 | 128 | ## Building the Executable 129 | 130 | If you want to build the Windows executable, you can run the following batch 131 | files on a Windows PC: 132 | 133 | ``` 134 | build-win.bat 135 | ``` 136 | 137 | The `.exe` files will be in the `dist/` subfolder. 138 | -------------------------------------------------------------------------------- /build-win.bat: -------------------------------------------------------------------------------- 1 | pip install -r requirements.txt 2 | pip install -U pyinstaller 3 | pyinstaller.exe download.py -n gog-plugins-downloader --onefile 4 | COPY gog-plugins.bat dist\ 5 | -------------------------------------------------------------------------------- /download.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | import argparse 4 | import json 5 | import os 6 | import shutil 7 | import sys 8 | import tempfile 9 | import yaml 10 | import zipfile 11 | from io import BytesIO 12 | from filecmp import dircmp 13 | from string import Template 14 | from urllib.parse import urlparse 15 | from urllib.request import Request, urlopen 16 | from urllib.error import URLError 17 | 18 | __version__ = '0.2.3' 19 | 20 | # Base URL to plugins 21 | default_plugin_url = 'https://raw.githubusercontent.com/Slashbunny/' \ 22 | 'gog-galaxy-plugin-downloader/master/plugins.yaml' 23 | 24 | 25 | def get_plugin_config(config_uri): 26 | """ 27 | Downloads/opens configuration yaml file, returns 28 | dict of Galaxy plugins 29 | """ 30 | # Try to open the URI as a URL or fall back to opening local file 31 | try: 32 | config_uri_parsed = urlparse(config_uri) 33 | if config_uri_parsed.scheme in ['https', 'http']: 34 | url = urlopen(config_uri) 35 | yaml_data = url.read() 36 | else: 37 | with open(config_uri, 'r') as file_data: 38 | yaml_data = file_data.read() 39 | except URLError as e: 40 | print(e) 41 | 42 | # Parse the YAML configuration 43 | try: 44 | plugin_data = yaml.safe_load(yaml_data) 45 | 46 | return plugin_data['plugins'] 47 | except yaml.YAMLError as e: 48 | print(e) 49 | 50 | 51 | def list_plugins(plugin_data): 52 | """ 53 | Outputs known plugins, along with whether or not they are marked as default 54 | """ 55 | print('Available plugins:') 56 | 57 | for name, data in plugin_data.items(): 58 | print(name, end='') 59 | 60 | if 'default' in data and data['default'] is True: 61 | print(' [default]') 62 | else: 63 | print() 64 | 65 | 66 | def filter_plugins(plugin_data, selected_plugins): 67 | """ 68 | Takes the full set of plugin data and filters out only the plugins the 69 | user selected. 70 | 71 | If the user did not specify a list of plugins, it enables all the default 72 | plugins 73 | """ 74 | # No plugins selected- remove all plugins not marked as "default" 75 | if selected_plugins is None: 76 | for name, data in list(plugin_data.items()): 77 | if 'default' not in data or data['default'] is not True: 78 | del plugin_data[name] 79 | # Plugin list provided at the command line 80 | else: 81 | selected_plugins = selected_plugins.split(',') 82 | # Ensure each selected plugin actually exists to point out errors 83 | for name in selected_plugins: 84 | if name not in plugin_data.keys(): 85 | print('ERROR: Unknown plugin specified: {}'.format(name)) 86 | sys.exit(1) 87 | # Remove any plugin not matching the providedlist 88 | for name, data in list(plugin_data.items()): 89 | if name not in selected_plugins: 90 | del plugin_data[name] 91 | 92 | return plugin_data 93 | 94 | 95 | def process_template_strings(data): 96 | """ 97 | Replaces $variables in strings with corresponding variables in plugin data 98 | """ 99 | for plugin_name, plugin_data in data.items(): 100 | version = plugin_data['version'] 101 | guid = plugin_data['guid'] 102 | 103 | for key, value in plugin_data.items(): 104 | if key == 'version': 105 | continue 106 | if not isinstance(value, str): 107 | continue 108 | 109 | # Replace references to $name and $version with the real values 110 | data[plugin_name][key] = Template(value).substitute( 111 | name=plugin_name, 112 | version=version, 113 | guid=guid) 114 | 115 | return data 116 | 117 | 118 | def fix_plugin_directories(dest): 119 | """ 120 | Loops through all folders in the output directory, reads the their manifest 121 | file, and renames the directory to the standard _ format 122 | """ 123 | # Loop through directories in the destination directory 124 | for existing_dir in os.listdir(dest): 125 | existing_path = os.path.join(dest, existing_dir) 126 | 127 | # Skip non-directories 128 | if not os.path.isdir(existing_path): 129 | continue 130 | 131 | try: 132 | with open(os.path.join(existing_path, 'manifest.json')) as m: 133 | data = json.load(m) 134 | platform = data['platform'] 135 | guid = data['guid'] 136 | 137 | # Close json file 138 | m.close() 139 | 140 | expected_dir = platform + '_' + guid 141 | expected_path = os.path.join(dest, expected_dir) 142 | 143 | if existing_path != expected_path: 144 | print('NOTICE: Folder should be "{}", but it is named "{}"' 145 | .format(expected_dir, existing_dir)) 146 | 147 | if os.path.isdir(expected_path): 148 | print('NOTICE: Correct pathed plugin already exists,' 149 | + ' deleting extra plugin') 150 | shutil.rmtree(existing_path) 151 | else: 152 | print('NOTICE: Renaming folder to proper name') 153 | shutil.move(existing_path, expected_path) 154 | except (FileNotFoundError, json.decoder.JSONDecodeError, KeyError): 155 | print('ERROR: Could not read plugin data from {} folder' 156 | .format(existing_path)) 157 | 158 | 159 | def download_plugins(data, dest): 160 | """ 161 | Downloads and extracts plugins 162 | 163 | If the destination directory already exists, the plugin is skipped 164 | """ 165 | for name, data in data.items(): 166 | version = data['version'] 167 | guid = data['guid'] 168 | url = data['url'] 169 | if 'archive_path' in data: 170 | archive_path = data['archive_path'] 171 | else: 172 | archive_path = None 173 | 174 | # Destination directory 175 | dest_dir = os.path.join(dest, name + '_' + guid) 176 | 177 | if os.path.isdir(dest_dir): 178 | # If destination path exists, check the version that is installed 179 | with open(os.path.join(dest_dir, 'manifest.json')) as m: 180 | data = json.load(m) 181 | existing_version = data['version'] 182 | 183 | # Close json file 184 | m.close() 185 | 186 | # Version already matches 187 | if version == existing_version: 188 | print('NOTICE: Skipping "{}" download, "{}" already exists' 189 | .format(name, version)) 190 | continue 191 | # Version does not match, delete old plugin and download 192 | else: 193 | shutil.rmtree(dest_dir) 194 | print('Upgrading {} plugin'.format(name)) 195 | 196 | # Passed Pre-Download Checks 197 | print('Downloading "{}" version "{}" ({})' 198 | .format(name, version, guid)) 199 | 200 | # Download zip file into memory 201 | req = Request(url) 202 | req.add_header('user-agent', 'gog-plugin-downloader/' + __version__) 203 | plugin_url = urlopen(req) 204 | plugin_zip = zipfile.ZipFile(BytesIO(plugin_url.read())) 205 | 206 | # Extract zip directly into destination if there are no sub-folders 207 | # to deal with 208 | if not archive_path: 209 | plugin_zip.extractall(path=dest_dir) 210 | else: 211 | # Create temporary directory for extraction 212 | tmp_dir = tempfile.TemporaryDirectory(prefix='galaxy-plugin') 213 | 214 | # Extract zip to temporary directory 215 | plugin_zip.extractall(path=tmp_dir.name) 216 | 217 | # Move sub-directory into final destination directory 218 | shutil.move(os.path.join(tmp_dir.name, archive_path), dest_dir) 219 | 220 | # Cleanup temporary directory 221 | tmp_dir.cleanup() 222 | 223 | def verify_plugins(data, dest): 224 | """ 225 | Verifies existing plugins (with version check) 226 | TODO: handle conflicts with old style plugin naming (no GUID) 227 | """ 228 | for name, data in data.items(): 229 | version = data['version'] 230 | guid = data['guid'] 231 | url = data['url'] 232 | if 'archive_path' in data: 233 | archive_path = data['archive_path'] 234 | else: 235 | archive_path = None 236 | 237 | # Destination directory 238 | dest_dir = os.path.join(dest, name + '_' + guid) 239 | 240 | if not os.path.isdir(dest_dir): 241 | # Skip if destination path does not exist 242 | print('NOTICE: Skipping "{}" download, does not exist locally' 243 | .format(name)) 244 | continue 245 | else: 246 | # Check the version that is installed 247 | with open(os.path.join(dest_dir, 'manifest.json')) as m: 248 | data = json.load(m) 249 | existing_version = data['version'] 250 | 251 | # Close json file 252 | m.close() 253 | 254 | # Version doesn't match 255 | if version != existing_version: 256 | print('NOTICE: Skipping "{}" download, different version (existing version: {}, manifest version: {}' 257 | .format(name, existing_version, version)) 258 | continue 259 | # Version matches, download 260 | else: 261 | print('Verifying {} plugin'.format(name)) 262 | 263 | # Passed Pre-Download Checks 264 | print('Downloading "{}" version "{}" ({}) for verification' 265 | .format(name, version, guid)) 266 | 267 | # Download zip file into memory 268 | req = Request(url) 269 | req.add_header('user-agent', 'gog-plugin-downloader/' + __version__) 270 | plugin_url = urlopen(req) 271 | plugin_zip = zipfile.ZipFile(BytesIO(plugin_url.read())) 272 | 273 | # Create temporary directory for extraction 274 | tmp_dir = tempfile.TemporaryDirectory(prefix='galaxy-plugin') 275 | 276 | # Extract zip to temporary directory 277 | plugin_zip.extractall(path=tmp_dir.name) 278 | 279 | # Compare temporary directory with plugin directory 280 | plugin_cmp = dircmp(os.path.join(tmp_dir.name, archive_path) if archive_path else tmp_dir.name, dest_dir) 281 | if plugin_cmp.diff_files: print('*** Differences found: {}'.format(plugin_cmp.diff_files)) 282 | 283 | # Cleanup temporary directory 284 | tmp_dir.cleanup() 285 | 286 | def delete_old_plugins(data, dest): 287 | """ 288 | Deletes versions of plugins that don't match the yaml manifest. In theory 289 | this should only be older versions, but any version that doesn't match 290 | the yaml definition will be deleted 291 | 292 | This explicitly does not touch other directories that do not match the 293 | known plugin names. 294 | 295 | If the version doesn't match the yaml definition, the directory is removed 296 | """ 297 | # Loop over each plugin 298 | for name, data in data.items(): 299 | expected_plugin_dir = name + '_' + data['guid'] 300 | 301 | # Loop through directories in the destination directory 302 | for item in os.listdir(dest): 303 | full_path = os.path.join(dest, item) 304 | 305 | # Skip non-directories 306 | if not os.path.isdir(full_path): 307 | continue 308 | 309 | # Skip directory names that are in the valid plugin directory array 310 | if item == expected_plugin_dir: 311 | continue 312 | 313 | # If any other directory begins with _, delete it 314 | if item.startswith(name + '_'): 315 | print('Deleting wrong version "{}" from "{}"' 316 | .format(item, dest)) 317 | shutil.rmtree(full_path) 318 | 319 | 320 | if __name__ == "__main__": 321 | """ 322 | Entry point to script 323 | 324 | - Parses command line arguments 325 | - Calls function to fetch/parse plugin config yaml file 326 | - Calls function to filter the plugin list 327 | - Calls function to download plugins 328 | - Calls function to delete old/invalid plugins 329 | """ 330 | # OS Default Settings 331 | if os.name == "nt": 332 | # Windows Defaults 333 | req_dest = False 334 | 335 | # Destination default: %LOCALAPPDATA%\GOG.com\Galaxy\plugins\installed\ 336 | plugins_dir = os.path.join(os.environ['localappdata'], 'GOG.com', 337 | 'Galaxy', 'plugins', 'installed') 338 | else: 339 | # Non-Windows Defaults 340 | req_dest = True 341 | plugins_dir = None 342 | 343 | # Define script arguments 344 | parser = argparse.ArgumentParser( 345 | description='GOG Galaxy Plugin Downloader') 346 | 347 | parser.add_argument('-d', '--dest', default=plugins_dir, required=req_dest, 348 | help='Destination directory for plugins') 349 | 350 | parser.add_argument('-c', '--conf', default=default_plugin_url, 351 | help='Path/URL to plugin configuration YAML file') 352 | 353 | parser.add_argument('-p', '--plugin-filter', 354 | help='Comma-separated list of plugins to update') 355 | 356 | parser.add_argument('-l', '--list', action='store_true', 357 | help='Output list of available plugins') 358 | 359 | parser.add_argument('-t', '--verify', action='store_true', 360 | help='Verify existing plugins against sources') 361 | 362 | parser.add_argument('--version', action='version', 363 | version='{}'.format(__version__)) 364 | 365 | # Parse arguments 366 | args = parser.parse_args() 367 | 368 | # Download/Load Plugin Data 369 | plugins = get_plugin_config(args.conf) 370 | 371 | # List plugins and exit 372 | if args.list is True: 373 | list_plugins(plugins) 374 | sys.exit(0) 375 | 376 | # Filter plugin data list to selected plugins or default plugins 377 | plugins = filter_plugins(plugins, args.plugin_filter) 378 | 379 | # Replace variables in templated strings 380 | plugins = process_template_strings(plugins) 381 | 382 | # Fix existing plugin directories 383 | fix_plugin_directories(args.dest) 384 | 385 | # Verify plugins and exit 386 | if args.verify is True: 387 | verify_plugins(plugins, args.dest) 388 | sys.exit(0) 389 | 390 | # Download plugins 391 | download_plugins(plugins, args.dest) 392 | 393 | # Delete old plugins 394 | delete_old_plugins(plugins, args.dest) 395 | -------------------------------------------------------------------------------- /gog-plugins.bat: -------------------------------------------------------------------------------- 1 | gog-plugins-downloader.exe -p ffxiv,twitch 2 | pause 3 | -------------------------------------------------------------------------------- /plugins.yaml: -------------------------------------------------------------------------------- 1 | # Plugins from: https://github.com/Mixaill/awesome-gog-galaxy 2 | plugins: 3 | # Community, Stores 4 | amazon: 5 | version: '0.5.2' 6 | guid: 'c2cd2e29-8b02-35a9-86fc-3faf90255857' 7 | url: 'https://github.com/Rall3n/galaxy-integration-amazon/releases/download/v${version}/windows.zip' 8 | battlenet: 9 | default: true 10 | version: '1.4.3' 11 | guid: 'ba170431-0649-482f-863b-d248592f1842' 12 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-blizzard/releases/download/1.4.3/windows.zip' 13 | bethesda: 14 | default: true 15 | version: '1.0.2' 16 | guid: 'cb57391f-1675-35b1-05c0-896d43bdf4f8' 17 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-bethesda/releases/download/1.0.2/windows.zip' 18 | discord: 19 | version: '0.1.1' 20 | guid: 'ce69028e-a7e4-462a-96d8-468259c298e2' 21 | url: 'https://github.com/Ertego/gog-galaxy-discord/archive/8e568f94a419011076d22f723dffdbac8145c3fb.zip' 22 | archive_path: 'gog-galaxy-discord-8e568f94a419011076d22f723dffdbac8145c3fb/' 23 | epic: 24 | default: true 25 | version: '0.49.1' 26 | guid: '24d5f405-7211-4198-83c4-50a6f63b1dcf' 27 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-epic/releases/download/v0.49.1/windows.zip' 28 | fanatical: 29 | version: '0.0.2' 30 | guid: 'f72d61b1-f2e2-4e46-98e0-c5f33cca34b8' 31 | url: 'https://github.com/nosyn00b/GOG2_Fanatical_Plugin/archive/7e5989e633fed91e4ca6b5029c8c6873b05bb8b7.zip' 32 | archive_path: 'GOG2_Fanatical_Plugin-7e5989e633fed91e4ca6b5029c8c6873b05bb8b7/src/' 33 | humble: 34 | default: true 35 | version: '0.11.0' 36 | guid: 'f0ca3d80-a432-4d35-a9e3-60f27161ac3a' 37 | url: 'https://github.com/UncleGoogle/galaxy-integration-humblebundle/releases/download/v0.11.0/humble_v0.11.0_win.zip' 38 | indiegala: 39 | version: '0.1.0' 40 | guid: 'a1a85742-f3e0-42ae-bde9-64ab7d0321cf' 41 | url: 'https://github.com/burnhamup/galaxy-integration-indiegala/releases/download/${version}/indiegala_v${version}.zip' 42 | itch: 43 | version: '0.4' 44 | guid: 'fd0effe6-77d9-42bc-999d-a5a5c870c2a4' 45 | url: 'https://github.com/Ertego/gog-galaxy-itch.io/releases/download/0.0.4/itch_0_0_4.zip' 46 | archive_path: 'itch/' 47 | origin: 48 | default: true 49 | version: '0.40' 50 | guid: '7f53219b-4e2b-4591-9f4f-dfc5f4ba9eb0' 51 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-origin/releases/download/v0.40/windows.zip' 52 | paradox: 53 | default: true 54 | version: '0.6.2' 55 | guid: 'bfa5a6c9-r0c3-5g28-b921-f4cd75d4999a' 56 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-paradox/releases/download/v0.6.2/windows.zip' 57 | psn: 58 | default: true 59 | version: '0.35' 60 | guid: '38087aea-3c30-439f-867d-ddf9fae8fe6f' 61 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-psn/releases/download/v0.35/windows.zip' 62 | riot: 63 | version: '0.2.5' 64 | guid: 'b4c0c2f5-23dc-4326-aa65-e9fabef61a3b' 65 | url: 'https://github.com/urwrstkn8mare/galaxy-riot-integration/releases/download/v${version}/riot_v${version}.zip' 66 | rockstar: 67 | default: true 68 | version: '0.5.15' 69 | guid: '774732b5-69c4-405c-b6c9-92cd55740cfe' 70 | url: 'https://github.com/tylerbrawl/Galaxy-Plugin-Rockstar/releases/download/v${version}/plugin.zip' 71 | archive_path: 'Rockstar/' 72 | steam: 73 | default: true 74 | version: '1.0.7' 75 | guid: 'ca27391f-2675-49b1-92c0-896d43afa4f8' 76 | url: 'https://github.com/ABaumher/galaxy-integration-steam/releases/download/v${version}/windows.zip' 77 | twitch: 78 | version: '0.5' 79 | guid: '8b831aed-dd5f-c0c5-c843-41f9751f67a2' 80 | url: 'https://github.com/nyash-qq/galaxy-plugin-twitch/releases/download/${version}/twitch_8b831aed-dd5f-c0c5-c843-41f9751f67a2_v${version}_win32.zip' 81 | uplay: 82 | default: true 83 | version: '0.55.5' 84 | guid: 'afb5a69c-b2ee-4d58-b916-f4cd75d4999a' 85 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-uplay/releases/download/v0.55.5/windows.zip' 86 | wargaming: 87 | default: true 88 | version: '0.9.8' 89 | guid: '91728e8a-33c3-4b6d-8382-4dd31043dec1' 90 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-wargaming/releases/download/0.9.8/windows.zip' 91 | # Community, Games 92 | egg: 93 | # Osu! Plugin 94 | version: '1.1.1' 95 | guid: '79764115-b455-4ff0-be13-a316c7c53dec' 96 | url: 'https://github.com/UncleGoogle/galaxy-integration-osu/releases/download/v${version}/osu_v${version}_win.zip' 97 | ffxiv: 98 | default: true 99 | version: '1.2.2' 100 | guid: '0a9eb0eb-812a-45a1-bc40-c1cd82195313' 101 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-ffxiv/releases/download/1.2.2/windows.zip' 102 | gw2: 103 | default: true 104 | version: '0.5.2' 105 | guid: '637b1fd4-b1d0-4de8-9bf6-757e639807f3' 106 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-gw2/releases/download/0.5.2/windows.zip' 107 | kartridge: 108 | version: '0.3.3' 109 | guid: '73d2c048-1ae7-46b2-ad4a-da16yc8ccecz' 110 | url: 'https://github.com/pippo-san/galaxy-integration-legacy-games/releases/download/v${version}/legacygames.zip' 111 | archive_path: 'legacygames/' 112 | minecraft: 113 | default: true 114 | version: '1.0.3' 115 | guid: 'cb57391f-1675-35b1-05c0-896d43bdf8f4' 116 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-minecraft/releases/download/1.0.3/windows.zip' 117 | pathofexile: 118 | default: true 119 | version: '0.4' 120 | guid: '52d06761-1c23-d725-9720-57ee0b8b14bc' 121 | url: 'https://github.com/FriendsOfGalaxy/galaxy-integration-pathofexile/releases/download/0.4/windows.zip' 122 | test: 123 | # thcrap Plugin (Patching Touhou Project Games) 124 | version: '0.1' 125 | guid: '8f44cd59-ca9a-4f0b-8f90-11cb3f39d265' 126 | url: 'https://gitlab.com/PookaMustard/thcrap-plugin-for-galaxy-2.0/-/archive/master/thcrap-plugin-for-galaxy-2.0-master.zip' 127 | archive_path: 'thcrap-plugin-for-galaxy-2.0-master/thcrap_galaxy_plugin_0.1_2/' 128 | # Community, Emulators 129 | 3ds: 130 | version: '0.3' 131 | guid: 'c6596e5a-5f3a-4681-942a-746433f255ff' 132 | url: 'https://github.com/LeonardFiedrowicz/galaxy-integration-citra/archive/bac4637f426a3aa48bd8e51338ac219925629b60.zip' 133 | archive_path: 'galaxy-integration-citra-bac4637f426a3aa48bd8e51338ac219925629b60' 134 | amiga: 135 | # ScummVM Plugin 136 | version: '0.2' 137 | guid: 'ceb4409d-84be-4e93-84f3-a5a300f0a95c' 138 | url: 'https://github.com/micpp42/gog-galaxy-scummvm/releases/download/v${version}/scummvm.zip' 139 | jaguar: 140 | # DOSBox Plugin 141 | version: '0.1' 142 | guid: 'c1236e5a-5f3a-4681-942a-746433f255ff' 143 | url: 'https://github.com/RoorMakurosu/galaxy-integration-dosbox/archive/8241415a583c7bb2c2b7149c021777213e7e57ff.zip' 144 | archive_path: 'galaxy-integration-dosbox-8241415a583c7bb2c2b7149c021777213e7e57ff/' 145 | n64: 146 | version: '0.2' 147 | guid: 'a3824d31-c2d3-4a1a-b321-7d0764da5513' 148 | url: 'https://github.com/Riku55/galaxy-integration-n64-RetroArch-/archive/${version}.zip' 149 | archive_path: 'galaxy-integration-n64-RetroArch--${version}/' 150 | nds: 151 | version: '0.1.0' 152 | guid: '81f936fb-39d9-48bc-b2c5-d4d45b80fbd9' 153 | url: 'https://github.com/TBemme/galaxy-integration-nds/releases/download/v${version}/galaxy-integration-nds-${version}.zip' 154 | archive_path: 'nds_81f936fb-39d9-48bc-b2c5-d4d45b80fbd9/' 155 | nes: 156 | version: '0.3.0' 157 | guid: '454d829d-2367-4414-b33d-1e5c138eebdf' 158 | url: 'https://github.com/AHCoder/galaxy-integration-nes/archive/ecb4e4667ff8451a206e23ae80f2f07e57eb4a16.zip' 159 | archive_path: 'galaxy-integration-nes-ecb4e4667ff8451a206e23ae80f2f07e57eb4a16/src/' 160 | ngameboy: 161 | version: '0.3.1' 162 | guid: '3765ba17-db55-460e-8f5c-f7e19cc5bb79' 163 | url: 'https://github.com/AHCoder/galaxy-integration-ngameboy/archive/9ac755f41ebac1d3b6eee91a3f0d69e8bf4b5a39.zip' 164 | archive_path: 'galaxy-integration-ngameboy-9ac755f41ebac1d3b6eee91a3f0d69e8bf4b5a39/src/' 165 | ncube: 166 | version: '0.3.4' 167 | guid: '6804a766-c1fd-48cf-9a8b-8661a970a6cb' 168 | url: 'https://github.com/JTNDev/galaxy-integration-gc/releases/download/v${version}/Dolphin-GCN-Retroarch-v${version}.zip' 169 | archive_path: 'dolphin_gc_6804a766-c1fd-48cf-9a8b-8661a970a6cb/' 170 | nswitch: 171 | version: '2.0' 172 | guid: 'b627be67-44e5-40f5-a482-6e52bf967ea1' 173 | url: 'https://github.com/hyoretsu/galaxy-integration-switch/releases/download/v2.0.0/galaxy-integration-switch.zip' 174 | nwii: 175 | version: '0.5.1' 176 | guid: 'fc3e85e4-c66b-4310-96c0-8f95cc43e546' 177 | url: 'https://github.com/JTNDev/galaxy-integration-wii/releases/download/${version}/galaxy-integration-wii.zip' 178 | archive_path: 'galaxy-integration-wii/' 179 | nwiiu: 180 | version: '0.1' 181 | guid: '1023214b-fd5d-45fd-9671-c080e92b03bb' 182 | url: 'https://github.com/LeonardFiedrowicz/galaxy-integration-cemu/releases/download/v1.2/galaxy-integration-cemu.zip' 183 | archive_path: 'galaxy-integration-cemu/' 184 | snes: 185 | version: '0.4.0' 186 | guid: 'aa7db44d-b70b-4774-91da-db1034318d3c' 187 | url: 'https://github.com/AHCoder/galaxy-integration-snes/archive/0664bd20bcc56b63befe934bbaef180d86b25bb6.zip' 188 | archive_path: 'galaxy-integration-snes-0664bd20bcc56b63befe934bbaef180d86b25bb6/src/' 189 | psp: 190 | version: '0.1.1' 191 | guid: 'cea94ced-c6cd-44cf-940c-a6c9253827a9' 192 | url: 'https://github.com/TBemme/galaxy-integration-psp/releases/download/v${version}/galaxy-integration-psp-${version}.zip' 193 | archive_path: 'psp_cea94ced-c6cd-44cf-940c-a6c9253827a9' 194 | ps2: 195 | version: '0.8.3' 196 | guid: '1e814707-1fe3-4e1e-86fe-1b8d1b7fac2e' 197 | url: 'https://github.com/AHCoder/galaxy-integration-ps2/archive/2d57a094e4447a2016074a42dd4d7b425985a48a.zip' 198 | archive_path: 'galaxy-integration-ps2-2d57a094e4447a2016074a42dd4d7b425985a48a/src/' 199 | vision: 200 | # RPCS3 Plugin (Playstation 3) 201 | version: '0.63' 202 | guid: '80F9D16B-5D72-4B95-9D46-2A1EF417C1FC' 203 | url: 'https://github.com/mpm11011/galaxy-integration-rpcs3/archive/e18319c503dc9a97c315375b9570821ce5636544.zip' 204 | archive_path: 'galaxy-integration-rpcs3-e18319c503dc9a97c315375b9570821ce5636544' 205 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | PyYAML==6.* 2 | -------------------------------------------------------------------------------- /update-plugin-manifest.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | import argparse 4 | import json 5 | import ruamel.yaml 6 | from urllib.request import urlopen 7 | 8 | __version__ = '0.0.3' 9 | 10 | # Friends of Galaxy Config File 11 | fog_cfg = 'https://raw.githubusercontent.com/FriendsOfGalaxy/cfg/master/' \ 12 | 'config.json' 13 | 14 | # Plugins to ignore, as they are recieving updates separately from the 15 | # Friends of Galaxy update system (which is currently broken) 16 | ignore_plugins = ['humble', 'rockstar', 'steam'] 17 | 18 | def fetch_fog_config_data(cfg): 19 | """ 20 | Fetches Friends of Galaxy's master cfg file, then loops through all plugins 21 | and determines the latest version information 22 | """ 23 | results = {} 24 | 25 | # Download and parse cfg file 26 | url = urlopen(cfg) 27 | json_data = url.read() 28 | plugins = json.loads(json_data) 29 | 30 | for p in plugins['plugins']: 31 | platform = p['platform'] 32 | guid = p['guid'] 33 | cfg_url = p['update_url'] 34 | 35 | # Skip any plugins in the ignore list 36 | if platform in ignore_plugins: 37 | print('Skipping plugin {} (Friends of Galaxy repo out of date)' 38 | .format(platform)) 39 | continue 40 | 41 | # Download platform's update file 42 | update_url = urlopen(cfg_url) 43 | update_data = update_url.read() 44 | 45 | update = json.loads(update_data) 46 | version = update['tag_name'] 47 | dl_url = '' 48 | 49 | for a in update['assets']: 50 | if 'win' in a['name']: 51 | dl_url = a['browser_download_url'] 52 | 53 | # If version is prefixed with a "v", remove it 54 | if version.startswith('v'): 55 | version = version[1:] 56 | 57 | # Save results to dict 58 | results[platform] = { 59 | "guid": guid, 60 | "version": version, 61 | "dl_url": dl_url 62 | } 63 | 64 | print('Found plugin {} version {}'.format( 65 | platform, version)) 66 | 67 | return results 68 | 69 | 70 | def update_plugins_manifest(data, manifest_file): 71 | """ 72 | Updates manifest file with new data 73 | """ 74 | 75 | # Open/Read Existing file 76 | with open(manifest_file, 'r') as file_data: 77 | yaml_data = file_data.read() 78 | 79 | yaml = ruamel.yaml.YAML() 80 | yaml.indent(mapping=4, sequence=2, offset=0) 81 | yaml.preserve_quotes = True 82 | plugin_data = yaml.load(yaml_data) 83 | 84 | # Loop through each item in plugins manifest 85 | for plugin, cur_data in plugin_data['plugins'].items(): 86 | # Skip non-FOG plugins 87 | if plugin not in data: 88 | continue 89 | 90 | cur_guid = cur_data['guid'] 91 | cur_version = cur_data['version'] 92 | cur_url = cur_data['url'] 93 | fog_guid = data[plugin]['guid'] 94 | fog_version = data[plugin]['version'] 95 | fog_url = data[plugin]['dl_url'] 96 | 97 | print('Checking manifest for {}'.format(plugin)) 98 | 99 | if cur_guid != fog_guid: 100 | print(' New GUID (old: "{}" new: "{}")'.format( 101 | cur_guid, fog_guid)) 102 | plugin_data['plugins'][plugin]['guid'] = fog_guid 103 | 104 | if cur_version != fog_version: 105 | print(' New Version (old: "{}" new: "{}")'.format( 106 | cur_version, fog_version)) 107 | plugin_data['plugins'][plugin]['version'] = fog_version 108 | 109 | if cur_url != fog_url: 110 | print(' New URL (old: "{}" new: "{}")'.format( 111 | cur_url, fog_url)) 112 | plugin_data['plugins'][plugin]['url'] = fog_url 113 | 114 | # Write the updated yaml file to disk 115 | with open(manifest_file, 'w') as yaml_file: 116 | yaml.dump(plugin_data, yaml_file) 117 | 118 | # Check that there aren't any items in the fog config that are missing from 119 | # the manifest 120 | for fog_name in data: 121 | if fog_name not in plugin_data['plugins'].keys(): 122 | print('ERROR: {} not found in plugin manifest!'.format(fog_name)) 123 | 124 | 125 | if __name__ == "__main__": 126 | """ 127 | Entry point to script 128 | 129 | - Downloads Friends of Galaxy's config 130 | - Loops through each plugin and pulls in current version information 131 | - Updates plugins.yaml 132 | """ 133 | 134 | # Define script arguments 135 | parser = argparse.ArgumentParser( 136 | description='Plugin Manifest Updater') 137 | 138 | parser.add_argument('--version', action='version', 139 | version='{}'.format(__version__)) 140 | 141 | # Parse arguments 142 | args = parser.parse_args() 143 | 144 | # Download/Load Plugin Data 145 | fog_plugins = fetch_fog_config_data(fog_cfg) 146 | 147 | # Update existing plugins manifest 148 | update_plugins_manifest(fog_plugins, './plugins.yaml') 149 | --------------------------------------------------------------------------------