diff --git a/COPYING.assets b/COPYING.assets new file mode 100644 index 0000000..f776039 --- /dev/null +++ b/COPYING.assets @@ -0,0 +1,87 @@ +COPYING.assets +============== + +This project uses a two-license structure. Please read this before +redistributing or forking. + + +CODE — under GPLv3 or later +--------------------------- +Everything under `cli/`, `scripts/`, `.github/`, plus files at the +repo root that are not listed under ASSETS below — is licensed under +the GNU General Public License, version 3 or later. + +Full text: see the `LICENSE` file at the repo root. + +Additional attribution requirements under GPLv3 § 7(b) are recorded +in the `NOTICE` file, which must be preserved with all redistributions. + + +ASSETS — each image has its own free-license +-------------------------------------------- +The following are NOT under GPLv3: + + - `assets/images/*.png` — car photos + - `assets/ansi/*.txt` — pre-rendered ANSI derivatives of those photos + - `assets/licenses/*.json` — per-image attribution records + +Every image was sourced from Wikimedia Commons or a similar free- +culture repository, and each carries its own individual free-license, +one of: + + - Creative Commons Zero (CC0) + - Creative Commons Attribution (CC BY, any version) + - Creative Commons Attribution-ShareAlike (CC BY-SA, any version) + - GNU Free Documentation License (GFDL) + - Public Domain + - Free Art License + - Copyrighted Free Use + +The exact license, author, source URL, and license URL for each +image is stored in `assets/licenses/.json`. A human-readable +summary of all image credits is in `CREDITS.md` at the repo root. + + +WHAT THIS MEANS FOR REDISTRIBUTION +---------------------------------- +If you redistribute this project — fork it, package it, ship a +binary bundling the assets — you MUST: + + 1. Include the `LICENSE` file (GPLv3) for the code. + 2. Include the `NOTICE` file so author attribution travels with + the work. + 3. Keep `assets/licenses/` intact. It is the attribution that + makes the images redistributable — without it, the images + lose their license validity. + 4. Preserve `CREDITS.md`. + 5. For any image licensed ShareAlike (CC BY-SA, GFDL), if you + modify that image, you must release the modified version + under the same license. + +If you're redistributing ONLY the CODE (not the images): +you only need GPLv3 + NOTICE. You don't need to comply with the +image licenses because you aren't distributing the images. + + +MANIFEST AND DATABASE +--------------------- +`manifest.json` and `data/car_database_v2.txt` are original curation +work — the mapping of slugs to metadata, brand groupings, decade +categorization, and the pipeline that produced them. They are under +GPLv3, part of the code. They do not inherit the image licenses. + + +CONTRIBUTING NEW IMAGES +----------------------- +When adding a new car via `scripts/add_car.py`, the script requires +you to declare the license explicitly. It refuses to accept images +under Fair Use, All Rights Reserved, NC (non-commercial), ND (no +derivatives), or any restrictive license. This is enforced to keep +the project fully redistributable. + + +CONCERNS +-------- +If you believe a specific image's license attribution is incorrect, +please open an issue with the slug and the correct attribution. +Licensing accuracy matters — we'll fix it quickly. diff --git a/LICENSE b/LICENSE index d939699..887721e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,58 +1,696 @@ -MIT License - -Copyright (c) 2026 Tirthraj Raval - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. - -=============================================================================== - NAMING AND ATTRIBUTION NOTICE -=============================================================================== - -The name "hypercar-colorscripts" and its visual identity are associated with -this project, authored by Tirthraj Raval. While the MIT license grants full -rights to use, modify, and redistribute the code, please rename derivative -forks to avoid confusion in the open-source ecosystem. This is a community -request, not a legal restriction. - -=============================================================================== - IMAGE ASSETS NOTICE -=============================================================================== - -The MIT license above covers source code only — the Python pipeline scripts -in scripts/ and the Go CLI in cli/. - -The image files in assets/images/, the ANSI text in assets/ansi/, and their -derivatives are each subject to their own license, attached per-image in -assets/licenses/.json and aggregated in CREDITS.md. - -The image licenses used in this collection are all free-redistribution-safe: - - - Public Domain / CC0 - - Creative Commons Attribution (CC BY, all versions) - - Creative Commons Attribution-ShareAlike (CC BY-SA, all versions) - - GNU Free Documentation License (GFDL, all versions) - - Free Art License - -No image in this collection uses a NonCommercial, NoDerivatives, "All rights -reserved", or fair-use license. - -When redistributing this project or any of its images, you MUST preserve the -per-image attribution. The simplest way to do this is to keep the -assets/licenses/ directory and the generated CREDITS.md file with the -distribution. \ No newline at end of file +hypercar-colorscripts — random hypercar art in your terminal +Copyright (C) 2026 Tirthraj Raval + +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, subject to the additional terms +under GPLv3 section 7 recorded in the NOTICE file. + +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 . + +Note: this LICENSE covers the CODE only. The images bundled in +assets/ are each licensed individually under a free-culture license +(CC0, CC BY, CC BY-SA, GFDL, PD, Free Art, or Copyrighted Free Use). +See COPYING.assets and CREDITS.md for details. + + 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/NOTICE b/NOTICE new file mode 100644 index 0000000..3cc6bfe --- /dev/null +++ b/NOTICE @@ -0,0 +1,87 @@ +NOTICE +====== + +hypercar-colorscripts + +One of the first open-source initiatives to bring curated automotive +art to terminal startup screens. Inspired by pokemon-colorscripts. + +Copyright (C) 2026 Tirthraj Raval +Original author and maintainer: Tirthraj Raval +Project home: https://github.com/Tirthraj-Raval/hypercar-colorscripts + +------------------------------------------------------------------------ + +Additional terms under GPLv3 section 7(b) +------------------------------------------ + +Per GPLv3 section 7(b), the following attribution requirements apply +to this work. They exist to preserve credit to the original curation +work as this project travels through forks and derivatives. + + 1. This NOTICE file must be preserved unmodified in all + redistributions of the source code and included with all + compiled / binary distributions. + + 2. Any fork, port, or derived work must include the following + line, verbatim, in either its LICENSE, NOTICE, README, or + an equivalent user-visible location: + + Based on hypercar-colorscripts by Tirthraj Raval — + https://github.com/Tirthraj-Raval/hypercar-colorscripts + + 3. When redistributing a modified version, please clearly + indicate that the work has been modified — for example, by + renaming the project or labeling it as a fork in your README. + +These terms do not restrict any of the freedoms granted by GPLv3. +You may still freely use, modify, distribute, and sell derivative +works of this software. The requirements above only ask that the +original curation effort remain visible in the chain of attribution. + +Contributions of any size are welcome and warmly received — issues, +pull requests, new cars, alias entries, translations. Attribution +requirements apply to redistribution, not to using the software or +contributing back to it. + +------------------------------------------------------------------------ + +Image attribution +----------------- + +Every image bundled with this project carries its own free-license. +See `assets/licenses/.json` for per-image attribution records, +or `CREDITS.md` for a human-readable summary. See `COPYING.assets` +for the full explanation of the code-vs-assets licensing split. + +------------------------------------------------------------------------ + +Third-party components and inspirations +--------------------------------------- + + - pokemon-colorscripts by phoneybadger + https://gitlab.com/phoneybadger/pokemon-colorscripts + (Concept of "art in your terminal on every session" — the spark + that made this project possible.) + + - chafa by Hans Petter Jansson + https://hpjansson.org/chafa/ + (Universal terminal image rendering. Used at runtime for image + display and in the contributor pipeline for ANSI generation.) + + - fastfetch + https://github.com/fastfetch-cli/fastfetch + (System info alongside the car / pokemon at terminal startup.) + + - rembg by Daniel Gatis + https://github.com/danielgatis/rembg + (Background removal in the contributor asset pipeline.) + + - Wikimedia Commons and its contributors + (Source of every image bundled with this project. This project + is a curation on top of their generous work.) + +Thank you to everyone who contributes, forks, and shares this +project. Automotive terminal art deserves a place in the ricing +community, and none of it would exist without the free-culture +photographers whose work fills `assets/`. diff --git a/README.md b/README.md index 8afd85e..945d6f1 100644 --- a/README.md +++ b/README.md @@ -1,267 +1,576 @@ -# hypercar-colorscripts +

