diff --git a/.gitea/workflows/release.yaml b/.gitea/workflows/release.yaml new file mode 100644 index 0000000..84d9969 --- /dev/null +++ b/.gitea/workflows/release.yaml @@ -0,0 +1,47 @@ +name: Release on Merge + +on: + pull_request: + types: [closed] + branches: + - main + +jobs: + release: + if: github.event.pull_request.merged == true + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Set Tag Name + id: tag + run: echo "tag=v$(date +'%Y.%m.%d-%H%M')" >> $GITHUB_OUTPUT + + - name: Generate Changelog + id: changelog + run: | + echo "CHANGELOG<> $GITHUB_OUTPUT + git log --pretty=format:"- %s (%h)" ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }} >> $GITHUB_OUTPUT + echo "" >> $GITHUB_OUTPUT + echo "EOF" >> $GITHUB_OUTPUT + + - name: Create Release and Upload Asset + uses: softprops/action-gh-release@v1 + with: + tag_name: ${{ steps.tag.outputs.tag }} + name: "Release: ${{ github.event.pull_request.title }}" + body: | + ## Summary + ${{ github.event.pull_request.body }} + + ## Changelog + ${{ steps.changelog.outputs.CHANGELOG }} + files: | + color-tool + draft: false + prerelease: false + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..53d1f3d --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..61ff282 --- /dev/null +++ b/README.md @@ -0,0 +1,113 @@ +# color-tool + +A feature-rich, portable CLI color utility for Linux, specializing in color picking, conversion, and formatting. Designed primarily for **KDE Plasma on Wayland**, `color-tool` provides a seamless bridge between your screen and your development environment. + +## 🌈 Key Features + +- **Advanced Color Picking:** Integration with KWin's DBus ColorPicker for pixel-perfect selection on Wayland. +- **Robust Conversions:** Support for HEX, RGB, HSL, and their Alpha-enabled counterparts (HEXA, RGBA, HSLA). +- **Format Flexibility:** Request multiple formats at once, or use `all` for a complete breakdown. +- **Smart JSON Output:** Generate machine-readable JSON tables for easy integration with other tools. +- **Color Naming:** Resolve hex values to human-readable names via thecolorapi.com. +- **Visual Previews:** Render color swatches directly in your terminal using truecolor ANSI escapes. +- **Desktop Integration:** Built-in support for clipboard copying (`wl-copy`/`xclip`) and desktop notifications. +- **Highly Configurable:** Separate configuration profiles for standard terminal usage and desktop/launcher mode. +- **Portable Design:** The entire tool is contained within a single Bash script, with embedded Python helpers. + +## 📋 Prerequisites + +To utilize all features, ensure the following are installed: +- **KDE Plasma + Wayland:** Required for the `--pick` functionality. +- **Python 3 + PyQt6:** Required for the picker helper. +- **curl + jq:** Required for color naming support. +- **wl-clipboard** (Wayland) or **xclip** (X11): Required for clipboard support. +- **libnotify:** Required for desktop notifications (`notify-send`). + +## 🚀 Installation + +Simply download the `color-tool` script and run the install command: + +```bash +chmod +x color-tool +./color-tool --install +``` + +This will: +1. Move the script to `~/.local/share/color-tool/`. +2. Symlink the binary to `~/.local/bin/color-tool`. +3. Generate a sample configuration at `~/.config/color-tool/config.toml`. +4. Create a `.desktop` entry so you can launch the picker from your application menu. + +## 🛠 Usage + +```text +Usage: color-tool [OPTIONS] [COLOR ...] + +Options: + --[no-]pick Open the KDE Plasma color picker + --output FMT Format(s): hex, rgb, hsl, rgba, hsla, hexa, all (comma-separated) + --[no-]json Output as a JSON table of selected formats + --[no-]name Fetch nearest color name from thecolorapi.com + --[no-]swatch Include a color swatch in the terminal output + --[no-]copy Copy result to clipboard + --[no-]notify Show desktop notification + --desktop GUI mode: pick → copy → notify + --install Install to ~/.local/share/ and symlink to ~/.local/bin/ + --help, -h Show this help message +``` + +### Examples + +**Pick a color and get HSL + RGB:** +```bash +color-tool --pick --output hsl,rgb +``` + +**Convert a hex value with a visual swatch and color name:** +```bash +color-tool "#ff5500" --swatch --name +``` + +**Output all formats as JSON for a piped input:** +```bash +echo "rgba(255, 85, 0, 0.5)" | color-tool --output all --json +``` + +**Launch in "Silent" Desktop Mode (via terminal or launcher):** +```bash +color-tool --desktop --no-name +``` + +## ⚙️ Configuration + +You can define your preferred defaults in `~/.config/color-tool/config.toml`. The tool uses a priority hierarchy: **CLI Flags > Desktop Config > Default Config**. + +```toml +[defaults] +output = "hex" # default output format(s) +json = false # output in JSON format +swatch = false # show color swatch in terminal +name = false # fetch color name +copy = false # copy result to clipboard +pick = false # auto-launch picker +notify = false # show desktop notification + +[desktop] +output = "hex" +json = false +name = false +copy = true +notify = true +``` + +## 🤝 Credits + +The `wl-colorpicker-plasma` integration is based on the original work by [SASUPERNOVA](https://github.com/SASUPERNOVA/wl-colorpicker-plasma). + +## ⚖️ License + +Copyright © 2026 Rootiest. + +This program is free software: you can redistribute it and/or modify it under the terms of the **GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.** + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU General Public License](https://www.gnu.org/licenses/) for more details. diff --git a/color-tool b/color-tool index 2c41b62..c58123b 100755 --- a/color-tool +++ b/color-tool @@ -1,35 +1,63 @@ #!/usr/bin/env bash # color-tool — pick, convert, and format colors # Supports: hex → RGB/RGBA, KDE Plasma color picker, clipboard copy, JSON output, color names +# +# Copyright (C) 2026 Rootiest. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . set -euo pipefail # ── Configuration ───────────────────────────────────────────────────────────── # Resolve the real directory of this script so we can find bundled helpers SCRIPT_DIR="$(dirname "$(readlink -f "$0")")" -PICKER_SCRIPT="$SCRIPT_DIR/wl-colorpicker-plasma.py" CONFIG_FILE="$HOME/.config/color-tool/config.toml" -# ── Mode flags (toggled by CLI arguments or config file) ────────────────────── +# ── Initial Defaults ────────────────────────────────────────────────────────── -json_mode=0 # --json: output as JSON -alpha_mode=0 # --alpha: include alpha channel (8-digit hex) -name_mode=0 # --name: fetch color name via thecolorapi.com -copy_mode=0 # --copy: copy result to clipboard -desktop_mode=0 # --desktop: silent GUI mode (implies pick + copy + notify) -notify_mode=0 # internal: show desktop notification after copy -config_pick=0 # config: auto-launch picker when invoked with no arguments +# Hardcoded base defaults +json_mode=0 +alpha_mode=0 +name_mode=0 +copy_mode=0 +desktop_mode=0 +notify_mode=0 +swatch_mode=0 +config_pick=0 +output_formats="hex" -# Desktop-mode defaults (overridden by [desktop] config section) +# Desktop-specific defaults (initially same as base, can be overridden by config) desktop_json=0 desktop_alpha=0 desktop_name=0 desktop_notify=1 +desktop_copy=1 +desktop_output="hex" -# ── Config ──────────────────────────────────────────────────────────────────── +# Track which settings were explicitly set via CLI flags to ensure they override config +cli_json="" +cli_alpha="" +cli_name="" +cli_copy="" +cli_notify="" +cli_swatch="" +cli_pick="" +cli_output="" + +# ── Config Loader ───────────────────────────────────────────────────────────── # Parse ~/.config/color-tool/config.toml and apply [defaults] and [desktop] values. -# Only boolean true/false keys are supported; unknown keys are silently ignored. load_config() { [[ ! -f "$CONFIG_FILE" ]] && return 0 @@ -44,21 +72,26 @@ load_config() { continue fi - # key = value — use if/then/fi so each branch always exits 0 (safe under set -e) + # key = value if [[ "$line" =~ ^[[:space:]]*([A-Za-z_]+)[[:space:]]*=[[:space:]]*([^[:space:]]+) ]]; then key="${BASH_REMATCH[1]}" val="${BASH_REMATCH[2],,}" val="${val#\"}" ; val="${val%\"}" case "$section:$key" in - defaults:json) if [[ "$val" == "true" ]]; then json_mode=1; fi ;; - defaults:alpha) if [[ "$val" == "true" ]]; then alpha_mode=1; fi ;; - defaults:name) if [[ "$val" == "true" ]]; then name_mode=1; fi ;; - defaults:copy) if [[ "$val" == "true" ]]; then copy_mode=1; fi ;; - defaults:pick) if [[ "$val" == "true" ]]; then config_pick=1; fi ;; - desktop:json) if [[ "$val" == "true" ]]; then desktop_json=1; else desktop_json=0; fi ;; - desktop:alpha) if [[ "$val" == "true" ]]; then desktop_alpha=1; else desktop_alpha=0; fi ;; - desktop:name) if [[ "$val" == "true" ]]; then desktop_name=1; else desktop_name=0; fi ;; - desktop:notify) if [[ "$val" == "true" ]]; then desktop_notify=1; else desktop_notify=0; fi ;; + defaults:json) [[ "$val" == "true" ]] && json_mode=1 || json_mode=0 ;; + defaults:alpha) [[ "$val" == "true" ]] && alpha_mode=1 || alpha_mode=0 ;; + defaults:name) [[ "$val" == "true" ]] && name_mode=1 || name_mode=0 ;; + defaults:copy) [[ "$val" == "true" ]] && copy_mode=1 || copy_mode=0 ;; + defaults:pick) [[ "$val" == "true" ]] && config_pick=1 || config_pick=0 ;; + defaults:notify) [[ "$val" == "true" ]] && notify_mode=1 || notify_mode=0 ;; + defaults:swatch) [[ "$val" == "true" ]] && swatch_mode=1 || swatch_mode=0 ;; + defaults:output) output_formats="$val" ;; + desktop:json) [[ "$val" == "true" ]] && desktop_json=1 || desktop_json=0 ;; + desktop:alpha) [[ "$val" == "true" ]] && desktop_alpha=1 || desktop_alpha=0 ;; + desktop:name) [[ "$val" == "true" ]] && desktop_name=1 || desktop_name=0 ;; + desktop:notify) [[ "$val" == "true" ]] && desktop_notify=1 || desktop_notify=0 ;; + desktop:copy) [[ "$val" == "true" ]] && desktop_copy=1 || desktop_copy=0 ;; + desktop:output) desktop_output="$val" ;; esac fi done < "$CONFIG_FILE" @@ -74,44 +107,37 @@ show_help() { local yellow='\033[33m' local mag='\033[35m' - # Render an inline color swatch for a hex code - swatch() { - local h="${1#\#}" - printf "\033[48;2;%d;%d;%dm \033[0m" $((16#${h:0:2})) $((16#${h:2:2})) $((16#${h:4:2})) - } - printf "\n" # Title: "color" in a rainbow gradient, "-tool" in bold printf " ${bold}\033[38;2;255;80;80mc\033[38;2;255;160;0mo\033[38;2;220;210;0ml\033[38;2;80;200;80mo\033[38;2;80;160;255mr${reset}${bold}-tool${reset}" printf " ${dim}— pick, convert, and format colors${reset}\n\n" - printf " ${bold}${yellow}Usage${reset} ${cyan}${0##*/}${reset} ${dim}[OPTIONS]${reset} [HEX_COLOR ...]\n\n" + printf " ${bold}${yellow}Usage${reset} ${cyan}${0##*/}${reset} ${dim}[OPTIONS]${reset} [COLOR ...]\n\n" printf " ${bold}${yellow}Options${reset}\n" - printf " ${bold}${cyan}--pick${reset} Open the KDE Plasma color picker ${dim}(requires KDE + Wayland)${reset}\n" - printf " ${bold}${cyan}--alpha${reset} Interpret 8-digit hex codes ${dim}(RRGGBBAA)${reset} and include alpha channel\n" - printf " ${bold}${cyan}--json${reset} Output in JSON format\n" - printf " ${bold}${cyan}--name${reset} Fetch nearest color name from thecolorapi.com ${dim}(requires curl, jq)${reset}\n" - printf " ${bold}${cyan}--copy${reset} Copy result to clipboard ${dim}(wl-copy preferred, xclip as fallback)${reset}\n" + printf " ${bold}${cyan}--[no-]pick${reset} Open the KDE Plasma color picker ${dim}(requires KDE + Wayland)${reset}\n" + printf " ${bold}${cyan}--output${reset} ${dim}FMT${reset} Format(s) to output: ${cyan}hex, rgb, hsl, rgba, hsla, hexa, all${reset} ${dim}(comma-separated)${reset}\n" + printf " ${bold}${cyan}--[no-]json${reset} Output as a JSON table of selected formats\n" + printf " ${bold}${cyan}--[no-]name${reset} Fetch nearest color name from thecolorapi.com ${dim}(requires curl, jq)${reset}\n" + printf " ${bold}${cyan}--[no-]swatch${reset} Include a color swatch in the terminal output\n" + printf " ${bold}${cyan}--[no-]copy${reset} Copy result to clipboard ${dim}(wl-copy preferred, xclip as fallback)${reset}\n" + printf " ${bold}${cyan}--[no-]notify${reset} Show desktop notification ${dim}(on by default in --desktop)${reset}\n" printf " ${bold}${cyan}--desktop${reset} GUI mode: pick → copy → notify ${dim}(for app menu / .desktop launcher)${reset}\n" printf " ${bold}${cyan}--install${reset} Install to ~/.local/share/color-tool/ and symlink into ~/.local/bin/\n" printf " ${bold}${cyan}--help${reset}, ${bold}${cyan}-h${reset} Show this help message\n\n" printf " ${bold}${yellow}Examples${reset}\n" - printf " ${cyan}${0##*/}${reset} ${mag}\"#534145\"${reset} $(swatch "#534145") ${mag}\"#433f43\"${reset} $(swatch "#433f43")\n" - printf " ${dim}echo${reset} ${mag}\"#123456\"${reset} $(swatch "#123456") ${dim}|${reset} ${cyan}${0##*/}${reset}\n" - printf " ${cyan}${0##*/}${reset} ${bold}${cyan}--pick${reset} ${bold}${cyan}--json${reset} ${bold}${cyan}--copy${reset}\n" - printf " ${cyan}${0##*/}${reset} ${bold}${cyan}--pick${reset} ${bold}${cyan}--alpha${reset} ${bold}${cyan}--json${reset} ${bold}${cyan}--name${reset} ${bold}${cyan}--copy${reset}\n\n" + printf " ${cyan}${0##*/}${reset} ${mag}\"#534145\"${reset} --swatch\n" + printf " ${cyan}${0##*/}${reset} --pick --output rgb,hsl --json\n" + printf " ${cyan}${0##*/}${reset} \"rgb(255, 100, 0)\" --output hex,hsla\n\n" printf " ${bold}${yellow}Config${reset} ${dim}~/.config/color-tool/config.toml${reset}\n" - printf " ${dim}[defaults]${reset} keys: ${cyan}json alpha name copy pick${reset}\n" - printf " ${dim}[desktop]${reset} keys: ${cyan}json alpha name notify${reset} ${dim}(copy + pick always on)${reset}\n\n" + printf " ${dim}[defaults]${reset} keys: ${cyan}output json swatch name copy pick notify${reset}\n" + printf " ${dim}[desktop]${reset} keys: ${cyan}output json name notify copy${reset} ${dim}(pick always on)${reset}\n\n" } # ── Environment detection ───────────────────────────────────────────────────── -# Confirm the session is KDE Plasma on Wayland before invoking the color picker. -# KWin's ColorPicker DBus service is only present in this specific environment. check_kde_wayland() { if [[ -z "${WAYLAND_DISPLAY:-}" ]]; then echo "Error: color picker requires a Wayland session (WAYLAND_DISPLAY is not set)" >&2 @@ -124,11 +150,8 @@ check_kde_wayland() { fi } -# ── Clipboard ───────────────────────────────────────────────────────────────── +# ── Clipboard & Notifications ───────────────────────────────────────────────── -# Write text to the system clipboard. -# Prefers wl-copy (native Wayland); falls back to xclip (X11, often Wayland-bridged). -# Prints a warning and exits non-zero if neither tool is available. copy_to_clipboard() { local text="$1" if command -v wl-copy &>/dev/null; then @@ -142,42 +165,81 @@ copy_to_clipboard() { fi } -# ── Color picker ────────────────────────────────────────────────────────────── - -# Launch the bundled KDE Plasma color picker and echo the selected hex color. -# Validates the environment before invoking the Python/Qt DBus helper. -run_color_picker() { - if [[ ! -f "$PICKER_SCRIPT" ]]; then - echo "Error: picker script not found: $PICKER_SCRIPT" >&2 - return 1 - fi - check_kde_wayland || return 1 - python3 "$PICKER_SCRIPT" -} - -# ── Desktop mode ───────────────────────────────────────────────────────────── - -# Apply [desktop] config values as active mode flags; always enable pick and copy. -apply_desktop_config() { - json_mode=$desktop_json - alpha_mode=$desktop_alpha - name_mode=$desktop_name - notify_mode=$desktop_notify - copy_mode=1 - config_pick=1 -} - -# Show a desktop notification with the copied value (non-fatal if notify-send absent). notify_result() { local value="$1" command -v notify-send &>/dev/null || return 0 - notify-send -i "color-picker" "color-tool" "Copied to clipboard: $value" || true + notify-send -i "color-picker" "color-tool" "$value" || true } -# ── PATH suggestion ─────────────────────────────────────────────────────────── +# ── Color picker ────────────────────────────────────────────────────────────── + +# Generate the internal Python helper for KDE Plasma color picking +generate_picker_script() { + local target="$1" + cat > "$target" <<'EOF' +#!/usr/bin/python3 +# +# Original work Copyright (C) 2024 SASUPERNOVA +# Source: https://github.com/SASUPERNOVA/wl-colorpicker-plasma +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +from PyQt6.QtDBus import QDBusConnection, QDBusMessage, QDBusPendingReply, QDBusPendingCallWatcher +from PyQt6.QtCore import QCoreApplication +from PyQt6.QtGui import QColor +import sys + +def colorPicked(): + reply = QDBusPendingReply(call) + if reply.isError(): + print(reply.error().message(), file=sys.stderr) + else: + print(QColor(reply.argumentAt(0)[0]).name()) + +app = QCoreApplication(sys.argv) +msg = QDBusMessage.createMethodCall("org.kde.KWin", "/ColorPicker", "org.kde.kwin.ColorPicker", "pick") +call = QDBusConnection.sessionBus().asyncCall(msg) +watcher = QDBusPendingCallWatcher(call, app) +watcher.finished.connect(colorPicked) +watcher.waitForFinished() +EOF + chmod +x "$target" +} + +run_color_picker() { + check_kde_wayland || return 1 + + local picker_path="$SCRIPT_DIR/wl-colorpicker-plasma.py" + local cleanup=0 + + if [[ ! -f "$picker_path" ]]; then + picker_path=$(mktemp /tmp/wl-colorpicker-XXXXXX.py) + generate_picker_script "$picker_path" + cleanup=1 + fi + + local picked + picked=$(python3 "$picker_path") + local exit_code=$? + + [[ $cleanup -eq 1 ]] && rm -f "$picker_path" + + if [[ $exit_code -eq 0 ]]; then + echo "$picked" + else + return 1 + fi +} + +# ── Installation Helpers ────────────────────────────────────────────────────── -# Print the appropriate "add to PATH" instruction for the user's current shell. -# Detects fish via $SHELL or the parent process; falls back to showing both syntaxes. suggest_path_add() { local bin_dir="$1" is_fish=0 [[ "${SHELL:-}" == */fish ]] && is_fish=1 @@ -194,10 +256,6 @@ suggest_path_add() { fi } -# ── Installation ────────────────────────────────────────────────────────────── - -# Copy the script and helper into ~/.local/share/color-tool/ and symlink only -# the main binary into ~/.local/bin/. The picker script stays out of PATH. do_install() { local data_dir="$HOME/.local/share/color-tool" local bin_dir="$HOME/.local/bin" @@ -205,22 +263,12 @@ do_install() { local src_script src_script="$(readlink -f "$0")" - if [[ ! -f "$PICKER_SCRIPT" ]]; then - echo "Error: helper script not found: $PICKER_SCRIPT" >&2 - echo " Run --install from the directory containing wl-colorpicker-plasma.py" >&2 - exit 1 - fi - mkdir -p "$data_dir" "$bin_dir" - cp "$src_script" "$data_dir/color-tool" chmod +x "$data_dir/color-tool" - cp "$PICKER_SCRIPT" "$data_dir/wl-colorpicker-plasma.py" - - # -f replaces any existing symlink or stale file without prompting + generate_picker_script "$data_dir/wl-colorpicker-plasma.py" ln -sf "$data_dir/color-tool" "$bin_link" - # Seed a sample config only if one doesn't already exist (preserve user edits on reinstall) local config_dir="$HOME/.config/color-tool" local config_file="$config_dir/config.toml" mkdir -p "$config_dir" @@ -231,17 +279,22 @@ do_install() { [defaults] # Set any option to true to enable it by default when using the terminal -json = false # output in JSON format -alpha = false # include alpha channel (8-digit hex) -name = false # fetch color name from thecolorapi.com -copy = false # copy result to clipboard -pick = false # auto-launch color picker when invoked with no arguments +output = "hex" # default output format(s): hex, rgb, hsl, rgba, hsla, hexa, all +json = false # output in JSON format +alpha = false # include alpha channel (8-digit hex) +swatch = false # show color swatch in terminal +name = false # fetch color name from thecolorapi.com +copy = false # copy result to clipboard +pick = false # auto-launch color picker when invoked with no arguments +notify = false # show desktop notification [desktop] -# Defaults for --desktop mode (launched from the app menu; copy is always enabled) -json = false # copy JSON format instead of hex +# Defaults for --desktop mode (launched from the app menu; copy is always enabled by default) +output = "hex" # format to copy +json = false # copy JSON format instead of plain text alpha = false # include alpha channel name = false # fetch color name (requires network) +copy = true # copy result to clipboard notify = true # show desktop notification with the copied value EOF printf " config %s (sample created)\n" "$config_file" @@ -249,21 +302,6 @@ EOF printf " config %s\n" "$config_file" fi - generate_desktop_file - - printf "Installed:\n" - printf " data %s/\n" "$data_dir" - printf " bin %s -> %s\n" "$bin_link" "$data_dir/color-tool" - - # Warn when the bin dir is not yet on PATH so the user knows what to add - if [[ ":$PATH:" != *":$bin_dir:"* ]]; then - printf "\nNote: %s is not in your PATH.\n" "$bin_dir" - suggest_path_add "$bin_dir" - fi -} - -# Write a .desktop entry so color-tool appears in the app menu. -generate_desktop_file() { local app_dir="$HOME/.local/share/applications" local desktop_file="$app_dir/color-tool.desktop" local bin_path="$HOME/.local/bin/color-tool" @@ -282,127 +320,213 @@ Terminal=false NoDisplay=false EOF printf " app %s\n" "$desktop_file" + + printf "Installed:\n" + printf " data %s/\n" "$data_dir" + printf " bin %s -> %s\n" "$bin_link" "$data_dir/color-tool" + + if [[ ":$PATH:" != *":$bin_dir:"* ]]; then + printf "\nNote: %s is not in your PATH.\n" "$bin_dir" + suggest_path_add "$bin_dir" + fi } # ── Color conversion ────────────────────────────────────────────────────────── -# Convert a hex color to RGB/RGBA and print the result. -# Also copies a clean (no ANSI) value to clipboard when copy_mode is enabled. -hex_to_rgba() { - local hex="$1" - local clean_hex="${hex#\#}" +get_all_formats() { + local input="$1" + python3 -c " +import colorsys, json, sys, re - # Accept 6-digit (#RRGGBB) or 8-digit (#RRGGBBAA); pad 6-digit with full opacity - if [[ "$clean_hex" =~ ^[0-9A-Fa-f]{6}$ ]]; then - clean_hex="${clean_hex}FF" - elif [[ "$clean_hex" =~ ^[0-9A-Fa-f]{8}$ ]]; then - : # already RRGGBBAA - else - echo "Invalid hex color: $hex" >&2 - return 1 - fi +def parse_input(val): + val = val.strip().lower() + hex_match = re.match(r'^#?([0-9a-f]{3}|[0-9a-f]{6}|[0-9a-f]{8})$', val) + if hex_match: + h = hex_match.group(1) + if len(h) == 3: h = ''.join([c*2 for c in h]) + if len(h) == 6: h += 'ff' + return int(h[0:2], 16), int(h[2:4], 16), int(h[4:6], 16), int(h[6:8], 16) + rgba_match = re.match(r'^rgba?\(?(\d+),\s*(\d+),\s*(\d+)(?:,\s*([\d.]+))?\)?$', val) + if rgba_match: + r, g, b = map(int, rgba_match.groups()[:3]) + r, g, b = max(0, min(255, r)), max(0, min(255, g)), max(0, min(255, b)) + a = float(rgba_match.group(4)) if rgba_match.group(4) else 1.0 + return r, g, b, int(max(0, min(1, a)) * 255) + hsla_match = re.match(r'^hsla?\(?(\d+),\s*(\d+)%?,\s*(\d+)%?(?:,\s*([\d.]+))?\)?$', val) + if hsla_match: + h, s, l = map(int, hsla_match.groups()[:3]) + h, s, l = h % 360, max(0, min(100, s)), max(0, min(100, l)) + a = float(hsla_match.group(4)) if hsla_match.group(4) else 1.0 + r, g, b = colorsys.hls_to_rgb(h/360.0, l/100.0, s/100.0) + return int(r*255), int(g*255), int(b*255), int(max(0, min(1, a)) * 255) + return None - local r=$((16#${clean_hex:0:2})) - local g=$((16#${clean_hex:2:2})) - local b=$((16#${clean_hex:4:2})) - local a=$((16#${clean_hex:6:2})) - local name="" clip_value="" +res = parse_input('''$input''') +if not res: sys.exit(1) +r, g, b, a = res +h, l, s = colorsys.rgb_to_hls(r/255.0, g/255.0, b/255.0) +formats = { + 'hex': f'#{r:02x}{g:02x}{b:02x}', + 'hexa': f'#{r:02x}{g:02x}{b:02x}{a:02x}', + 'rgb': f'rgb({r}, {g}, {b})', + 'rgba': f'rgba({r}, {g}, {b}, {round(a/255.0, 2)})', + 'hsl': f'hsl({round(h*360)}, {round(s*100)}%, {round(l*100)}%)', + 'hsla': f'hsla({round(h*360)}, {round(s*100)}%, {round(l*100)}%, {round(a/255.0, 2)})', + '_raw': {'r': r, 'g': g, 'b': b, 'a': a} +} +print(json.dumps(formats)) +" +} - # Optionally resolve a human-readable name via the public thecolorapi.com API +validate_output_formats() { + local formats="$1" + local valid_fmts=("hex" "hexa" "rgb" "rgba" "hsl" "hsla") + IFS=',' read -ra ADDR <<< "$formats" + for fmt in "${ADDR[@]}"; do + [[ "$fmt" == "all" ]] && continue + local is_valid=0 + for v in "${valid_fmts[@]}"; do [[ "$fmt" == "$v" ]] && is_valid=1 && break; done + if [[ $is_valid -eq 0 ]]; then + echo "Error: Invalid output format: $fmt" >&2 + echo "Valid formats: ${valid_fmts[*]}, all" >&2 + return 1 + fi + done + return 0 +} + +process_color() { + local input="$1" + local formats_json + formats_json=$(get_all_formats "$input") || { echo "Error: Invalid color: $input" >&2; return 1; } + + local name="" if [[ $name_mode -eq 1 ]]; then - name=$(curl -s "https://www.thecolorapi.com/id?hex=${clean_hex:0:6}" | jq -r '.name.value // empty') + local hex_for_api + hex_for_api=$(echo "$formats_json" | jq -r '.hex' | tr -d '#') + name=$(curl -s "https://www.thecolorapi.com/id?hex=$hex_for_api" | jq -r '.name.value // empty') fi - # Build clip_value (always; desktop mode needs it even without terminal output) + local selected_fmts=() + local valid_fmts=("hex" "hexa" "rgb" "rgba" "hsl" "hsla") + IFS=',' read -ra ADDR <<< "$output_formats" + for fmt in "${ADDR[@]}"; do + if [[ "$fmt" == "all" ]]; then + selected_fmts=("${valid_fmts[@]}") + break + else + selected_fmts+=("$fmt") + fi + done + + local display_parts=() + local json_obj="{}" + for fmt in "${selected_fmts[@]}"; do + local val + val=$(echo "$formats_json" | jq -r ".$fmt // empty") + if [[ -n "$val" ]]; then + display_parts+=("$val") + json_obj=$(echo "$json_obj" | jq --arg k "$fmt" --arg v "$val" '. + {($k): $v}') + fi + done + + [[ -n "$name" ]] && json_obj=$(echo "$json_obj" | jq --arg v "$name" '. + {"name": $v}') + + local output_text if [[ $json_mode -eq 1 ]]; then - if [[ $alpha_mode -eq 1 ]]; then - clip_value=$(printf '{"hex":"#%s","rgba":[%d,%d,%d,%d]}' "$clean_hex" "$r" "$g" "$b" "$a") - else - clip_value=$(printf '{"hex":"#%s","rgb":[%d,%d,%d]}' "${clean_hex:0:6}" "$r" "$g" "$b") - fi - [[ -n "$name" ]] && clip_value="${clip_value%\}}$(printf ',"name":"%s"}' "$name")" - elif [[ $alpha_mode -eq 1 ]]; then - clip_value="#${clean_hex}" + output_text="$json_obj" else - clip_value="#${clean_hex:0:6}" + output_text=$(IFS=' ' ; echo "${display_parts[*]}") + [[ -n "$name" ]] && output_text="$output_text ($name)" fi - # Terminal output — skipped in desktop mode (no terminal to write to) if [[ $desktop_mode -eq 0 ]]; then - if [[ $json_mode -eq 1 ]]; then - echo "$clip_value" - else - if [[ $alpha_mode -eq 1 ]]; then - printf "\033[2mHEX:\033[0m #%s \033[2m→ RGBA(\033[0m%3d, %3d, %3d, %3d\033[2m)\033[0m → \033[48;2;%d;%d;%dm \033[0m" \ - "$clean_hex" "$r" "$g" "$b" "$a" "$r" "$g" "$b" - else - printf "\033[2mHEX:\033[0m #%s \033[2m→ RGB(\033[0m%3d, %3d, %3d\033[2m)\033[0m → \033[48;2;%d;%d;%dm \033[0m" \ - "${clean_hex:0:6}" "$r" "$g" "$b" "$r" "$g" "$b" - fi - [[ -n "$name" ]] && printf " \033[2m→ Name:\033[0m %s" "$name" - echo + if [[ $swatch_mode -eq 1 ]]; then + local r g b + r=$(echo "$formats_json" | jq -r '._raw.r') + g=$(echo "$formats_json" | jq -r '._raw.g') + b=$(echo "$formats_json" | jq -r '._raw.b') + if [[ $json_mode -eq 1 ]]; then printf "\033[48;2;${r};${g};${b}m \033[0m\n" + else printf "\033[48;2;${r};${g};${b}m \033[0m "; fi fi + echo -e "$output_text" fi - # Non-fatal: warn if clipboard copy fails (e.g. no clipboard utility installed) - [[ $copy_mode -eq 1 ]] && copy_to_clipboard "$clip_value" || true - [[ $notify_mode -eq 1 ]] && notify_result "$clip_value" || true + [[ $copy_mode -eq 1 ]] && copy_to_clipboard "$output_text" || true + [[ $notify_mode -eq 1 ]] && notify_result "$output_text" || true } # ── Argument parsing ────────────────────────────────────────────────────────── -# Apply config defaults before processing CLI args so flags can still override them load_config - args=() +do_pick=0 + +# First pass: collect CLI overrides while [[ $# -gt 0 ]]; do case "$1" in - --help | -h) - show_help - exit 0 - ;; - --pick) - # Run the picker immediately; its output (a hex string) is queued for conversion - picked="$(run_color_picker)" || exit 1 - [[ -n "$picked" ]] && args+=("$picked") - ;; - --json) json_mode=1 ;; - --alpha) alpha_mode=1 ;; - --name) name_mode=1 ;; - --copy) copy_mode=1 ;; - --desktop) desktop_mode=1; apply_desktop_config ;; - --install) do_install; exit 0 ;; - -*) - echo "Unknown option: $1" >&2 - exit 1 - ;; - *) - args+=("$1") - ;; + --help|-h) show_help; exit 0 ;; + --output) cli_output="$2"; shift ;; + --json) cli_json=1 ;; + --no-json) cli_json=0 ;; + --alpha) cli_alpha=1; cli_output="hexa" ;; + --no-alpha)cli_alpha=0 ;; + --name) cli_name=1 ;; + --no-name) cli_name=0 ;; + --swatch) cli_swatch=1 ;; + --no-swatch)cli_swatch=0 ;; + --copy) cli_copy=1 ;; + --no-copy) cli_copy=0 ;; + --notify) cli_notify=1 ;; + --no-notify)cli_notify=0 ;; + --pick) cli_pick=1 ;; + --no-pick) cli_pick=0 ;; + --desktop) desktop_mode=1 ;; + --install) do_install; exit 0 ;; + -*) echo "Unknown option: $1" >&2; exit 1 ;; + *) args+=("$1") ;; esac shift done -# Collect any hex values piped via stdin -if [[ ! -t 0 ]]; then - while read -r line; do - [[ -n "$line" ]] && args+=("$line") - done +# Apply final hierarchy: CLI Flags > Desktop Config (if --desktop) > Default Config +if [[ $desktop_mode -eq 1 ]]; then + json_mode=${cli_json:-$desktop_json} + alpha_mode=${cli_alpha:-$desktop_alpha} + name_mode=${cli_name:-$desktop_name} + notify_mode=${cli_notify:-$desktop_notify} + output_formats=${cli_output:-$desktop_output} + copy_mode=${cli_copy:-$desktop_copy} + do_pick=${cli_pick:-1} + swatch_mode=${cli_swatch:-0} # swatch usually off in desktop mode +else + json_mode=${cli_json:-$json_mode} + alpha_mode=${cli_alpha:-$alpha_mode} + name_mode=${cli_name:-$name_mode} + notify_mode=${cli_notify:-$notify_mode} + output_formats=${cli_output:-$output_formats} + copy_mode=${cli_copy:-$copy_mode} + do_pick=${cli_pick:-0} + swatch_mode=${cli_swatch:-$swatch_mode} fi -# No colors collected: auto-pick if config requests it, otherwise show help -if [[ ${#args[@]} -eq 0 ]]; then +# Validation +validate_output_formats "$output_formats" || exit 1 + +# Stdin support +[[ ! -t 0 ]] && while read -r line; do [[ -n "$line" ]] && args+=("$line"); done + +# Execution +if [[ $do_pick -eq 1 ]]; then + picked="$(run_color_picker)" || exit 1 + [[ -n "$picked" ]] && args+=("$picked") +elif [[ ${#args[@]} -eq 0 ]]; then if [[ $config_pick -eq 1 ]]; then picked="$(run_color_picker)" || exit 1 [[ -n "$picked" ]] && args+=("$picked") elif [[ -t 0 ]]; then - show_help - exit 0 + show_help; exit 0 fi fi -# ── Execution ───────────────────────────────────────────────────────────────── - -for hex in "${args[@]}"; do - hex_to_rgba "$hex" -done +for color in "${args[@]}"; do process_color "$color"; done diff --git a/wl-colorpicker-plasma.py b/wl-colorpicker-plasma.py deleted file mode 100644 index e8333d5..0000000 --- a/wl-colorpicker-plasma.py +++ /dev/null @@ -1,20 +0,0 @@ -#!/usr/bin/python3 - -from PyQt6.QtDBus import QDBusConnection, QDBusMessage, QDBusPendingReply, QDBusPendingCallWatcher -from PyQt6.QtCore import QCoreApplication -from PyQt6.QtGui import QColor -import sys - -def colorPicked(): - reply = QDBusPendingReply(call) - if reply.isError(): - print(reply.error().message()) - else: - print(QColor(reply.argumentAt(0)[0]).name()) - -app = QCoreApplication(sys.argv) -msg = QDBusMessage.createMethodCall("org.kde.KWin", "/ColorPicker", "org.kde.kwin.ColorPicker", "pick") -call = QDBusConnection.sessionBus().asyncCall(msg) -watcher = QDBusPendingCallWatcher(call, app) -watcher.finished.connect(colorPicked) -watcher.waitForFinished()