├── .gitignore ├── Cargo.toml ├── LICENSE ├── README.md ├── hyprforest_logo.png └── src ├── installer.rs ├── main.rs └── utils ├── contents.rs ├── helper_functions.rs ├── macros.rs ├── mod.rs └── types.rs /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "autoricer" 3 | version = "0.1.1" 4 | authors = ["Arfan Zubi", " 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 | # Auto-Ricer 2 | 3 |

4 | 5 |

A small auto-ricer for Hyprland on Arch Linux!

6 | 7 | This installer will take all the configuration files from this repository _(https://github.com/3rfaan/dotfiles)_ and copies them into your 📁 **~/.config** directory. 8 | 9 | **⚠️ NOTE: You have to install all the necessary programs from this [Guide](https://github.com/3rfaan/dotfiles/blob/main/README.md), otherwise the ricing won't have an effect on your system!** 10 | 11 | ## Preview 12 | 13 | 14 | 15 | ## Installation 16 | 17 | ### [Crates.io](https://crates.io/crates/autoricer) 18 | 19 | ``` 20 | $ cargo install autoricer 21 | ``` 22 | 23 | You can then run the following command: 24 | 25 | ``` 26 | $ autoricer 27 | ``` 28 | 29 | ### [AUR](https://aur.archlinux.org/packages/autoricer-bin) 30 | 31 | ``` 32 | $ yay -S autoricer-bin 33 | ``` 34 | 35 | You can then run the following command: 36 | 37 | ``` 38 | $ autoricer 39 | ``` 40 | 41 | ### Build from Source 42 | 43 | Execute the following commands in your terminal: 44 | 45 | ``` 46 | $ git clone https://github.com/3rfaan/autoricer.git $HOME/Downloads/autoricer && cd $HOME/Downloads/autoricer 47 | $ cargo run 48 | ``` 49 | 50 | _Note: Rust has to be installed on the system to build from source!_ 51 | 52 | ## Backup 53 | 54 | A backup of all your old configuration files in 📁 **~/.config** will be created in 📁 **~/Documents/config_backup** before deleting anything. 55 | 56 | ## Change keyboard layout 57 | 58 | When prompted you can change the keyboard layout directly in the installer. 59 | 60 | ## Nvidia Support 61 | 62 | When prompted you can enable support for Nvidia in Hyprland. The installer will then put the appropriate environment variables inside Hyprland config file. 63 | 64 | ## After Installation 65 | 66 | After the installation process you probably have to restart Hyprland using super + shift + e. 67 | 68 | The wallpaper can be changed inside 📁 **~/.config/hypr/hyprpaper.conf** 69 | -------------------------------------------------------------------------------- /hyprforest_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/3rfaan/autoricer/8129b6256b8529768b18b0888e21257194267324/hyprforest_logo.png -------------------------------------------------------------------------------- /src/installer.rs: -------------------------------------------------------------------------------- 1 | use crate::{ 2 | clone, error, info, prompt, success, tip, 3 | utils::{helper_functions::*, types::*}, 4 | warning, 5 | }; 6 | use colored::Colorize; 7 | use once_cell::sync::Lazy; 8 | use regex::Regex; 9 | use std::{ 10 | fs::{self, File}, 11 | io::{self, BufRead, BufReader, BufWriter, Write}, 12 | path::{Path, PathBuf}, 13 | process::Command, 14 | }; 15 | 16 | pub fn installation_prompt() -> io::Result { 17 | let mut input: String; 18 | 19 | tip!("This installer will copy the config files from this repo: https://github.com/3rfaan/arch-everforest\n\ 20 | Make sure you've installed those programs to get the best experience."); 21 | warning!("==> This installer will modify directories inside your ~/.config directory"); 22 | 23 | loop { 24 | prompt!("Do you want to proceed? [y/N]"); 25 | 26 | input = read_input()?; 27 | 28 | match parse_input(&input) { 29 | UserInput::Yes => return Ok(Installation::Proceed), 30 | UserInput::No => return Ok(Installation::Exit), 31 | UserInput::Other => prompt!("==> Please enter [y]es or [n]o!"), 32 | } 33 | } 34 | } 35 | 36 | // Clones Github repo into ~/Downloads/arch-everforest 37 | pub fn clone_repo(config_path: &Path, repo_path: &Path) -> io::Result { 38 | const URL: &str = "https://github.com/3rfaan/dotfiles"; 39 | 40 | info!("Cloning into https://github.com/3rfaan/dotfiles..."); 41 | 42 | if !config_path.exists() { 43 | fs::create_dir_all(config_path)?; 44 | } 45 | 46 | if repo_path.exists() { 47 | return Ok(DownloadStatus::Existing); 48 | } 49 | 50 | clone!(URL, repo_path)?; 51 | 52 | Ok(DownloadStatus::Success) 53 | } 54 | 55 | // Delete directories and files which are not needed to moved to ~/.config directory 56 | pub fn cleanup_repo(paths: &Paths) -> io::Result<()> { 57 | let entries_to_delete: &[&str] = &[ 58 | "arch_wallpaper.jpg", 59 | "preview_1.png", 60 | "preview_2.png", 61 | "preview_3.png", 62 | "preview_4.png", 63 | ".git", 64 | "README.md", 65 | "zsh", 66 | ]; 67 | 68 | info!("Removing some directories and files which are not needed to be moved to ~/.config..."); 69 | 70 | cleanup(paths, entries_to_delete)?; 71 | 72 | Ok(()) 73 | } 74 | 75 | // Creates backup of all files and directories inside ~/.config and puts it inside ~/Documents/config_backup 76 | pub fn create_backup(config_path: &Path, documents_path: &Path) -> io::Result { 77 | let backup_path: PathBuf = documents_path.join("config_backup"); 78 | 79 | info!("Creating backup of your current ~/.config directory..."); 80 | 81 | if backup_path.exists() { 82 | return Ok(BackupStatus::Existing); 83 | } else { 84 | fs::create_dir(&backup_path)?; 85 | } 86 | 87 | if let Err(error) = copy_recursively(config_path, backup_path) { 88 | error!( 89 | "Could not create backup directory at ~/Documents/backup", 90 | error 91 | ); 92 | 93 | loop { 94 | prompt!("The theme can still be installed. Do you want to continue? [y/N]"); 95 | 96 | let input: String = read_input()?; 97 | 98 | match parse_input(&input) { 99 | UserInput::Yes => return Ok(BackupStatus::NoBackup), 100 | UserInput::No => return Err(error), 101 | UserInput::Other => prompt!("==> Please enter [y]es or [n]o!"), 102 | } 103 | } 104 | } 105 | 106 | Ok(BackupStatus::Created) 107 | } 108 | 109 | // Copy directories from ~/Downloads/arch-everforest to ~/.config recursively 110 | pub fn copy_config_dirs_recursively(src: &Path, dest: &Path) -> io::Result<()> { 111 | fs::create_dir_all(dest)?; 112 | 113 | info!("Copying directories from ~/Downloads/arch-everforest to ~/.config..."); 114 | 115 | copy_recursively(src, dest)?; 116 | 117 | Ok(()) 118 | } 119 | 120 | // Prompt for changing settings inside ~/.config/hypr/hyprland.conf 121 | pub fn change_settings(hypr_config: &Path) -> io::Result { 122 | let mut input: String; 123 | 124 | let mut change_kb_layout: bool; 125 | let mut layout_code: String = String::from("us"); 126 | 127 | let change_nvidia_env_vars: bool; 128 | 129 | loop { 130 | prompt!("Keyboard layout is currently set to [us]. Would you like to change it? [y/N]"); 131 | 132 | input = read_input()?; 133 | 134 | match parse_input(&input) { 135 | UserInput::Yes => { 136 | change_kb_layout = true; 137 | break; 138 | } 139 | UserInput::No => { 140 | change_kb_layout = false; 141 | break; 142 | } 143 | UserInput::Other => prompt!("==> Please enter [y]es or [n]o!"), 144 | } 145 | } 146 | 147 | if change_kb_layout { 148 | match get_kb_layout_code() { 149 | Ok(KBLayout::Change(code)) => layout_code = code, 150 | Ok(KBLayout::Default) => change_kb_layout = false, 151 | Err(error) => return Err(error), 152 | } 153 | } 154 | 155 | loop { 156 | prompt!("Are you using a NVIDIA graphics card? [y/N]"); 157 | 158 | input = read_input()?; 159 | 160 | match parse_input(&input) { 161 | UserInput::Yes => { 162 | change_nvidia_env_vars = true; 163 | break; 164 | } 165 | UserInput::No => { 166 | change_nvidia_env_vars = false; 167 | break; 168 | } 169 | UserInput::Other => prompt!("==> Please enter [y]es or [n]o!"), 170 | } 171 | } 172 | 173 | if !change_kb_layout && !change_nvidia_env_vars { 174 | return Ok(HyprConfig::Default); 175 | } 176 | 177 | update_hypr_config( 178 | hypr_config, 179 | change_kb_layout, 180 | change_nvidia_env_vars, 181 | &layout_code, 182 | )?; 183 | 184 | Ok(HyprConfig::Modified) 185 | } 186 | 187 | // Helper function for `change_settings()` to modify Hyprland config file 188 | fn update_hypr_config( 189 | hypr_config: &Path, 190 | change_kb_layout: bool, 191 | change_nvidia_env_vars: bool, 192 | layout_code: &str, 193 | ) -> io::Result { 194 | if layout_code == "us" && !change_nvidia_env_vars { 195 | return Ok(HyprConfig::Default); 196 | } 197 | 198 | // Path to Hyprland config file 199 | let hypr_config_file: File = File::open(hypr_config)?; 200 | let hypr_config_reader: BufReader = BufReader::new(hypr_config_file); 201 | 202 | let temp_file_path: &Path = Path::new("./hyprland.conf"); 203 | let temp_file: File = File::create(temp_file_path)?; 204 | let mut temp_file_stream: BufWriter = BufWriter::new(temp_file); 205 | 206 | let old_layout: &str = "kb_layout = us"; 207 | let new_layout: String = format!("kb_layout = {}", layout_code); 208 | 209 | static NVIDIA_ENV_VARS_RE: Lazy = Lazy::new(|| Regex::new(r"^#(env = .+)$").unwrap()); 210 | 211 | info!("Modifying Hypr config with your settings..."); 212 | 213 | for line in hypr_config_reader.lines() { 214 | let mut line: String = line?; 215 | 216 | if change_kb_layout && line.contains(old_layout) { 217 | line = line.replace(old_layout, &new_layout); 218 | 219 | println!( 220 | "{} {}", 221 | "==> Changed the following line in Hypr config file:".green(), 222 | line.trim().green().bold() 223 | ); 224 | } 225 | 226 | if change_nvidia_env_vars && NVIDIA_ENV_VARS_RE.is_match(&line) { 227 | line = NVIDIA_ENV_VARS_RE.replace(&line, "$1").to_string(); 228 | } 229 | 230 | temp_file_stream.write_all(line.as_bytes())?; 231 | temp_file_stream.write_all(b"\n")?; 232 | } 233 | 234 | temp_file_stream.flush()?; 235 | 236 | if temp_file_path.exists() { 237 | fs::copy(temp_file_path, hypr_config)?; 238 | fs::remove_file(temp_file_path)?; 239 | 240 | success!("==> Copied new Hypr config file to ~/.config/Hypr/hyprland.conf"); 241 | success!("==> Removed temporary file"); 242 | } 243 | 244 | Ok(HyprConfig::Modified) 245 | } 246 | 247 | pub fn install_cli_utilities(home_path: &Path, config_path: &Path) -> io::Result { 248 | let zsh_path: PathBuf = home_path.join(".zsh"); 249 | let yazi_path: PathBuf = config_path.join("yazi/plugins"); 250 | 251 | info!("Installing CLI utilies"); 252 | 253 | if !zsh_path.exists() { 254 | fs::create_dir_all(&zsh_path)?; 255 | } 256 | 257 | if !zsh_path.join("zsh-autosuggestions").exists() { 258 | clone!( 259 | "https://github.com/zsh-users/zsh-autosuggestions", 260 | &zsh_path.join("zsh-autosuggestions") 261 | )?; 262 | 263 | success!("==> Successfully cloned zsh-autosuggestions"); 264 | } 265 | 266 | if !zsh_path.join("zsh-syntax-highlighting").exists() { 267 | clone!( 268 | "https://github.com/zsh-users/zsh-syntax-highlighting.git", 269 | &zsh_path.join("zsh-syntax-highlighting") 270 | )?; 271 | 272 | success!("==> Successfully cloned zsh-syntax-highlighting"); 273 | } 274 | 275 | if !yazi_path.exists() { 276 | fs::create_dir_all(&yazi_path)?; 277 | } 278 | 279 | let yazi_packages: &[&str] = &[ 280 | "dedukun/bookmarks", 281 | "dedukun/relative-motions", 282 | "yazi-rs/flavors:catppuccin-macchiato", 283 | "yazi-rs/plugins:full-border", 284 | ]; 285 | 286 | if command_exists("ya") { 287 | for &package in yazi_packages { 288 | Command::new("ya") 289 | .arg("pack") 290 | .arg("-a") 291 | .arg(package) 292 | .output()?; 293 | } 294 | } else { 295 | warning!("Could not install ya packages for yazi. Make sure ya is installed and try to install them manually"); 296 | } 297 | 298 | Ok(DownloadStatus::Success) 299 | } 300 | 301 | pub fn after_install(repo_path: &Path) -> io::Result<()> { 302 | info!("Removing ~/Downloads/arch-everforest repo"); 303 | 304 | if repo_path.exists() { 305 | fs::remove_dir_all(repo_path)?; 306 | } 307 | 308 | success!("==> Removed repo successfully".green()); 309 | 310 | info!("Installation succeeded! 🎉"); 311 | 312 | tip!("Tip: After this installation you have to restart Hyprland by pressing + + E"); 313 | tip!("Tip: To change your wallpaper change the path to another picture inside ~/.config/hypr/hyprpaper.conf"); 314 | 315 | Ok(()) 316 | } 317 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | use crate::utils::{contents::print_installer_info, helper_functions::pause, types::*}; 2 | use colored::Colorize; 3 | use installer::*; 4 | use std::io; 5 | 6 | mod installer; 7 | mod utils; 8 | 9 | fn main() -> io::Result<()> { 10 | let paths: Paths = Paths::build(); // All paths needed 11 | 12 | // Installer 13 | print_installer_info(); 14 | 15 | match installation_prompt() { 16 | Ok(Installation::Proceed) => success!("==> Proceeding with installation..."), 17 | Ok(Installation::Exit) => { 18 | info!("==> Exiting..."); 19 | return Ok(()); 20 | } 21 | Err(error) => return Err(error), 22 | } 23 | 24 | match clone_repo(&paths.config, &paths.repo) { 25 | Ok(DownloadStatus::Success) => { 26 | success!("==> Successfully cloned Github repo into ~/Downloads") 27 | } 28 | Ok(DownloadStatus::Existing) => { 29 | success!("==> Repo has already been cloned into ~/Downloads") 30 | } 31 | Err(error) => { 32 | error!( 33 | "Could not clone Github repo into ~/Downloads. Exiting...", 34 | error 35 | ); 36 | return Err(error); 37 | } 38 | } 39 | 40 | match cleanup_repo(&paths) { 41 | Ok(()) => success!("==> Cleanup was successful"), 42 | Err(error) => error!( 43 | "There was an error while cleaning up ~/Downloads/arch-everforest", 44 | error 45 | ), 46 | } 47 | 48 | match create_backup(&paths.config, &paths.documents) { 49 | Ok(BackupStatus::Created) => { 50 | success!("==> Successfully created backup at ~/Documents/backup") 51 | } 52 | Ok(BackupStatus::Existing) => { 53 | success!("==> There is already a backup in ~/Documents/config_backup") 54 | } 55 | Ok(BackupStatus::NoBackup) => success!("==> Continuing installation without backup"), 56 | Err(error) => { 57 | error!( 58 | "Could not create a backup of your ~/.config directory:", 59 | error 60 | ); 61 | return Err(error); 62 | } 63 | } 64 | 65 | match copy_config_dirs_recursively(&paths.repo, &paths.config) { 66 | Ok(()) => { 67 | success!("==> Successfully copied config files to ~/.config!"); 68 | } 69 | Err(error) => { 70 | error!("Could not copy files to ~/.config. Exiting...", error); 71 | return Err(error); 72 | } 73 | } 74 | 75 | match change_settings(&paths.hypr_config) { 76 | Ok(HyprConfig::Modified) => success!("==> Successfully modified Hypr config!"), 77 | Ok(HyprConfig::Default) => success!("==> Using default Hypr config"), 78 | Err(error) => error!("Modifying Hypr config failed", error), 79 | } 80 | 81 | match install_cli_utilities(&paths.home, &paths.config) { 82 | Ok(DownloadStatus::Success) => success!("==> Successfully installed CLI utilities"), 83 | Ok(_) => {} 84 | Err(error) => error!("Installing CLI utilities failed", error), 85 | } 86 | 87 | match after_install(&paths.repo) { 88 | Ok(()) => pause().unwrap(), 89 | Err(error) => error!("", error), 90 | } 91 | 92 | Ok(()) 93 | } 94 | -------------------------------------------------------------------------------- /src/utils/contents.rs: -------------------------------------------------------------------------------- 1 | use colored::Colorize; 2 | use std::collections::BTreeMap; 3 | 4 | pub fn print_installer_info() { 5 | const LOGO: &str = " 6 | 7 | ██╗ ██╗██╗ ██╗██████╗ ██████╗ ███████╗ ██████╗ ██████╗ ███████╗███████╗████████╗ 8 | ██║ ██║╚██╗ ██╔╝██╔══██╗██╔══██╗██╔════╝██╔═══██╗██╔══██╗██╔════╝██╔════╝╚══██╔══╝ 9 | ███████║ ╚████╔╝ ██████╔╝██████╔╝█████╗ ██║ ██║██████╔╝█████╗ ███████╗ ██║ 10 | ██╔══██║ ╚██╔╝ ██╔═══╝ ██╔══██╗██╔══╝ ██║ ██║██╔══██╗██╔══╝ ╚════██║ ██║ 11 | ██║ ██║ ██║ ██║ ██║ ██║██║ ╚██████╔╝██║ ██║███████╗███████║ ██║ 12 | ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝╚══════╝ ╚═╝ 13 | 14 | "; 15 | const TITLE: &str = "Auto-ricer for Hyprland on Arch Linux"; 16 | const AUTHOR: &str = "Arfan Zubi"; 17 | const THEME: &str = "Catppuccin"; 18 | const LICENSE: &str = "GNU General Public License"; 19 | 20 | println!( 21 | "{logo}\n\ 22 | {title}\n\ 23 | {} {author}\n\ 24 | {} {theme}\n\ 25 | {} {license}\n", 26 | "Author:".yellow(), 27 | "Theme:".bright_black(), 28 | "License:".bright_black(), 29 | logo = LOGO.bright_black(), 30 | title = TITLE.to_uppercase().green().bold(), 31 | author = AUTHOR.yellow(), 32 | theme = THEME.bright_black(), 33 | license = LICENSE.bright_black() 34 | ); 35 | } 36 | 37 | pub fn get_kb_layouts() -> BTreeMap<&'static str, &'static str> { 38 | BTreeMap::from([ 39 | ("al", "Albanian"), 40 | ("et", "Amharic"), 41 | ("am", "Armenian"), 42 | ("ara", "Arabic"), 43 | ("eg", "Arabic (Egypt)"), 44 | ("iq", "Arabic (Iraq)"), 45 | ("ma", "Arabic (Morocco)"), 46 | ("sy", "Arabic (Syria)"), 47 | ("az", "Azerbaijani"), 48 | ("ml", "Bambara"), 49 | ("bd", "Bangla"), 50 | ("by", "Belarusian"), 51 | ("be", "Belgian"), 52 | ("dz", "Berber (Algeria, Latin)"), 53 | ("ba", "Bosnian"), 54 | ("brai", "Braille"), 55 | ("bg", "Bulgarian"), 56 | ("mm", "Burmese"), 57 | ("cn", "Chinese"), 58 | ("hr", "Croatian"), 59 | ("cz", "Czech"), 60 | ("dk", "Danish"), 61 | ("af", "Dari"), 62 | ("mv", "Dhivehi"), 63 | ("nl", "Dutch"), 64 | ("bt", "Dzongkha"), 65 | ("au", "English (Australia)"), 66 | ("cm", "English (Cameroon)"), 67 | ("gh", "English (Ghana)"), 68 | ("nz", "English (New Zealand)"), 69 | ("ng", "English (Nigeria)"), 70 | ("za", "English (South Africa)"), 71 | ("gb", "English (UK)"), 72 | ("us", "English (US)"), 73 | ("epo", "Esperanto"), 74 | ("ee", "Estonian"), 75 | ("fo", "Faroese"), 76 | ("ph", "Filipino"), 77 | ("fi", "Finnish"), 78 | ("fr", "French"), 79 | ("ca", "French (Canada)"), 80 | ("cd", "French (Democratic Republic of the Congo)"), 81 | ("tg", "French (Togo)"), 82 | ("ge", "Georgian"), 83 | ("de", "German"), 84 | ("at", "German (Austria)"), 85 | ("ch", "German (Switzerland)"), 86 | ("gr", "Greek"), 87 | ("il", "Hebrew"), 88 | ("hu", "Hungarian"), 89 | ("is", "Icelandic"), 90 | ("in", "Indian"), 91 | ("id", "Indonesian (Latin)"), 92 | ("ie", "Irish"), 93 | ("it", "Italian"), 94 | ("jp", "Japanese"), 95 | ("kz", "Kazakh"), 96 | ("kh", "Khmer (Cambodia)"), 97 | ("kr", "Korean"), 98 | ("kg", "Kyrgyz"), 99 | ("la", "Lao"), 100 | ("lv", "Latvian"), 101 | ("lt", "Lithuanian"), 102 | ("mk", "Macedonian"), 103 | ("my", "Malay (Jawi, Arabic Keyboard)"), 104 | ("mt", "Maltese"), 105 | ("md", "Moldavian"), 106 | ("mn", "Mongolian"), 107 | ("me", "Montenegrin"), 108 | ("np", "Nepali"), 109 | ("gn", "N'Ko (AZERTY)"), 110 | ("no", "Norwegian"), 111 | ("ir", "Persian"), 112 | ("pl", "Polish"), 113 | ("pt", "Portuguese"), 114 | ("br", "Portuguese (Brazil)"), 115 | ("ro", "Romanian"), 116 | ("ru", "Russian"), 117 | ("rs", "Serbian"), 118 | ("lk", "Sinhala (phonetic)"), 119 | ("sk", "Slovak"), 120 | ("si", "Slovenian"), 121 | ("es", "Spanish"), 122 | ("latam", "Spanish (Latin American)"), 123 | ("ke", "Swahili (Kenya)"), 124 | ("tz", "Swahili (Tanzania)"), 125 | ("se", "Swedish"), 126 | ("tw", "Taiwanese"), 127 | ("tj", "Tajik"), 128 | ("th", "Thai"), 129 | ("bw", "Tswana"), 130 | ("tm", "Turkmen"), 131 | ("tr", "Turkish"), 132 | ("ua", "Ukrainian"), 133 | ("pk", "Urdu (Pakistan)"), 134 | ("uz", "Uzbek"), 135 | ("vn", "Vietnamese"), 136 | ("sn", "Wolof"), 137 | ]) 138 | } 139 | -------------------------------------------------------------------------------- /src/utils/helper_functions.rs: -------------------------------------------------------------------------------- 1 | use crate::{prompt, success, utils::contents::get_kb_layouts, KBLayout, Paths, UserInput}; 2 | use colored::Colorize; 3 | use std::{ 4 | collections::BTreeMap, 5 | fs::{self, DirEntry, FileType}, 6 | io::{self, stdin, stdout, Read, Write}, 7 | path::Path, 8 | process::Command, 9 | }; 10 | 11 | pub fn read_input() -> io::Result { 12 | let mut input: String = String::new(); 13 | 14 | io::stdout().flush()?; 15 | io::stdin().read_line(&mut input)?; 16 | 17 | Ok(input.trim().to_lowercase()) 18 | } 19 | 20 | pub fn parse_input(input: &str) -> UserInput { 21 | match input { 22 | "y" | "yes" => UserInput::Yes, 23 | "n" | "no" | "" => UserInput::No, 24 | _ => UserInput::Other, 25 | } 26 | } 27 | 28 | pub fn pause() -> io::Result<()> { 29 | prompt!("Press Enter to close this installer... "); 30 | 31 | stdout().flush()?; 32 | let _ = stdin().read(&mut [0])?; 33 | 34 | Ok(()) 35 | } 36 | 37 | pub fn copy_recursively(src: impl AsRef, dest: impl AsRef) -> io::Result<()> { 38 | for entry in fs::read_dir(src)? { 39 | let entry: DirEntry = entry?; 40 | let filetype: FileType = entry.file_type()?; 41 | 42 | if filetype.is_dir() { 43 | fs::create_dir_all(dest.as_ref().join(entry.file_name()))?; 44 | copy_recursively(entry.path(), dest.as_ref().join(entry.file_name()))?; 45 | } else { 46 | fs::copy(entry.path(), dest.as_ref().join(entry.file_name()))?; 47 | } 48 | } 49 | 50 | Ok(()) 51 | } 52 | 53 | pub fn cleanup<'a>(paths: &Paths, entries_to_delete: impl AsRef<[&'a str]>) -> io::Result<()> { 54 | for entry in fs::read_dir(&paths.repo)? { 55 | let entry: DirEntry = entry?; 56 | let filetype: FileType = entry.file_type()?; 57 | 58 | if entry.file_name() == "arch_wallpaper.jpg" { 59 | if !paths.wallpapers.exists() { 60 | fs::create_dir_all(&paths.wallpapers)?; 61 | } 62 | 63 | fs::copy(entry.path(), paths.wallpapers.join("arch_wallpaper.jpg"))?; 64 | 65 | success!("==> Successfully set wallpaper in ~/Documents/wallpapers"); 66 | } 67 | 68 | if entry.file_name() == "zsh" { 69 | fs::copy(entry.path().join(".zshrc"), paths.home.join(".zshrc"))?; 70 | 71 | success!("==> Copied .zshrc to ~/.zshrc before removing zsh directory"); 72 | } 73 | 74 | if entries_to_delete.as_ref().contains( 75 | &entry 76 | .file_name() 77 | .to_str() 78 | .expect("Could not get directory name inside config directories"), 79 | ) { 80 | if filetype.is_dir() { 81 | fs::remove_dir_all(entry.path())?; 82 | } else { 83 | fs::remove_file(entry.path())?; 84 | } 85 | 86 | println!( 87 | "{} {}", 88 | "==> Successfully removed:".green(), 89 | entry 90 | .file_name() 91 | .to_str() 92 | .expect("Could not get file name") 93 | .green() 94 | .bold() 95 | ); 96 | } 97 | } 98 | 99 | Ok(()) 100 | } 101 | 102 | pub fn get_kb_layout_code() -> io::Result { 103 | let mut input: String; 104 | let kb_layouts: BTreeMap<&str, &str> = get_kb_layouts(); 105 | 106 | loop { 107 | prompt!("Please enter a valid keyboard layout. Press l to see a [l]ist of available options or q to [q]uit:"); 108 | 109 | input = read_input()?; 110 | 111 | match input.as_str() { 112 | "q" | "quit" => return Ok(KBLayout::Default), 113 | "l" | "list" => kb_layouts 114 | .iter() 115 | .for_each(|(code, lang)| println!("{} -> {}", *code, *lang)), 116 | _ => { 117 | if kb_layouts.iter().any(|(&code, _)| *code == input) { 118 | break; 119 | } else { 120 | continue; 121 | } 122 | } 123 | } 124 | } 125 | 126 | Ok(KBLayout::Change(input)) 127 | } 128 | 129 | pub fn command_exists(command: &str) -> bool { 130 | Command::new(command).arg("-v").output().is_ok() 131 | } 132 | -------------------------------------------------------------------------------- /src/utils/macros.rs: -------------------------------------------------------------------------------- 1 | #[macro_export] 2 | macro_rules! clone { 3 | ($repo:expr,$dest:expr) => { 4 | Command::new("git") 5 | .arg("clone") 6 | .arg($repo) 7 | .arg($dest) 8 | .output() 9 | }; 10 | } 11 | 12 | #[macro_export] 13 | macro_rules! info { 14 | ($msg:expr) => { 15 | println!("\n{}", $msg.green().bold()) 16 | }; 17 | } 18 | 19 | #[macro_export] 20 | macro_rules! prompt { 21 | ($msg:expr) => { 22 | print!("\n{} ", $msg.yellow().bold()) 23 | }; 24 | } 25 | 26 | #[macro_export] 27 | macro_rules! warning { 28 | ($msg:expr) => { 29 | println!("\n{}", $msg.red().bold()) 30 | }; 31 | } 32 | 33 | #[macro_export] 34 | macro_rules! success { 35 | ($msg:expr) => { 36 | println!("{}", $msg.green()) 37 | }; 38 | } 39 | 40 | #[macro_export] 41 | macro_rules! error { 42 | ($msg:expr,$err:ident) => { 43 | eprintln!("{} {} {}", $msg.red().bold(), "->".red().bold(), $err) 44 | }; 45 | ($msg:expr) => { 46 | eprintln!("{}", $msg.red().bold()) 47 | }; 48 | } 49 | 50 | #[macro_export] 51 | macro_rules! tip { 52 | ($msg:expr) => { 53 | println!("{}", $msg.bright_black().bold()) 54 | }; 55 | } 56 | -------------------------------------------------------------------------------- /src/utils/mod.rs: -------------------------------------------------------------------------------- 1 | pub mod contents; 2 | pub mod helper_functions; 3 | pub mod macros; 4 | pub mod types; 5 | -------------------------------------------------------------------------------- /src/utils/types.rs: -------------------------------------------------------------------------------- 1 | use std::path::PathBuf; 2 | 3 | pub enum UserInput { 4 | Yes, 5 | No, 6 | Other, 7 | } 8 | 9 | pub enum Installation { 10 | Proceed, 11 | Exit, 12 | } 13 | 14 | pub enum BackupStatus { 15 | Created, 16 | Existing, 17 | NoBackup, 18 | } 19 | 20 | pub enum DownloadStatus { 21 | Success, 22 | Existing, 23 | } 24 | 25 | pub enum HyprConfig { 26 | Modified, 27 | Default, 28 | } 29 | 30 | pub enum KBLayout { 31 | Change(String), 32 | Default, 33 | } 34 | 35 | pub struct Paths { 36 | pub home: PathBuf, 37 | pub config: PathBuf, 38 | pub documents: PathBuf, 39 | pub repo: PathBuf, 40 | pub hypr_config: PathBuf, 41 | pub wallpapers: PathBuf, 42 | } 43 | 44 | impl Paths { 45 | pub fn build() -> Self { 46 | Self { 47 | home: dirs::home_dir().expect("Cannot get ~ path"), 48 | config: dirs::config_dir().expect("Cannot get ~/.config path"), 49 | documents: dirs::document_dir().expect("Cannot get ~/Documents path"), 50 | repo: dirs::download_dir() 51 | .expect("Cannot get ~/Downloads path") 52 | .join("dotfiles"), 53 | hypr_config: dirs::config_dir() 54 | .expect("Cannot get ~/.config path") 55 | .join("hypr/hyprland.conf"), 56 | wallpapers: dirs::document_dir() 57 | .expect("Cannot get ~/Documents path") 58 | .join("wallpapers"), 59 | } 60 | } 61 | } 62 | --------------------------------------------------------------------------------