hypercar-colorscripts

+ +

+ Random hypercar art in your terminal.
+ One of the first open-source projects to bring curated automotive art to terminal startup screens.
+ 633 curated cars across 24 brands, verified free-license, mixed with system info via fastfetch. +

+ +

+ +

+ +

+ Install · + Usage · + Vintage · + Contribute · + Troubleshooting · + License +

-Print a random hypercar in your terminal — inspired by -[pokemon-colorscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts). +--- + +## What is this? -633 hand-curated cars across 24 brands (Ferrari, Lamborghini, Porsche, McLaren, -Bugatti, Koenigsegg, Pagani, Rimac, and more). Real Kitty graphics protocol -images in supported terminals, high-quality ANSI block art everywhere else. -Every image is properly licensed (CC, Public Domain, GFDL) with full -attribution baked in. +Inspired by [pokemon-colorscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts), `hypercar-colorscripts` prints a random hypercar every time you open a terminal — a Ferrari F40 one time, a Bugatti Chiron the next, a McLaren F1 the one after. Sourced from Wikimedia Commons, backgrounds cleanly removed, letterboxed to a consistent 512×256 canvas. -![demo placeholder](docs/demo.png) +- **In image-capable terminals** (Kitty, Ghostty, WezTerm, iTerm2), you see a real photo of the car via the Kitty graphics protocol. +- **In every other terminal** (git bash, GNOME Terminal, plain xterm), you see hand-rendered ANSI block art of the same car. +- **If you have `pokemon-colorscripts` installed too**, both mix ~50/50 in your terminal startup (opt-in during install, toggle with `--set-mix on|off`). + +The tool is a single Go binary. Nothing runs in the background. Nothing writes outside `$HOME` unless you install with `--system`. ## Features -- **633 cars**, hand-curated and license-audited -- **Real images** in Kitty / Ghostty / WezTerm via chafa's graphics protocol -- **ANSI block-art fallback** for plain terminals (pre-generated, instant) -- **Rich metadata** — filter by brand, decade, category, powertrain, country -- **Pokemon mixing** — optional 50/50 mix with `pokemon-colorscripts` -- **fastfetch-compatible** — pipe into fastfetch for system info beside the car -- **Single dependency**: `chafa` (system package on every major distro) -- **All free-redistribution licensed** image assets +- **633 cars, 24 brands, 1940s → 2020s.** Ferrari, Lamborghini, McLaren, Pagani, Koenigsegg, Bugatti, Porsche, Rolls-Royce, Aston Martin, Lotus, Rimac, Hennessey, plus Japanese and American icons. +- **Every image is free-license.** CC0, CC BY, CC BY-SA, GFDL, Public Domain, or Free Art. Every image ships with a JSON attribution file. See [`CREDITS.md`](CREDITS.md). +- **Smart lookup.** Type `--car chiron` or `--car "rolls royce ghost"` or `--car "porsche 911"` — it resolves aliases, matches by tokens, corrects typos, and shows a numbered picker when multiple cars fit. +- **Real images or ANSI fallback**, chosen automatically based on your terminal's capabilities. Force one mode with `--set-mode auto|ansi`. +- **Pokemon mixing is opt-in.** The installer asks; you can toggle later with `--set-mix on|off`. +- **Vintage cars are opt-in.** Default install is modern (2000+). Add pre-2000 cars any time with `./install-vintage.sh`. +- **`--doctor`** health check tells you exactly what's wrong when something isn't working. +- **Contributor scripts** for adding new cars (`add_car.py`) or replacing existing images (`manual_override.py`) with automated background removal and license validation. +- **Zero background daemons, zero telemetry, zero non-standard paths.** Uses XDG directories. + +## Preview + +
+Terminal startup — random car with fastfetch beside it + +

