commit b5fde031775321d2b3f8311261a0d9ed1b7aea99 Author: Robert Vokac Date: Sat Jul 27 23:57:14 2024 +0200 Initial commit diff --git a/.bitbackup.sqlite3 b/.bitbackup.sqlite3 new file mode 100644 index 0000000..b5d7d78 Binary files /dev/null and b/.bitbackup.sqlite3 differ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..afcb8b1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,15 @@ +#files to ignore + +*.metadata/** +*.recommenders/** +*target/** +*build/** +*.idea/** +*.iml + +#*.class +/target/ + +/nbproject/ +*nbactions.xml + diff --git a/CREDITS b/CREDITS new file mode 100644 index 0000000..edd4511 --- /dev/null +++ b/CREDITS @@ -0,0 +1,16 @@ + This file partially lists people, that have contributed to + the "Sprite Utils" project. They are sorted by name. + The fields are: name (N), e-mail (E), web-address (W), + PGP key ID and fingerprint (P), description (D) and + snail-mail address (S). + Thanks, + + Vokac +---------- + +N: Robert Vokac +E: mail@robertvokac.com +W: https://nanoboot.org +P: 4096R/E3329055 322B D109 0AA8 C324 EA9C 72F5 693D 30BE E332 9055 +D: Founder +S: Czech Republic diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..58afb36 --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,114 @@ +pipeline +/* +Sprite Utils + +Requirements: + +Maven is Installed + +Java 21 is installed - variable JAVA_21_HOME is set + +*/ +{ + agent any + environment { + AAA = 'aaa' + } + stages + { + stage('Build') + { + steps { + + echo "*** Building ${env.JOB_NAME} ***" + sh ''' + #!/bin/bash + echo JOB_NAME=$JOB_NAME + + if [ -z "$JAVA_21_HOME" ] + then + echo "KO : Variable JAVA_21_HOME is empty. You fix this issue by adding this variable to configuration of Jenkins." + exit 1 + else + echo "OK : Variable JAVA_21_HOME is NOT empty" + fi + export JAVA_HOME=$JAVA_21_HOME + case $BRANCH_NAME in + + master | deploy_prod) + mvn clean install + ;; + + develop | jenkins | deploy_test) + echo Branch $BRANCH_NAME is supported. Continuing. + version=`mvn help:evaluate -Dexpression=project.version -q -DforceStdout` + echo version=$version + case "$version" in + *"SNAPSHOT"*) echo echo version is OK ;; + * ) echo echo "You cannot build releases on Jenkins, only snapshots!"&&exit 1 ;; + esac + mvn clean deploy + ;; + + *) + echo Branch $BRANCH_NAME is not supported. A failure happened. Exiting. + exit 1 + ;; + esac + + echo "Build of $JOB_NAME was successful" + ''' + } + } + + stage('Deploy') + { + steps { + echo "*** Deploying ${env.JOB_NAME} ***" + + sh ''' + #!/bin/bash + + echo "Nothing to do" + exit + + case $BRANCH_NAME in + + master | deploy_prod) + echo Branch $BRANCH_NAME is supported. Continuing. + TOMCAT_HOME=$TOMCAT10_HOME + systemdService=tomcat10 + ;; + + develop | jenkins | deploy_test) + echo Branch $BRANCH_NAME is supported. Continuing. + TOMCAT_HOME=$TOMCAT10_TEST_HOME + systemdService=tomcat10test + ;; + + *) + echo Branch $BRANCH_NAME is not supported. A failure happened. Exiting. + exit 1 + ;; + esac + + ''' + + } + } + } + post { + always { + script { + env.color = "${currentBuild.currentResult == 'SUCCESS' ? 'green' : 'red'}" + } + + echo 'Sending e-mail.' + sh "printenv | sort" + emailext body: "${currentBuild.currentResult} - ${env.JOB_NAME} (#${env.BUILD_NUMBER})
", + recipientProviders: [[$class: 'DevelopersRecipientProvider'], [$class: 'RequesterRecipientProvider']], + subject: "Jenkins Build - ${currentBuild.currentResult} - $JOB_NAME (#$BUILD_NUMBER)" + + } + } +} diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENCE @@ -0,0 +1,674 @@ + 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..1b96c3e --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# sprite-utils diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..b39292e --- /dev/null +++ b/build.sh @@ -0,0 +1 @@ +mvn clean install diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..75d556b --- /dev/null +++ b/pom.xml @@ -0,0 +1,219 @@ + + + + 4.0.0 + + + org.nanoboot.essential + nanoboot-parent + 0.1.1-SNAPSHOT + + + org.nanoboot.utils + sprite-utils + 0.0.0-SNAPSHOT + jar + + Sprite Utils + Tools used to work with sprites + + + UTF-8 + true + 2.0.1-SNAPSHOT + + + + + + + org.apache.maven.plugins + maven-deploy-plugin + ${maven-deploy-plugin.version} + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + ${maven-compiler-plugin.version} + + + + + org.projectlombok + lombok + ${lombok.version} + + + ${javase.version} + ${javase.version} + + + + org.apache.maven.plugins + maven-assembly-plugin + ${maven-assembly-plugin.version} + + + + org.nanoboot.spriteutils.core.Main + + + + jar-with-dependencies + + + + + + make-assembly + package + + single + + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + ${checkstyle.skip} + + + + + + + + + + org.nanoboot.powerframework + power-time + ${power.version} + + + org.nanoboot.powerframework + power-random + ${power.version} + + + org.nanoboot.powerframework + power-collections + ${power.version} + + + + + org.junit.jupiter + junit-jupiter-engine + ${junit-jupiter.version} + test + + + org.junit.jupiter + junit-jupiter-api + ${junit-jupiter.version} + test + + + org.junit.jupiter + junit-jupiter-params + ${junit-jupiter.version} + test + + + + commons-io + commons-io + 2.11.0 + + + + + org.projectlombok + lombok + ${lombok.version} + provided + + + + org.apache.logging.log4j + log4j-api + ${log4j.version} + + + org.apache.logging.log4j + log4j-core + ${log4j.version} + + + org.apache.logging.log4j + log4j-slf4j-impl + ${log4j.version} + + + dev.mccue + guava-io + 0.0.3 + + + org.jclarion + image4j + 0.7 + + + + + + + + releases + nanoboot-releases-repository + https://maven.nanoboot.org/releases + + + snapshots + nanoboot-snapshots-repository + https://maven.nanoboot.org/snapshots + + + + + + releases + nanoboot-releases-repository + https://maven.nanoboot.org/releases + + + snapshots + nanoboot-snapshots-repository + https://maven.nanoboot.org/snapshots + + + + diff --git a/setmodtime.sh b/setmodtime.sh new file mode 100755 index 0000000..7edb99b --- /dev/null +++ b/setmodtime.sh @@ -0,0 +1,3 @@ +set_last_mod_time_the_same_as_this_file="$1" +set_last_mod_time_for_this_file="$2" +touch -r "$set_last_mod_time_the_same_as_this_file" "$set_last_mod_time_for_this_file" diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java new file mode 100755 index 0000000..b1ba5fa --- /dev/null +++ b/src/main/java/module-info.java @@ -0,0 +1,29 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2024-2024 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// + +module spriteutils { + requires org.apache.commons.io; + requires lombok; + requires org.apache.logging.log4j; + requires powerframework.time; + requires powerframework.collections; + requires dev.mccue.guava.io; + requires java.desktop; + requires image4j; +} diff --git a/src/main/java/org/nanoboot/spriteutils/commands/DrawCommand.java b/src/main/java/org/nanoboot/spriteutils/commands/DrawCommand.java new file mode 100644 index 0000000..cb46e65 --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/commands/DrawCommand.java @@ -0,0 +1,405 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2023-2023 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// +package org.nanoboot.spriteutils.commands; + +import java.awt.BasicStroke; +import java.awt.Color; +import java.awt.Graphics2D; +import java.awt.Stroke; +import java.awt.image.BufferedImage; +import java.io.File; +import java.io.IOException; +import java.util.function.BiConsumer; +import java.util.function.BiFunction; +import java.util.function.Supplier; +import lombok.AllArgsConstructor; +import net.sf.image4j.codec.bmp.BMPDecoder; +import net.sf.image4j.codec.bmp.BMPEncoder; +import net.sf.image4j.codec.bmp.BMPImage; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.nanoboot.spriteutils.core.Command; +import org.nanoboot.spriteutils.core.SpriteSheet; +import org.nanoboot.spriteutils.core.SpriteUtilsArgs; +import org.nanoboot.spriteutils.core.SpriteUtilsException; +import org.nanoboot.spriteutils.core.Utils; + +/** + * + * @author r + */ +public class DrawCommand implements Command { + + private static final Logger LOG = LogManager.getLogger(DrawCommand.class); + public static final String NAME = "draw"; + + public DrawCommand() { + + } + + @Override + public String getName() { + return NAME; + } + + private static final BiFunction random = (min, max) -> { + int diff = max - min; + int i = (int) (Math.random() * diff); + return min + i; + }; + + @Override + public String run(SpriteUtilsArgs bitBackupArgs) { + File workingDirectory = new File("/home/robertvokac/Desktop/speedy_eggbert/speedy_eggbert_I/IMAGE08"); + File testFile = new File(workingDirectory, "blupi000.blp"); + File backupFile = new File(testFile.getAbsolutePath() + ".backup"); + if (backupFile.exists()) { + testFile.delete(); + Utils.copyFile(backupFile, testFile); + } else { + Utils.copyFile(testFile, backupFile); + } + + BMPImage image = null; + File file = testFile; + try { + image = BMPDecoder.readExt(file); + } catch (IOException ex) { + throw new SpriteUtilsException("Reading image failed: " + file.getAbsolutePath() + " " + ex.getMessage()); + } + BufferedImage bi = image.getImage(); + Graphics2D g = bi.createGraphics(); + + Supplier randomByte = () -> random.apply(0, 255); + + final int height = image.getHeight(); + final int width = image.getWidth(); + g.setColor(Color.red); + Stroke originalStroke = g.getStroke(); + Stroke dashedStroke = new BasicStroke(1, BasicStroke.CAP_SQUARE, BasicStroke.CAP_SQUARE, + 0, new float[]{1, 3}, 0); + g.setStroke(dashedStroke); + //g.drawRect(0,0, 28,19); + SpriteSheet spriteSheet = new SpriteSheet(new File(workingDirectory, "spritesheet.csv")); + spriteSheet.getSpriteSheets(testFile.getName()).forEach(r -> { + int startX = r.getX(); + int endX = startX + r.getWidth(); + int startY = r.getY(); + int endY = startY + r.getHeight(); + drawNumber(r.getNumberPerSheet(), g, endX - 2, endY - 1); + +// +// int x = 0; +// int y = 0; +// +// int aaa = 3; +// x = startX;y = startY; +// g.setStroke(originalStroke); +// g.drawLine(x, y, x + aaa, y); +// g.drawLine(x, y, x, y + aaa); +// +// x = endX;y = startY; +// g.drawLine(x, y, x - aaa, y); +// g.drawLine(x, y, x, y + aaa); +// +// x = startX;y = endY; +// g.drawLine(x, y, x + aaa, y); +// g.drawLine(x, y, x, y - aaa); +// +// x = endX;y = endY; +// g.drawLine(x, y, x - aaa, y); +// g.drawLine(x, y, x, y - aaa); + + g.setStroke(dashedStroke); + + g.drawRect(r.getX(), r.getY(), r.getWidth(), r.getHeight()); + }); +// for (int i = 0; i <= 100; i++) { +// g.setStroke(new BasicStroke(random.apply(1,3))); +// +// g.setColor(new Color(randomByte.get(), randomByte.get(), randomByte.get())); +// +// int h = random.apply(10, 100); +// int w = random.apply(10, 100); +// int x = random.apply(1, width); +// int y = random.apply(1, height); +// if ((x + w) > width) { +// x = x - w - random.apply(5, 25); +// } +// if ((y + h) > height) { +// y = y - h - random.apply(5, 25); +// } +// g.drawRect(x, y, w, h); +// } + g.dispose(); + try { + BMPEncoder.write(bi, testFile); + } catch (IOException ex) { + throw new SpriteUtilsException("Writing image failed: " + file.getAbsolutePath() + " " + ex.getMessage()); + } + System.out.println("getColourCount=" + image.getColourCount()); + System.out.println("getColourDepth=" + image.getColourDepth()); + System.out.println("getHeight=" + height); + System.out.println("getWidth=" + width); + System.out.println("isIndexed=" + image.isIndexed()); + return ""; + + } + + @AllArgsConstructor + static class Point { + + int x; + int y; + + void addToX(int n) { + x = x + n; + } + + void addToY(int n) { + y = y + n; + } + + Point createClone() { + return new Point(x, y); + } + } + + private static void drawNumber(int number, Graphics2D g, int endX, int endY) { + //number = random.apply(100, 900); + System.out.println("number = " + number); + Point end = new Point(endX, endY); + String ns = String.valueOf(number); + + Color oldColor = g.getColor(); + g.setColor(Color.WHITE); + g.fillRect(endX + 1, endY - 5, 1, 6); + g.setColor(oldColor); + + + for (int i = 0; i < ns.length(); i++) { + char ch = ns.charAt(ns.length() - 1 - i); + String s = String.valueOf(ch); + drawANumber(Integer.valueOf(s), g, end.x - (i * 4), end.y); + + } + } + + private static final boolean[] data0 = new boolean[]{ + true, true, true, + true, false, true, + true, false, true, + true, false, true, + true, true, true}; + private static final boolean[] data1 = new boolean[]{ + false, false, true, + false, true, true, + true, false, true, + false, false, true, + false, false, true}; + private static final boolean[] data2 = new boolean[]{ + true, true, true, + false, false, true, + false, true, false, + true, false, false, + true, true, true}; + private static final boolean[] data3 = new boolean[]{ + true, true, true, + false, false, true, + true, true, true, + false, false, true, + true, true, true}; + private static final boolean[] data4 = new boolean[]{ + false, false, true, + false, true, false, + true, true, true, + false, false, true, + false, false, true}; + private static final boolean[] data5 = new boolean[]{ + true, true, true, + true, false, false, + true, true, true, + false, false, true, + true, true, true}; + private static final boolean[] data6 = new boolean[]{ + true, true, true, + true, false, false, + true, true, true, + true, false, true, + true, true, true}; + private static final boolean[] data7 = new boolean[]{ + true, true, true, + false, false, true, + false, false, true, + false, false, true, + false, false, true}; + private static final boolean[] data8 = new boolean[]{ + true, true, true, + true, false, true, + true, true, true, + true, false, true, + true, true, true}; + private static final boolean[] data9 = new boolean[]{ + true, true, true, + true, false, true, + true, true, true, + false, false, true, + false, false, true}; + + private static void drawANumber(int number, Graphics2D g, int endX, int endY) { + System.out.println("drawNumber " +number + " " + endX + " " + endY); + Point end = new Point(endX, endY); + String ns = String.valueOf(number); +char c = ns.charAt(0); + Point start = end.createClone(); +Point p = start; + start.addToX(-2); + start.addToY(-4); + Color oldColor = g.getColor(); + g.setColor(Color.WHITE); + g.fillRect(start.x-1, start.y-1, 4, 6); +// if (true) { +// g.setColor(oldColor); +// return; +// } + g.setColor(Color.BLACK); + + + switch (c) { + case '0': + drawANumber(g, p, data0); + break; + case '1': + drawANumber(g, p, data1); + break; + case '2': + drawANumber(g, p, data2); + break; + case '3': + drawANumber(g, p, data3); + break; + case '4': + drawANumber(g, p, data4); + break; + case '5': + drawANumber(g, p, data5); + break; + case '6': + drawANumber(g, p, data6); + break; + case '7': + drawANumber(g, p, data7); + break; + case '8': + drawANumber(g, p, data8); + break; + case '9': + drawANumber(g, p, data9); + break; + default: + throw new SpriteUtilsException("Character is not supported: " + c); + } + + + g.setColor(oldColor); + } + + private static void drawANumber(Graphics2D g, Point start, boolean[] data) { + + BiConsumer drawPixel = (x, y) -> + { + System.out.println("Drawing pixel: " + x + " " + y); + //g.setColor(Color.ORANGE); + g.fillRect(start.x + x, start.y + y, 1, 1); + //g.drawLine(start.x + x, start.y + y, start.x + x, start.y + y); + }; + //drawPixel.accept(1,1); + //if(true) return; + int i = 0; + int X = 0; + int Y = 0; + + if (data[i++]) { + drawPixel.accept(X, Y); + } + X++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X = 0; + Y++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X = 0; + Y++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X = 0; + Y++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X = 0; + Y++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X++; + if (data[i++]) { + drawPixel.accept(X, Y); + } + X = 0; + Y++; + + } +} diff --git a/src/main/java/org/nanoboot/spriteutils/commands/HelpCommand.java b/src/main/java/org/nanoboot/spriteutils/commands/HelpCommand.java new file mode 100644 index 0000000..531229f --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/commands/HelpCommand.java @@ -0,0 +1,72 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2023-2023 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// +package org.nanoboot.spriteutils.commands; + +import org.nanoboot.spriteutils.core.Command; +import org.nanoboot.spriteutils.core.SpriteUtilsArgs; + +/** + * + * @author Robert Vokac + */ +public class HelpCommand implements Command { + + public static final String NAME = "help"; + + public HelpCommand() { + } + + @Override + public String getName() { + return NAME; + } + + @Override + public String run(SpriteUtilsArgs bitInspectorArgs) { + String str = """ + NAME + spriteutils - " Sprite Utils" + + SYNOPSIS + spriteutils [command] [options] + + DESCRIPTION + Tools used to work with sprites. + + COMMAND + draw draw rectangles for sprites + OPTIONS + color={rgb value of the rectangle border} + Optional. Default=255,0,0 + files={comma separated list of BMP files in the working directory} + Optional. Default=(all BMP files in the working directory). + groups={comma separated list of sprite groups} + Optional. Default=(all sprite groups). + positon={row starting with 0, height starting with 0} + Optional. Default=(all sprites). + number-per-group={row starting with 0, height starting with 0} + Optional. Default=(all sprites). + help Display help information + version Display version information +"""; + System.out.println(str); + return str; + } + +} diff --git a/src/main/java/org/nanoboot/spriteutils/commands/VersionCommand.java b/src/main/java/org/nanoboot/spriteutils/commands/VersionCommand.java new file mode 100644 index 0000000..d4b4419 --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/commands/VersionCommand.java @@ -0,0 +1,50 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2023-2023 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// + +package org.nanoboot.spriteutils.commands; + +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.nanoboot.spriteutils.core.Command; +import org.nanoboot.spriteutils.core.SpriteUtilsArgs; + +/** + * +* @author Robert Vokac + */ +public class VersionCommand implements Command { + +public static final String NAME = "version"; +private static final Logger LOG = LogManager.getLogger(VersionCommand.class); + public VersionCommand() { + } + + @Override + public String getName() { + return NAME; + } + + @Override + public String run(SpriteUtilsArgs bitInspectorArgs) { + String result = "Sprite Utils 0.0.0-SNAPSHOT"; + LOG.info(result); + return result; + } + +} diff --git a/src/main/java/org/nanoboot/spriteutils/core/Command.java b/src/main/java/org/nanoboot/spriteutils/core/Command.java new file mode 100644 index 0000000..8b5a47c --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/core/Command.java @@ -0,0 +1,32 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2023-2023 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// + +package org.nanoboot.spriteutils.core; + +/** + * +* @author Robert Vokac + */ +public interface Command { + public String getName(); + default String run(SpriteUtilsArgs bitInspectorArgs) { + throw new SpriteUtilsException("Not yet implemented."); + } + +} diff --git a/src/main/java/org/nanoboot/spriteutils/core/Main.java b/src/main/java/org/nanoboot/spriteutils/core/Main.java new file mode 100755 index 0000000..4b31d31 --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/core/Main.java @@ -0,0 +1,36 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2023-2023 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// +package org.nanoboot.spriteutils.core; + +/** + * @author Robert Vokac + * @since 0.0.0 + */ +public class Main { + + public static void main(String[] args) { + System.out.println("Sprite Utils - tool used to work with sprites\n"); + + SpriteUtils spriteUtils = new SpriteUtils(); + args = new String[]{"draw"}; + spriteUtils.run(args); + } + + +} diff --git a/src/main/java/org/nanoboot/spriteutils/core/SpriteSheet.java b/src/main/java/org/nanoboot/spriteutils/core/SpriteSheet.java new file mode 100644 index 0000000..c7332fd --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/core/SpriteSheet.java @@ -0,0 +1,114 @@ +/* + * Click nbfs://nbhost/SystemFileSystem/Templates/Licenses/license-default.txt to change this license + * Click nbfs://nbhost/SystemFileSystem/Templates/Classes/Class.java to edit this template + */ +package org.nanoboot.spriteutils.core; + +import java.io.File; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import lombok.Data; +import lombok.ToString; + +/** + * + * @author robertvokac + */ +@Data +@ToString +public class SpriteSheet { + + private final Map> map = new HashMap<>(); + private static int lastX = -1; + private static int lastWidth = -1; + private static int lastHeight = -1; + private SpriteSheetRow lastSpriteSheetRow = null; + + public SpriteSheet(File file) { + List rows = new ArrayList<>(); + String text = Utils.readTextFromFile(file); + text.lines().skip(1).forEach(l -> { + final SpriteSheetRow spriteSheetRow = new SpriteSheetRow(l); + + if (lastSpriteSheetRow != null) { + if (!spriteSheetRow.file.equals(lastSpriteSheetRow.file)) { + lastSpriteSheetRow = null; + } + } + if (lastSpriteSheetRow == null) { + spriteSheetRow.numberPerSheet = 1; + if (spriteSheetRow.getRow() != 1) { + String msg = "Row of the first sprite in file must be equal to 1, but value for file " + spriteSheetRow.file + " is " + spriteSheetRow.getRow(); + throw new SpriteUtilsException(msg); + } + if (spriteSheetRow.getColumn() != 1) { + String msg = "Column of the first sprite in file must be equal to 1, but value for file " + spriteSheetRow.file + " is " + spriteSheetRow.getColumn(); + throw new SpriteUtilsException(msg); + } + + } else { + spriteSheetRow.numberPerSheet = lastSpriteSheetRow.numberPerSheet + 1; + + if(spriteSheetRow.row > lastSpriteSheetRow.row) { + if(spriteSheetRow.row != lastSpriteSheetRow.row) { + throw new SpriteUtilsException("Unexpected row for " + spriteSheetRow.createId()); + } + } + if(spriteSheetRow.row < lastSpriteSheetRow.row) { + throw new SpriteUtilsException("Unexpected row for " + spriteSheetRow.createId()); + } + + if(spriteSheetRow.row == lastSpriteSheetRow.row) { + if(spriteSheetRow.column != (lastSpriteSheetRow.column + 1)) + throw new SpriteUtilsException("Unexpected column for " + spriteSheetRow.createId()); + } + } + rows.add(spriteSheetRow); + if (!map.containsKey(spriteSheetRow.file)) { + map.put(spriteSheetRow.file, new ArrayList<>()); + } + map.get(spriteSheetRow.file).add(spriteSheetRow); + if (spriteSheetRow.x == -1) { + if (spriteSheetRow.column == 1) { + spriteSheetRow.x = 0; + } else { + if (lastX == -1) { + throw new SpriteUtilsException("Could not compute X for " + spriteSheetRow.createId()); + } else { + spriteSheetRow.x = lastX + lastWidth + 1; + } + } + } + lastX = spriteSheetRow.getX(); + lastWidth = spriteSheetRow.getWidth(); + if (spriteSheetRow.height <= 0) { + if (lastHeight == -1) { + throw new SpriteUtilsException("Could not compute height for " + spriteSheetRow.createId()); + } else { + spriteSheetRow.height = lastHeight + ((-1) * spriteSheetRow.height); + } + } + lastHeight = spriteSheetRow.height; + lastSpriteSheetRow = spriteSheetRow; + System.out.println(spriteSheetRow.toCsvLine()); + }); + File computed = new File(file.getAbsolutePath() + ".computed.csv"); + if(computed.exists()){ + computed.delete(); + } + StringBuilder sb = new StringBuilder(text.lines().limit(1).findFirst().orElse("")); + sb.append("\n"); + rows.stream().forEach(r-> { + sb.append(r.toCsvLine()).append("\n"); + }); + Utils.writeTextToFile(sb.toString(), computed); + + } + + public List getSpriteSheets(String file) { + return map.get(file); + } + +} diff --git a/src/main/java/org/nanoboot/spriteutils/core/SpriteSheetRow.java b/src/main/java/org/nanoboot/spriteutils/core/SpriteSheetRow.java new file mode 100644 index 0000000..7d8167d --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/core/SpriteSheetRow.java @@ -0,0 +1,79 @@ +/* + * Click nbfs://nbhost/SystemFileSystem/Templates/Licenses/license-default.txt to change this license + * Click nbfs://nbhost/SystemFileSystem/Templates/Classes/Class.java to edit this template + */ +package org.nanoboot.spriteutils.core; + +import java.util.Arrays; +import java.util.List; +import java.util.stream.Collector; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import lombok.Data; +import lombok.ToString; + +/** + * + * @author robertvokac + */ +@Data +@ToString +public class SpriteSheetRow { + + String file; + String group; + int numberInGroup; + int row; + int column; + int x; + int y; + int width; + int height; + String notes; + String tags; + int numberPerSheet; + + public SpriteSheetRow(String csvLine) { + String[] csvColumn = csvLine.split(";"); + int i = 0; + file = csvColumn[i++]; + group = csvColumn[i++]; + numberInGroup = Integer.valueOf(csvColumn[i++]); + row = Integer.valueOf(csvColumn[i++]); + column = Integer.valueOf(csvColumn[i++]); + String xString = csvColumn[i++]; + x = xString.isBlank() ? -1 : Integer.valueOf(xString); + y = Integer.valueOf(csvColumn[i++]); + width = Integer.valueOf(csvColumn[i++]); + height = Integer.valueOf(csvColumn[i++]); + if (column > 1) { + height = height * (-1); + } + notes = csvColumn.length >= 10 ? csvColumn[i++] : ""; + tags = csvColumn.length > 11 ? csvColumn[i++] : ""; + } + + public String createId() { + return file + __ + group + __ + numberInGroup; + } + private static final String __ = "__"; + + public String toCsvLine() { + List l = Stream.of( + file, + group, + String.valueOf(numberInGroup), + String.valueOf(row), + String.valueOf(column), + String.valueOf(x), + String.valueOf(y), + String.valueOf(width), + String.valueOf(height), + notes, + tags, + String.valueOf(numberPerSheet)).toList(); + return l.stream().collect(Collectors.joining(";")); + + } + +} diff --git a/src/main/java/org/nanoboot/spriteutils/core/SpriteUtils.java b/src/main/java/org/nanoboot/spriteutils/core/SpriteUtils.java new file mode 100644 index 0000000..e6d3332 --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/core/SpriteUtils.java @@ -0,0 +1,69 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2023-2023 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// + +package org.nanoboot.spriteutils.core; + +import java.util.HashSet; +import java.util.Set; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.nanoboot.spriteutils.commands.DrawCommand; +import org.nanoboot.spriteutils.commands.HelpCommand; +import org.nanoboot.spriteutils.commands.VersionCommand; + +/** + * + * @author Robert Vokac + */ +public class SpriteUtils { + + private static final Logger LOG = LogManager.getLogger(SpriteUtils.class); + + private final Set commandImplementations; + public SpriteUtils() { + commandImplementations = new HashSet<>(); + commandImplementations.add(new DrawCommand()); + commandImplementations.add(new HelpCommand()); + commandImplementations.add(new VersionCommand()); + } + + public void run(String[] args) { + run(new SpriteUtilsArgs(args)); + } + + public void run(SpriteUtilsArgs spriteUtilsArgs) { + String command = spriteUtilsArgs.getCommand(); + Command foundCommand = null; + for(Command e:commandImplementations) { + if(e.getName().equals(command)) { + foundCommand = e; + break; + } + } + if(foundCommand == null) { + String msg = "Command \"" + command + "\" is not supported."; + LOG.error(msg); + + new HelpCommand().run(spriteUtilsArgs); + throw new SpriteUtilsException(msg); + } + foundCommand.run(spriteUtilsArgs); + + } +} diff --git a/src/main/java/org/nanoboot/spriteutils/core/SpriteUtilsArgs.java b/src/main/java/org/nanoboot/spriteutils/core/SpriteUtilsArgs.java new file mode 100644 index 0000000..31bb87a --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/core/SpriteUtilsArgs.java @@ -0,0 +1,90 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2023-2023 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// +package org.nanoboot.spriteutils.core; + +import java.util.HashMap; +import java.util.Map; +import lombok.Getter; + +/** + * + * @author Robert Vokac + */ +public class SpriteUtilsArgs { + + @Getter + private final String command; + private final Map internalMap = new HashMap<>(); + + private static String[] convertToStringArray(String command, Map map) { + String[] array = new String[1 + map.size()]; + array[0] = command; + int i = 0; + for (String key : map.keySet()) { + array[++i] = key + "=" + map.get(key); + } + return array; + } + + public SpriteUtilsArgs(SpriteUtilsCommand command, Map map) { + this(convertToStringArray(command.name().toLowerCase(), map)); + } + + public SpriteUtilsArgs(String command, Map map) { + this(convertToStringArray(command, map)); + } + + public SpriteUtilsArgs(String[] args) { + command = args.length == 0 ? "check" : args[0]; + + if (args.length > 1) { + + for (String arg : args) { + if (arg == null) { + continue; + } + if (args[0].equals(arg)) { + continue; + } + String[] keyValue = arg.split("=", 2); + internalMap.put(keyValue[0], keyValue.length > 1 ? keyValue[1] : null); + } + for (String key : internalMap.keySet()) { + System.out.println("Found argument: " + key + "(=)" + internalMap.get(key)); + } + + } + } + + public boolean hasArgument(String arg) { + return internalMap.containsKey(arg); + } + + public void addArgument(String arg, String value) { + this.internalMap.put(arg, value); + } + + public String getArgument(String arg) { + return internalMap.get(arg); + } + public boolean isVerboseLoggingEnabled() { + return hasArgument("verbose")&&getArgument("verbose").equals("true"); + } + +} diff --git a/src/main/java/org/nanoboot/spriteutils/core/SpriteUtilsCommand.java b/src/main/java/org/nanoboot/spriteutils/core/SpriteUtilsCommand.java new file mode 100644 index 0000000..b617301 --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/core/SpriteUtilsCommand.java @@ -0,0 +1,28 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2023-2023 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// + +package org.nanoboot.spriteutils.core; + +/** + * +* @author Robert Vokac + */ +public enum SpriteUtilsCommand { + DRAW, RESTORE, EXTRACT, GIFS, HELP, VERSION; +} diff --git a/src/main/java/org/nanoboot/spriteutils/core/SpriteUtilsException.java b/src/main/java/org/nanoboot/spriteutils/core/SpriteUtilsException.java new file mode 100644 index 0000000..20a6c6a --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/core/SpriteUtilsException.java @@ -0,0 +1,40 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2023-2023 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// + +package org.nanoboot.spriteutils.core; + +/** + * @author Robert Vokac + * @since 0.0.0 + */ +public class SpriteUtilsException extends RuntimeException { + + public SpriteUtilsException(String msg) { + super(msg); + } + + public SpriteUtilsException(String msg, Exception e) { + super(msg, e); + } + + public SpriteUtilsException(Exception e) { + super(e); + } + +} \ No newline at end of file diff --git a/src/main/java/org/nanoboot/spriteutils/core/Utils.java b/src/main/java/org/nanoboot/spriteutils/core/Utils.java new file mode 100644 index 0000000..4c1360b --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/core/Utils.java @@ -0,0 +1,156 @@ +/////////////////////////////////////////////////////////////////////////////////////////////// +// sprite-utils: Tool used to work with sprites +// Copyright (C) 2023-2023 the original author or authors. +// +// 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; version 2 +// of the License only. +// +// 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, write to the Free Software +// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +/////////////////////////////////////////////////////////////////////////////////////////////// +package org.nanoboot.spriteutils.core; + +import dev.mccue.guava.hash.Hashing; +import dev.mccue.guava.io.Files; +import java.io.BufferedReader; +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.PrintWriter; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.StandardCopyOption; + +import java.util.ArrayList; +import java.util.Base64; +import java.util.List; + +/** + * + * @author Robert Vokac + */ +public class Utils { + + private static final String UNDERSCORE = "_"; + + private Utils() { + //Not meant to be instantiated. + } + + public static List listAllFilesInDir(File dir) { + return listAllFilesInDir(dir, new ArrayList<>()); + } + + private static List listAllFilesInDir(File dir, List files) { + files.add(dir); + for (File f : dir.listFiles()) { + if (f.isDirectory()) { + listAllFilesInDir(f, files); + } else { + files.add(f); + } + } + return files; + } + + public static void copyFile(File originalFile, File copiedFile) throws SpriteUtilsException { + Path originalPath = originalFile.toPath(); + Path copied = copiedFile.toPath(); + + try { + java.nio.file.Files.copy(originalPath, copied, StandardCopyOption.REPLACE_EXISTING); + } catch (IOException ex) { + ex.printStackTrace(); + throw new SpriteUtilsException("Copying file failed: " + originalFile.getAbsolutePath() + " " + ex.getMessage()); + } + } + + public static void writeTextToFile(String text, File file) { + FileWriter fileWriter; + try { + fileWriter = new FileWriter(file); + } catch (IOException ex) { + ex.printStackTrace(); + throw new SpriteUtilsException("Writing to file failed: " + file.getName(), ex); + } + PrintWriter printWriter = new PrintWriter(fileWriter); + printWriter.print(text); + printWriter.close(); + } + + public static String readTextFromFile(File file) { + if (!file.exists()) { + return ""; + } + try { + return new String(java.nio.file.Files.readAllBytes(Paths.get(file.getAbsolutePath()))); + } catch (IOException ex) { + throw new SpriteUtilsException("Reading file failed: " + file.getAbsolutePath(), ex); + } + } + + public static String readTextFromResourceFile(String fileName) { + try { + Class clazz = Main.class; + InputStream inputStream = clazz.getResourceAsStream(fileName); + return readFromInputStream(inputStream); + } catch (IOException ex) { + throw new SpriteUtilsException("Reading file failed: " + fileName, ex); + } + + } + + public static String readFromInputStream(InputStream inputStream) + throws IOException { + StringBuilder resultStringBuilder = new StringBuilder(); + try (BufferedReader br + = new BufferedReader(new InputStreamReader(inputStream))) { + String line; + while ((line = br.readLine()) != null) { + resultStringBuilder.append(line).append("\n"); + } + } + return resultStringBuilder.toString(); + } + + public static String calculateSHA512Hash(File file) { + try { + return Files.hash(file, Hashing.sha512()).toString(); + } catch (IOException ex) { + System.err.println(ex.getMessage()); + throw new SpriteUtilsException(ex); + } + } + + public static String calculateSHA256Hash(File file) { + if(file.isDirectory()) {return "";} + try { + return Files.hash(file, Hashing.sha256()).toString(); + } catch (IOException ex) { + System.err.println(ex.getMessage()); + throw new SpriteUtilsException(ex); + } + } + + + public static String encodeBase64(String s) { + return Base64.getEncoder().encodeToString(s.getBytes()); + + } + + public static String decodeBase64(String s) { + + byte[] decodedBytes = Base64.getDecoder().decode(s); + return new String(decodedBytes); + } +} diff --git a/src/main/java/org/nanoboot/spriteutils/lombok.config b/src/main/java/org/nanoboot/spriteutils/lombok.config new file mode 100644 index 0000000..2066d75 --- /dev/null +++ b/src/main/java/org/nanoboot/spriteutils/lombok.config @@ -0,0 +1 @@ +lombok.log.fieldName=LOG diff --git a/src/main/resources/.gitkeep b/src/main/resources/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/src/main/resources/log4j2.properties b/src/main/resources/log4j2.properties new file mode 100644 index 0000000..2939b9d --- /dev/null +++ b/src/main/resources/log4j2.properties @@ -0,0 +1,5 @@ +appender.console.type = Console +appender.console.name = STDOUT +appender.console.layout.type = PatternLayout +appender.console.layout.pattern = [%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %c{1} - %msg%n +rootLogger=info, STDOUT diff --git a/src/test/java/org/nanoboot/spriteutils/.gitkeep b/src/test/java/org/nanoboot/spriteutils/.gitkeep new file mode 100644 index 0000000..e69de29