+ Terminal startup preview +

+
+ +
+Named lookup — hypercar-colorscripts --car chiron + +

+ Named car preview +

+
+ +
+Numbered picker — hypercar-colorscripts --car "porsche 911" + +``` +Multiple matches for "porsche 911": + 1) porsche_911_carrera_992 911 Carrera (992) 2019–2024 + 2) porsche_911_gt3_rs_992 911 GT3 RS (992) 2022–2024 + 3) porsche_911_gt2_rs_991 911 GT2 RS (991.2) 2018 + 4) porsche_911_gt3_992 911 GT3 (992) 2021–2024 + 5) porsche_911_turbo_s_992 911 Turbo S (992) 2020–2024 + 6) porsche_911_dakar 911 Dakar 2022–2024 + 7) porsche_911_r_991 911 R (991.2) 2016 + 8) porsche_911_carrera_rs_2_7 911 Carrera RS 2.7 1973 + 9) porsche_911_carrera_964 911 Carrera (964) 1989–1994 + 10) porsche_911_gt1_strassenversion 911 GT1 Straßenversion 1998 + +Pick [1-10, q to quit]: +``` +
+ +
+List brands — hypercar-colorscripts --list-brands + +``` + Aston Martin 28 cars 1948–2024 + Audi Sport 19 cars 1980–2024 + BMW M 22 cars 1972–2024 + Bugatti 15 cars 1909–2024 + Ferrari 91 cars 1947–2024 + Ford 9 cars 1964–2017 + Koenigsegg 12 cars 1994–2024 + Lamborghini 73 cars 1963–2024 + ... + +24 brands, 633 cars total +``` +
-## Requirements +## Prerequisites -- Linux (tested on Fedora 44; works on any distro) -- `chafa` — `sudo dnf install chafa` (Fedora) / `sudo apt install chafa` (Debian) -- Go 1.22+ — only for building from source -- Optional: `pokemon-colorscripts` for random mixing +| Tool | Required? | Purpose | +|------|-----------|---------| +| `chafa` | **required** | image rendering + ANSI generation | +| `fastfetch` | recommended | system info beside the car | +| `pokemon-colorscripts` | optional | enables 50/50 pokemon+car mix at terminal startup | +| `python3` | required for install | asset filtering, contributor scripts | +| `git` | required | to clone the repo | -## Install +Install commands per distribution: + +
+Fedora / RHEL + +```bash +sudo dnf install chafa fastfetch python3 git +``` +
+ +
+Debian / Ubuntu ```bash -git clone https://github.com/tirthrajraval/hypercar-colorscripts.git +sudo apt install chafa fastfetch python3 git +``` +
+ +
+Arch / Manjaro + +```bash +sudo pacman -S chafa fastfetch python git +``` +
+ +
+macOS (Homebrew) + +```bash +brew install chafa fastfetch python git +``` +
+ +**`pokemon-colorscripts`** is not in any distro repo. Install separately if you want the mixing feature — see the [project page](https://gitlab.com/phoneybadger/pokemon-colorscripts). + +## Quick install + +```bash +git clone https://github.com/Tirthraj-Raval/hypercar-colorscripts.git cd hypercar-colorscripts/cli make build ./install.sh ``` -The interactive installer: -1. Asks default rendering mode (auto / ANSI-only) -2. Asks about pokemon mixing if `pokemon-colorscripts` is on PATH -3. Asks where to install the binary -4. Copies assets to `~/.local/share/hypercar-colorscripts/` -5. Writes config to `~/.config/hypercar-colorscripts/config.json` +The installer asks these questions: + +1. **Rendering mode** — `auto` (image when possible, ANSI otherwise) or `ansi` (always ANSI) +2. **Include vintage cars?** — pre-2000 cars, ~15 MB extra (default: no; add later with `./install-vintage.sh`) +3. **Mix pokemon with cars?** — only asked if `pokemon-colorscripts` is installed (toggle later with `--set-mix on|off`) +4. **Which shell rc files** — installs into your login shell's rc by default; offers to also install into secondary shells if present + +Open a new terminal — you should see a car (or a pokemon, if you enabled mixing). + +Verify the install: + +```bash +hypercar-colorscripts --doctor +``` + +Green checks mean everything is set up. Yellow circles mark optional things missing. Red X's tell you what to fix. + +## Usage + +### Random car (the default) + +```bash +hypercar-colorscripts +``` + +This is what runs at terminal startup. Bare invocation picks a random car from all installed cars. -## Commands +### Named car — smart lookup -### Print a car +Any of these work: ```bash -hypercar-colorscripts # random car (or pokemon if mixing on) -hypercar-colorscripts --car ferrari_f40 # specific car +hypercar-colorscripts --car chiron # alias → bugatti_chiron +hypercar-colorscripts --car "rolls royce ghost" # alias → rr_ghost_2nd_gen +hypercar-colorscripts --car F40 # normalized → ferrari_f40 +hypercar-colorscripts --car "huayra bc" # tokens → pagani_huayra_bc +hypercar-colorscripts --car bugati_chiron # typo → bugatti_chiron (Levenshtein) +hypercar-colorscripts --car "porsche 911" # ambiguous → picker ``` -### Filters +The matcher tries these strategies in order and stops at the first hit: exact slug, alias map, case-insensitive slug, normalized slug, model-field match, token overlap, edit distance. If several cars tie, you get a numbered picker. + +### Filter and roll ```bash -hypercar-colorscripts --brand lamborghini # -b lamborghini -hypercar-colorscripts --decade 1990s # -d 1990s -hypercar-colorscripts --category Hypercar # -c Hypercar -hypercar-colorscripts --powertrain "V12 NA" # -p "V12 NA" +hypercar-colorscripts --brand Ferrari # random Ferrari +hypercar-colorscripts --brand Lamborghini --decade 1980s +hypercar-colorscripts --category Hypercar +hypercar-colorscripts --powertrain "V12 NA" hypercar-colorscripts --country Italy -hypercar-colorscripts --search huayra # substring match -hypercar-colorscripts --brand porsche --decade 2010s # combine filters +hypercar-colorscripts --decade 2020s --category Hypercar +``` + +Filters combine — the last example rolls a random 2020s hypercar. + +### Discovery + +```bash +hypercar-colorscripts --list-brands # every brand with car count + year range +hypercar-colorscripts --list-decades # 1940s..2020s with vintage/modern label +hypercar-colorscripts --list-categories # hypercar, supercar, GT, muscle, etc. +hypercar-colorscripts --search chiron # substring search across slugs +``` + +### Info and attribution + +```bash +hypercar-colorscripts --info ferrari_f40 +# Prints: brand, model, years, category, powertrain, country + +hypercar-colorscripts --license ferrari_f40 +# Prints: license, author, source URL, license URL +``` + +`--info` and `--license` accept the same smart matching as `--car`, so `--info chiron` works too. + +### Toggle rendering mode + +If you picked `auto` at install but you're on a terminal that doesn't render images well, switch to ANSI: + +```bash +hypercar-colorscripts --set-mode ansi +# open a new terminal — now shows ANSI text art everywhere +``` + +Switch back: + +```bash +hypercar-colorscripts --set-mode auto ``` -### Rendering +### Toggle pokemon mixing ```bash -hypercar-colorscripts --auto # chafa when available (default) -hypercar-colorscripts --ansi-only # pre-generated text only -hypercar-colorscripts --image-only # force chafa -hypercar-colorscripts --attribution # -a — show CC credit -hypercar-colorscripts --no-newline # no trailing newline (zshrc-friendly) +hypercar-colorscripts --set-mix off # cars only +hypercar-colorscripts --set-mix on # 50/50 mix (requires pokemon-colorscripts) ``` -### Pokemon +### Health check ```bash -hypercar-colorscripts --pokemon-only # one random pokemon -hypercar-colorscripts --with-pokemon # this run rolls 50/50 -hypercar-colorscripts --no-pokemon # disable mixing this run +hypercar-colorscripts --doctor ``` -### Listings +Reports: +- System dependencies (chafa, fastfetch, pokemon-colorscripts) +- Terminal graphics-protocol support +- Config file location and contents +- Manifest integrity + asset file counts +- Shell rc integration status +- Effective pokemon-mixing state (combining pokemon-colorscripts availability, shell block presence, and `pokemon_mix` config) + +Use this first when troubleshooting. + +### Complete command reference + +| Command | What it does | +|---------|--------------| +| `hypercar-colorscripts` | Random car | +| `--car ` | Show a specific car (smart matching) | +| `--brand ` | Filter by brand | +| `--decade s` | Filter by decade (e.g. `1980s`, `2020s`) | +| `--category ` | Filter by category | +| `--powertrain ` | Filter by powertrain | +| `--country ` | Filter by manufacturer's country | +| `--search ` | Substring search across slugs | +| `--info ` | Show car metadata | +| `--license ` | Show image attribution | +| `--list-brands` | List all brands with counts | +| `--list-decades` | List all decades with counts | +| `--list-categories` | List all categories with counts | +| `--set-mode auto\|ansi` | Change default rendering mode | +| `--set-mix on\|off` | Toggle pokemon mixing in shell startup | +| `--doctor` | Environment health check | +| `--no-newline` | Suppress trailing newline (for shell prompts) | +| `--data-dir ` | Override the data directory | +| `--help` | Full CLI help | + +## Vintage cars + +Vintage = pre-2000. Off by default because most people want modern cars. + +**Add vintage cars** to an existing install: ```bash -hypercar-colorscripts --list # all cars (table) -hypercar-colorscripts --list-brands # unique brands -hypercar-colorscripts --list-decades -hypercar-colorscripts --list-categories -hypercar-colorscripts --list-powertrains -hypercar-colorscripts --list-countries -hypercar-colorscripts --list-licenses # license histogram +cd path/to/hypercar-colorscripts/cli +./install-vintage.sh ``` -### Inspection +Shows disk impact (~15 MB), asks confirmation, adds the cars. Idempotent — safe to re-run. + +**Remove vintage cars** from an existing install: ```bash -hypercar-colorscripts --info ferrari_f40 # full metadata -hypercar-colorscripts --license ferrari_f40 # just attribution -hypercar-colorscripts --count --brand ferrari # how many? -hypercar-colorscripts --doctor # diagnostics -hypercar-colorscripts --version -hypercar-colorscripts --help +./uninstall-vintage.sh ``` -Mutually exclusive flag groups: `{--auto, --ansi-only, --image-only}` and -`{--with-pokemon, --no-pokemon, --pokemon-only}`. +Works even without the cloned repo — operates entirely on `~/.local/share/hypercar-colorscripts/`. To bring vintage back later, re-run `./install-vintage.sh` from the cloned repo. -## Terminal startup integration +## Terminal support -Print a random car or pokemon with fastfetch system info beside it on every -terminal open. Add to `~/.zshrc`: +| Terminal | Rendering | Notes | +|----------|-----------|-------| +| Kitty | Real image | Reference platform | +| Ghostty | Real image | Kitty-compatible graphics | +| WezTerm | Real image | Detected via `TERM_PROGRAM` | +| iTerm2 (macOS) | Real image | Kitty-compatible | +| GNOME Terminal | ANSI text | Falls back cleanly | +| Konsole | ANSI text | Falls back cleanly | +| xterm | ANSI text | Falls back cleanly | +| git bash (Windows) | ANSI text | Falls back cleanly | +| WSL2 + Windows Terminal | ANSI text | No image protocol available | +| macOS Terminal.app | ANSI text | Falls back cleanly | + +Detection is automatic and happens at every terminal startup. No config needed. + +## Shell integration + +`install.sh` writes a marker-bracketed block into your `.zshrc` (or `.bashrc`, or both, depending on what you pick): ```bash # >>> hypercar-colorscripts >>> -if [ $((RANDOM % 2)) -eq 0 ]; then - pokemon-colorscripts --no-title -s -r | \ - fastfetch -c $HOME/.config/fastfetch/config-pokemon.jsonc \ - --logo-type file-raw --logo-height 10 --logo-width 5 --logo - -else - IMG=$(ls $HOME/.local/share/hypercar-colorscripts/assets/images/*.png \ - 2>/dev/null | shuf -n 1) - [ -n "$IMG" ] && \ - fastfetch -c $HOME/.config/fastfetch/config-pokemon.jsonc \ - --logo-type kitty --logo-height 10 --logo-width 25 --logo "$IMG" -fi +# ... 30 lines of portable shell that: +# - reads default_mode and pokemon_mix from config.json +# - detects terminal graphics-protocol support at runtime +# - rolls ~50% pokemon (if enabled AND pokemon-colorscripts installed), else car +# - picks image or ANSI based on terminal + mode # <<< hypercar-colorscripts <<< ``` -Tune `--logo-height` and `--logo-width` to taste. +The block is portable — same code works in both bash and zsh. Uninstall removes it byte-for-byte with backups. Any existing `pokemon-colorscripts` startup line gets commented with a marker at install and un-commented at uninstall. + +Nothing else in your rc file is touched. Ever. ## Configuration -`~/.config/hypercar-colorscripts/config.json`: +Location: `~/.config/hypercar-colorscripts/config.json` ```json { - "data_dir": "/home/user/.local/share/hypercar-colorscripts", + "data_dir": "/home/you/.local/share/hypercar-colorscripts", "default_mode": "auto", + "pokemon_mix": true, "with_pokemon": false, "pokemon_ratio": 0.5, "show_attribution": false } ``` -| Key | Values | Effect | -|---|---|---| -| `default_mode` | `auto` / `ansi` | Render mode when no flag given | -| `with_pokemon` | bool | Bare invocations may roll a pokemon | -| `pokemon_ratio` | 0.0–1.0 | Pokemon roll probability | -| `show_attribution` | bool | Always print CC credit | +| Field | Purpose | Values | +|-------|---------|--------| +| `data_dir` | Where the manifest and assets live | absolute path | +| `default_mode` | Rendering preference for terminal startup | `"auto"`, `"ansi"` | +| `pokemon_mix` | Whether the shell block mixes pokemon 50/50 | `true`, `false` | +| `with_pokemon` | Deprecated, unused | leave as `false` | +| `pokemon_ratio` | Reserved for future use | `0.0` – `1.0` | +| `show_attribution` | Print image credit under each car | `true`, `false` | -Override the data dir with `--data-dir` or `$HYPERCAR_DATA_DIR`. +Prefer editing via `--set-mode` and `--set-mix` when possible. -**Note:** Explicit selection (`--car`, `--brand`, etc.) always overrides the -pokemon roll. The dice only roll for bare invocations. +## Contributing -## Project structure +Contributions are welcome — new cars, replacement images, common-name aliases, translations, bug fixes. + +### Adding a new car + +1. Find a photo on **Wikimedia Commons** with a safe license (CC0, CC BY, CC BY-SA, GFDL, Public Domain, Free Art). Not sure what's safe? The script will reject unsafe licenses. +2. Copy the direct file URL (right-click the image → "Copy image address"). +3. Run: +```bash +python scripts/add_car.py \ + --slug ferrari_f80 \ + --brand Ferrari --model "F80" \ + --start-year 2024 --end-year 2025 \ + --category Hypercar --powertrain "V6 Hybrid" \ + --image-url https://upload.wikimedia.org/.../F80.jpg \ + --license "CC BY-SA 4.0" \ + --author "Photographer Name" \ + --source-url https://commons.wikimedia.org/wiki/File:F80.jpg ``` -hypercar-colorscripts/ -├── assets/ 633 PNGs + 633 ANSI files + 633 license JSONs -├── cli/ Go source for the binary -├── data/ car_database_v2.txt + pilot_cars.txt -├── scripts/ Python pipeline (20 files) -├── manifest.json Generated index -├── CREDITS.md Auto-generated attribution -└── README.md This file + +Or run without args to be prompted interactively. Or batch-add many cars from a pipe-delimited file with `--batch new_cars.txt`. + +The script downloads the image, removes the background with rembg, letterboxes to 512×256, generates ANSI art with chafa, writes the license JSON, and inserts the entry into `data/car_database_v2.txt`. + +After adding cars: + +```bash +python scripts/audit_licenses.py # confirms every license is safe +python scripts/build_manifest.py # rebuilds manifest.json +cd cli && ./install.sh # updates installed assets ``` -## Building from source +### Replacing an existing car's image + +Use `manual_override.py` instead of `add_car.py`: ```bash -cd cli -go mod tidy -make build # produces ./hypercar-colorscripts -make test # run Go tests -make clean # remove the binary +python scripts/manual_override.py \ + bugatti_chiron ~/Downloads/new_chiron.jpg \ + --source-url "https://commons.wikimedia.org/wiki/File:new_chiron.jpg" \ + --license "CC BY-SA 4.0" \ + --author "New Photographer" ``` -For development with project-root assets: +The script backs up the old files with a `_replaced` suffix and validates the new image. + +### Contributing common-name aliases + +The alias map in `cli/internal/cmd/aliases.go` maps casual names ("chiron", "rolls royce ghost", "F40") to canonical slugs. Add a new entry, rebuild with `cd cli && go build .`, then PR. + +## Uninstalling ```bash -HYPERCAR_DATA_DIR=$(realpath ..) ./cli/hypercar-colorscripts --doctor +cd path/to/hypercar-colorscripts/cli +./uninstall.sh ``` -## Regenerating assets +Prompts: +1. Uninstall **only** hypercar-colorscripts (option 1, default) +2. Uninstall **both** hypercar-colorscripts and pokemon-colorscripts (option 2) + +Removes: the binary, `~/.local/share/hypercar-colorscripts/`, `~/.config/hypercar-colorscripts/`, our marker-bracketed blocks in rc files. + +Restores: any `pokemon-colorscripts` startup line that install.sh commented out. + +Preserves: your `PATH` exports, every other line in your rc files, everything under `~/.config/` that isn't ours, timestamped backups of your rc files. + +## Troubleshooting -The full pipeline (Wikimedia → curated assets) is in `scripts/`. You don't -need to run it — the curated outputs ship in `assets/`. If you want to add -cars or rebuild: +Always start with: ```bash -python scripts/wikidata_fetcher.py -python scripts/master_fetcher.py -python scripts/download_selected.py -python scripts/remove_backgrounds.py # use a GPU machine if possible -python scripts/validate_rembg.py -python scripts/manual_override.py # interactive: pick replacements -python scripts/generate_png.py -python scripts/generate_ansi.py -python scripts/audit_licenses.py -python scripts/fill_license_urls.py -python scripts/generate_credits.py -python scripts/build_manifest.py +hypercar-colorscripts --doctor ``` -## Contributing +Common issues: -Contributions welcome. Please: - -1. **Fork** the repo and create a branch from `main`: - `git checkout -b fix/something` or `feat/something` -2. **For new cars:** - - Add the slug + metadata to `data/car_database_v2.txt` (proper brand/decade - section, pipe-delimited format) - - Add the slug to `data/pilot_cars.txt` - - Re-run the relevant pipeline scripts and verify with - `python scripts/audit_licenses.py` (must print "SAFE TO SHIP") - - Commit the new `assets/images/.png`, `assets/ansi/.txt`, - `assets/licenses/.json`, and the regenerated `manifest.json` -3. **For code changes:** - - Go: keep `go fmt ./...` clean; run `make test` - - Python: PEP 8, type-hint where reasonable -4. **Test locally** with `--doctor` and a few manual renders -5. **Open a Pull Request** with a clear description of what changed and why -6. **License compliance:** image assets MUST be CC / CC0 / PD / GFDL / Free - Art. NC, ND, fair-use, or "all rights reserved" sources will be rejected. - -For bug reports, include `hypercar-colorscripts --doctor` output and your -terminal emulator name. - -## Naming and forks - -The name **hypercar-colorscripts** and its assets are associated with this -project. If you fork to make a derivative work, please rename it (e.g. -`supercar-scripts`, `racecar-term`) to avoid confusion. The MIT license -grants full code-usage rights, but the project name itself is part of its -identity. This is a request, not a legal restriction. +
+Nothing appears when I open a new terminal -## License +Check that the block was added to your rc file: + +```bash +grep -n "hypercar-colorscripts" ~/.zshrc ~/.bashrc 2>/dev/null +``` -- **Code** (Python pipeline + Go CLI): MIT. See `LICENSE`. -- **Images**: each photo carries its own license (CC BY, CC BY-SA, CC0, PD, - GFDL, or Free Art). Per-image attribution is in `assets/licenses/.json` - and aggregated in `CREDITS.md`. Run `hypercar-colorscripts --license ` - for one car's credit. +Should show marker lines. If empty, re-run `./install.sh` and answer Y at the "Proceed?" prompt. -If you spot an attribution error, please open an issue. +Verify the binary is on your PATH: -## Acknowledgments +```bash +which hypercar-colorscripts +``` +
-- [pokemon-colorscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts) - by phoneybadger — the inspiration -- [chafa](https://hpjansson.org/chafa/) by Hans Petter Jansson — terminal - image rendering -- [rembg](https://github.com/danielgatis/rembg) — background removal -- [Wikimedia Commons](https://commons.wikimedia.org) — image source -- Everyone who contributed photos under free licenses +
+I see ANSI text but I expected a real image ---- +Your terminal probably doesn't support the Kitty graphics protocol. Run `--doctor` — the "image protocol" line will say what it detected. Try Kitty, Ghostty, WezTerm, or iTerm2 (macOS). +
+ +
+Install script wrote to .bashrc but I use zsh + +Happens if you ran `./install.sh` from VS Code's integrated bash terminal. Fixed in the current version by detecting the login shell via `getent passwd $USER`. Uninstall + reinstall from your regular terminal. +
+ +
+Vintage install fails saying "must run from cloned repo" + +`install-vintage.sh` needs the source assets. If you deleted the clone, re-clone it and run `install-vintage.sh` from that fresh clone. +
+ +Still stuck? [Open an issue](../../issues) with the full output of `hypercar-colorscripts --doctor`. + +## Project structure + +``` +hypercar-colorscripts/ +├── README.md ← you are here +├── LICENSE ← GPLv3 (code license) +├── NOTICE ← attribution requirements +├── COPYING.assets ← code-vs-asset licensing explanation +├── CREDITS.md ← per-image attribution summary +├── manifest.json ← 633 cars, generated by build_manifest.py +│ +├── assets/ +│ ├── images/ ← 512×256 PNGs, one per car +│ ├── ansi/ ← pre-rendered ANSI text art +│ └── licenses/ ← per-car JSON attribution files +│ +├── cli/ ← the Go binary + install scripts +│ ├── install.sh +│ ├── uninstall.sh +│ ├── install-vintage.sh +│ ├── uninstall-vintage.sh +│ ├── _vintage_helper.py ← shared logic for vintage scripts +│ ├── Makefile +│ ├── go.mod / go.sum +│ ├── main.go +│ └── internal/ +│ ├── cmd/ ← cobra commands + matcher + doctor +│ ├── config/ ← config.json parsing +│ ├── manifest/ ← manifest.json parsing +│ ├── pokemon/ ← pokemon-colorscripts integration +│ ├── renderer/ ← chafa invocation +│ └── terminal/ ← terminal detection +│ +├── data/ +│ ├── car_database_v2.txt ← human-editable source of truth +│ ├── pilot_cars.txt ← which cars to fetch +│ └── aliases_source.md ← notes for the alias map +│ +├── scripts/ ← Python pipeline (20 scripts) +│ ├── add_car.py ← contributor: add new cars +│ ├── manual_override.py ← contributor: replace existing images +│ ├── build_manifest.py +│ ├── audit_licenses.py +│ ├── generate_ansi.py +│ ├── generate_png.py +│ ├── remove_backgrounds.py ← rembg wrapper +│ └── ... +│ +└── .github/workflows/ + └── ci.yml ← go build + python + shellcheck +``` + +## Credits + +**Every image in this project is redistributable under its own free license.** Full attribution for each car is in `assets/licenses/.json` and summarized in `CREDITS.md`. Wikimedia Commons and its contributors deserve most of the credit — this project is a curation on top of their work. + +The project itself draws inspiration from [pokemon-colorscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts) by phoneybadger — the concept of "art in your terminal on every session" is theirs. This is a spiritual sibling for the automotive-adjacent crowd. + +Terminal image rendering uses [chafa](https://hpjansson.org/chafa/) by Hans Petter Jansson. System info alongside images uses [fastfetch](https://github.com/fastfetch-cli/fastfetch). Background removal in the contributor pipeline uses [rembg](https://github.com/danielgatis/rembg). + +## Related projects + +- [pokemon-colorscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts) — the direct inspiration +- [fastfetch](https://github.com/fastfetch-cli/fastfetch) — system info alongside logos +- [chafa](https://hpjansson.org/chafa/) — universal terminal image rendering +- [pipes.sh](https://github.com/pipeseroni/pipes.sh) — another terminal-beauty classic + +## License + +The **code** in this repository is licensed under the **GNU General Public License, version 3 or later** (GPLv3+), with additional attribution requirements under GPLv3 §7(b) recorded in [NOTICE](NOTICE). See [LICENSE](LICENSE) for the full text. + +The **images** under `assets/images/` (and their pre-rendered ANSI counterparts under `assets/ansi/`) are each licensed individually under a free-culture license — CC0, CC BY, CC BY-SA, GFDL, Public Domain, Free Art, or Copyrighted Free Use. Per-image attribution is in `assets/licenses/.json` and summarized in [CREDITS.md](CREDITS.md). See [COPYING.assets](COPYING.assets) for the full explanation. + +**In short:** -Made by [Tirthraj Raval](https://github.com/tirthrajraval). \ No newline at end of file +- ✅ Use, modify, redistribute, or fork the code — freely, personally or commercially +- ✅ Contribute back — issues, PRs, new cars, aliases, translations — all warmly welcomed +- 🙏 If you fork or build on this work, please preserve the [NOTICE](NOTICE) file — as one of the first projects to bring curated car art to terminal startup, we'd like the origin to travel with derivatives +- 📸 If you redistribute the images, keep `assets/licenses/` intact so each photographer gets proper credit +- 🔀 Modified versions should be clearly labeled as forks (rename, or note in your README) — this is a friendly request, not a legal blocker