From 9232f67dc9cdaefcdaf5433709e56ca8f4bfe910 Mon Sep 17 00:00:00 2001 From: ynerant Date: Thu, 19 Nov 2020 01:51:10 +0100 Subject: [PATCH 01/15] Add LICENSE --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7d821ed --- /dev/null +++ b/LICENSE @@ -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. + + Squirrel Battle + Copyright (C) 2020 ynerant + + 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: + + Squirrel Battle Copyright (C) 2020 ynerant + 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 +. From d0ee9ec5623a1a109d31cf690300ad130c6f18cc Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 02:18:08 +0100 Subject: [PATCH 02/15] Rename dungeonbattle to squirrelbattle --- README.md | 4 ++-- main.py | 2 +- {dungeonbattle => squirrelbattle}/__init__.py | 0 {resources => squirrelbattle/assets}/ascii_art.txt | 0 .../assets}/example_map.txt | 0 .../assets}/example_map_2.txt | 0 {dungeonbattle => squirrelbattle}/bootstrap.py | 6 +++--- .../display/__init__.py | 0 .../display/display.py | 4 ++-- .../display/display_manager.py | 12 ++++++------ .../display/mapdisplay.py | 2 +- .../display/menudisplay.py | 4 ++-- .../display/statsdisplay.py | 2 +- .../display/texturepack.py | 0 .../entities/__init__.py | 0 .../entities/items.py | 0 .../entities/monsters.py | 0 .../entities/player.py | 0 {dungeonbattle => squirrelbattle}/enums.py | 2 +- {dungeonbattle => squirrelbattle}/game.py | 2 +- {dungeonbattle => squirrelbattle}/interfaces.py | 14 +++++++------- {dungeonbattle => squirrelbattle}/menus.py | 0 {dungeonbattle => squirrelbattle}/settings.py | 0 {dungeonbattle => squirrelbattle}/term_manager.py | 0 .../tests/__init__.py | 0 .../tests/entities_test.py | 10 +++++----- .../tests/game_test.py | 14 +++++++------- .../tests/interfaces_test.py | 6 +++--- {dungeonbattle => squirrelbattle}/tests/screen.py | 0 .../tests/settings_test.py | 2 +- 30 files changed, 43 insertions(+), 43 deletions(-) rename {dungeonbattle => squirrelbattle}/__init__.py (100%) rename {resources => squirrelbattle/assets}/ascii_art.txt (100%) rename {resources => squirrelbattle/assets}/example_map.txt (100%) rename {resources => squirrelbattle/assets}/example_map_2.txt (100%) rename {dungeonbattle => squirrelbattle}/bootstrap.py (77%) rename {dungeonbattle => squirrelbattle}/display/__init__.py (100%) rename {dungeonbattle => squirrelbattle}/display/display.py (93%) rename {dungeonbattle => squirrelbattle}/display/display_manager.py (88%) rename {dungeonbattle => squirrelbattle}/display/mapdisplay.py (97%) rename {dungeonbattle => squirrelbattle}/display/menudisplay.py (96%) rename {dungeonbattle => squirrelbattle}/display/statsdisplay.py (97%) rename {dungeonbattle => squirrelbattle}/display/texturepack.py (100%) rename {dungeonbattle => squirrelbattle}/entities/__init__.py (100%) rename {dungeonbattle => squirrelbattle}/entities/items.py (100%) rename {dungeonbattle => squirrelbattle}/entities/monsters.py (100%) rename {dungeonbattle => squirrelbattle}/entities/player.py (100%) rename {dungeonbattle => squirrelbattle}/enums.py (97%) rename {dungeonbattle => squirrelbattle}/game.py (98%) rename {dungeonbattle => squirrelbattle}/interfaces.py (96%) rename {dungeonbattle => squirrelbattle}/menus.py (100%) rename {dungeonbattle => squirrelbattle}/settings.py (100%) rename {dungeonbattle => squirrelbattle}/term_manager.py (100%) rename {dungeonbattle => squirrelbattle}/tests/__init__.py (100%) rename {dungeonbattle => squirrelbattle}/tests/entities_test.py (94%) rename {dungeonbattle => squirrelbattle}/tests/game_test.py (96%) rename {dungeonbattle => squirrelbattle}/tests/interfaces_test.py (85%) rename {dungeonbattle => squirrelbattle}/tests/screen.py (100%) rename {dungeonbattle => squirrelbattle}/tests/settings_test.py (96%) diff --git a/README.md b/README.md index 63d7374..6c1d9b3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ [![pipeline status](https://gitlab.crans.org/ynerant/dungeon-battle/badges/master/pipeline.svg)](https://gitlab.crans.org/ynerant/dungeon-battle/-/commits/master) [![coverage report](https://gitlab.crans.org/ynerant/dungeon-battle/badges/master/coverage.svg)](https://gitlab.crans.org/ynerant/dungeon-battle/-/commits/master) -# Dungeon Battle +# Squirrel Battle -Projet de génie logiciel de M1 +Attention aux couteaux des écureuils ! ## Création d'un environnement de développement diff --git a/main.py b/main.py index e918f0d..64972f1 100755 --- a/main.py +++ b/main.py @@ -1,5 +1,5 @@ #!/usr/bin/env python -from dungeonbattle.bootstrap import Bootstrap +from squirrelbattle.bootstrap import Bootstrap if __name__ == "__main__": Bootstrap.run_game() diff --git a/dungeonbattle/__init__.py b/squirrelbattle/__init__.py similarity index 100% rename from dungeonbattle/__init__.py rename to squirrelbattle/__init__.py diff --git a/resources/ascii_art.txt b/squirrelbattle/assets/ascii_art.txt similarity index 100% rename from resources/ascii_art.txt rename to squirrelbattle/assets/ascii_art.txt diff --git a/resources/example_map.txt b/squirrelbattle/assets/example_map.txt similarity index 100% rename from resources/example_map.txt rename to squirrelbattle/assets/example_map.txt diff --git a/resources/example_map_2.txt b/squirrelbattle/assets/example_map_2.txt similarity index 100% rename from resources/example_map_2.txt rename to squirrelbattle/assets/example_map_2.txt diff --git a/dungeonbattle/bootstrap.py b/squirrelbattle/bootstrap.py similarity index 77% rename from dungeonbattle/bootstrap.py rename to squirrelbattle/bootstrap.py index 9828fae..45c2ad1 100644 --- a/dungeonbattle/bootstrap.py +++ b/squirrelbattle/bootstrap.py @@ -1,6 +1,6 @@ -from dungeonbattle.game import Game -from dungeonbattle.display.display_manager import DisplayManager -from dungeonbattle.term_manager import TermManager +from squirrelbattle.game import Game +from squirrelbattle.display.display_manager import DisplayManager +from squirrelbattle.term_manager import TermManager class Bootstrap: diff --git a/dungeonbattle/display/__init__.py b/squirrelbattle/display/__init__.py similarity index 100% rename from dungeonbattle/display/__init__.py rename to squirrelbattle/display/__init__.py diff --git a/dungeonbattle/display/display.py b/squirrelbattle/display/display.py similarity index 93% rename from dungeonbattle/display/display.py rename to squirrelbattle/display/display.py index 6aba26a..47e4bce 100644 --- a/dungeonbattle/display/display.py +++ b/squirrelbattle/display/display.py @@ -1,8 +1,8 @@ import curses from typing import Any, Optional, Union -from dungeonbattle.display.texturepack import TexturePack -from dungeonbattle.tests.screen import FakePad +from squirrelbattle.display.texturepack import TexturePack +from squirrelbattle.tests.screen import FakePad class Display: diff --git a/dungeonbattle/display/display_manager.py b/squirrelbattle/display/display_manager.py similarity index 88% rename from dungeonbattle/display/display_manager.py rename to squirrelbattle/display/display_manager.py index 4b2604f..9ec0f88 100644 --- a/dungeonbattle/display/display_manager.py +++ b/squirrelbattle/display/display_manager.py @@ -1,12 +1,12 @@ import curses -from dungeonbattle.display.mapdisplay import MapDisplay -from dungeonbattle.display.statsdisplay import StatsDisplay -from dungeonbattle.display.menudisplay import SettingsMenuDisplay, \ +from squirrelbattle.display.mapdisplay import MapDisplay +from squirrelbattle.display.statsdisplay import StatsDisplay +from squirrelbattle.display.menudisplay import SettingsMenuDisplay, \ MainMenuDisplay -from dungeonbattle.display.texturepack import TexturePack +from squirrelbattle.display.texturepack import TexturePack from typing import Any -from dungeonbattle.game import Game, GameMode -from dungeonbattle.enums import DisplayActions +from squirrelbattle.game import Game, GameMode +from squirrelbattle.enums import DisplayActions class DisplayManager: diff --git a/dungeonbattle/display/mapdisplay.py b/squirrelbattle/display/mapdisplay.py similarity index 97% rename from dungeonbattle/display/mapdisplay.py rename to squirrelbattle/display/mapdisplay.py index 36cd616..e6cc278 100644 --- a/dungeonbattle/display/mapdisplay.py +++ b/squirrelbattle/display/mapdisplay.py @@ -1,5 +1,5 @@ #!/usr/bin/env python -from dungeonbattle.interfaces import Map +from squirrelbattle.interfaces import Map from .display import Display diff --git a/dungeonbattle/display/menudisplay.py b/squirrelbattle/display/menudisplay.py similarity index 96% rename from dungeonbattle/display/menudisplay.py rename to squirrelbattle/display/menudisplay.py index 36694d0..9108ac8 100644 --- a/dungeonbattle/display/menudisplay.py +++ b/squirrelbattle/display/menudisplay.py @@ -1,6 +1,6 @@ from typing import List -from dungeonbattle.menus import Menu, MainMenu +from squirrelbattle.menus import Menu, MainMenu from .display import Display @@ -73,7 +73,7 @@ class MainMenuDisplay(Display): super().__init__(*args) self.menu = menu - with open("resources/ascii_art.txt", "r") as file: + with open("squirrelbattle/assets/ascii_art.txt", "r") as file: self.title = file.read().split("\n") self.pad = self.newpad(max(self.rows, len(self.title) + 30), diff --git a/dungeonbattle/display/statsdisplay.py b/squirrelbattle/display/statsdisplay.py similarity index 97% rename from dungeonbattle/display/statsdisplay.py rename to squirrelbattle/display/statsdisplay.py index 70c6f0c..77ddb30 100644 --- a/dungeonbattle/display/statsdisplay.py +++ b/squirrelbattle/display/statsdisplay.py @@ -2,7 +2,7 @@ import curses from .display import Display -from dungeonbattle.entities.player import Player +from squirrelbattle.entities.player import Player class StatsDisplay(Display): diff --git a/dungeonbattle/display/texturepack.py b/squirrelbattle/display/texturepack.py similarity index 100% rename from dungeonbattle/display/texturepack.py rename to squirrelbattle/display/texturepack.py diff --git a/dungeonbattle/entities/__init__.py b/squirrelbattle/entities/__init__.py similarity index 100% rename from dungeonbattle/entities/__init__.py rename to squirrelbattle/entities/__init__.py diff --git a/dungeonbattle/entities/items.py b/squirrelbattle/entities/items.py similarity index 100% rename from dungeonbattle/entities/items.py rename to squirrelbattle/entities/items.py diff --git a/dungeonbattle/entities/monsters.py b/squirrelbattle/entities/monsters.py similarity index 100% rename from dungeonbattle/entities/monsters.py rename to squirrelbattle/entities/monsters.py diff --git a/dungeonbattle/entities/player.py b/squirrelbattle/entities/player.py similarity index 100% rename from dungeonbattle/entities/player.py rename to squirrelbattle/entities/player.py diff --git a/dungeonbattle/enums.py b/squirrelbattle/enums.py similarity index 97% rename from dungeonbattle/enums.py rename to squirrelbattle/enums.py index e5f73d9..350c196 100644 --- a/dungeonbattle/enums.py +++ b/squirrelbattle/enums.py @@ -1,7 +1,7 @@ from enum import Enum, auto from typing import Optional -from dungeonbattle.settings import Settings +from squirrelbattle.settings import Settings # This file contains a few useful enumeration classes used elsewhere in the code diff --git a/dungeonbattle/game.py b/squirrelbattle/game.py similarity index 98% rename from dungeonbattle/game.py rename to squirrelbattle/game.py index dcd6a59..05da3e8 100644 --- a/dungeonbattle/game.py +++ b/squirrelbattle/game.py @@ -38,7 +38,7 @@ class Game: Create a new game on the screen. """ # TODO generate a new map procedurally - self.map = Map.load("resources/example_map_2.txt") + self.map = Map.load("squirrelbattle/assets/example_map_2.txt") self.player = Player() self.map.add_entity(self.player) self.player.move(self.map.start_y, self.map.start_x) diff --git a/dungeonbattle/interfaces.py b/squirrelbattle/interfaces.py similarity index 96% rename from dungeonbattle/interfaces.py rename to squirrelbattle/interfaces.py index 873678a..10001fb 100644 --- a/dungeonbattle/interfaces.py +++ b/squirrelbattle/interfaces.py @@ -4,7 +4,7 @@ from math import sqrt from random import choice, randint from typing import List, Optional -from dungeonbattle.display.texturepack import TexturePack +from squirrelbattle.display.texturepack import TexturePack class Map: @@ -287,7 +287,7 @@ class Entity: """ Is this entity an item? """ - from dungeonbattle.entities.items import Item + from squirrelbattle.entities.items import Item return isinstance(self, Item) @staticmethod @@ -295,8 +295,8 @@ class Entity: """ Returns all entities subclasses """ - from dungeonbattle.entities.items import Heart, Bomb - from dungeonbattle.entities.monsters import Beaver, Hedgehog, \ + from squirrelbattle.entities.items import Heart, Bomb + from squirrelbattle.entities.monsters import Beaver, Hedgehog, \ Rabbit, TeddyBear return [Beaver, Bomb, Heart, Hedgehog, Rabbit, TeddyBear] @@ -305,10 +305,10 @@ class Entity: """ Returns all entities subclasses in a dictionary """ - from dungeonbattle.entities.player import Player - from dungeonbattle.entities.monsters import Beaver, Hedgehog, Rabbit, \ + from squirrelbattle.entities.player import Player + from squirrelbattle.entities.monsters import Beaver, Hedgehog, Rabbit, \ TeddyBear - from dungeonbattle.entities.items import Bomb, Heart + from squirrelbattle.entities.items import Bomb, Heart return { "Beaver": Beaver, "Bomb": Bomb, diff --git a/dungeonbattle/menus.py b/squirrelbattle/menus.py similarity index 100% rename from dungeonbattle/menus.py rename to squirrelbattle/menus.py diff --git a/dungeonbattle/settings.py b/squirrelbattle/settings.py similarity index 100% rename from dungeonbattle/settings.py rename to squirrelbattle/settings.py diff --git a/dungeonbattle/term_manager.py b/squirrelbattle/term_manager.py similarity index 100% rename from dungeonbattle/term_manager.py rename to squirrelbattle/term_manager.py diff --git a/dungeonbattle/tests/__init__.py b/squirrelbattle/tests/__init__.py similarity index 100% rename from dungeonbattle/tests/__init__.py rename to squirrelbattle/tests/__init__.py diff --git a/dungeonbattle/tests/entities_test.py b/squirrelbattle/tests/entities_test.py similarity index 94% rename from dungeonbattle/tests/entities_test.py rename to squirrelbattle/tests/entities_test.py index b272541..6cf2fe4 100644 --- a/dungeonbattle/tests/entities_test.py +++ b/squirrelbattle/tests/entities_test.py @@ -1,9 +1,9 @@ import unittest -from dungeonbattle.entities.items import Bomb, Heart, Item -from dungeonbattle.entities.monsters import Beaver, Hedgehog, Rabbit, TeddyBear -from dungeonbattle.entities.player import Player -from dungeonbattle.interfaces import Entity, Map +from squirrelbattle.entities.items import Bomb, Heart, Item +from squirrelbattle.entities.monsters import Beaver, Hedgehog, Rabbit, TeddyBear +from squirrelbattle.entities.player import Player +from squirrelbattle.interfaces import Entity, Map class TestEntities(unittest.TestCase): @@ -11,7 +11,7 @@ class TestEntities(unittest.TestCase): """ Load example map that can be used in tests. """ - self.map = Map.load("resources/example_map.txt") + self.map = Map.load("squirrelbattle/assets/example_map.txt") self.player = Player() self.map.add_entity(self.player) self.player.move(self.map.start_y, self.map.start_x) diff --git a/dungeonbattle/tests/game_test.py b/squirrelbattle/tests/game_test.py similarity index 96% rename from dungeonbattle/tests/game_test.py rename to squirrelbattle/tests/game_test.py index 8e7970d..424d86a 100644 --- a/dungeonbattle/tests/game_test.py +++ b/squirrelbattle/tests/game_test.py @@ -1,13 +1,13 @@ import os import unittest -from dungeonbattle.bootstrap import Bootstrap -from dungeonbattle.display.display import Display -from dungeonbattle.display.display_manager import DisplayManager -from dungeonbattle.entities.player import Player -from dungeonbattle.game import Game, KeyValues, GameMode -from dungeonbattle.menus import MainMenuValues -from dungeonbattle.settings import Settings +from squirrelbattle.bootstrap import Bootstrap +from squirrelbattle.display.display import Display +from squirrelbattle.display.display_manager import DisplayManager +from squirrelbattle.entities.player import Player +from squirrelbattle.game import Game, KeyValues, GameMode +from squirrelbattle.menus import MainMenuValues +from squirrelbattle.settings import Settings class TestGame(unittest.TestCase): diff --git a/dungeonbattle/tests/interfaces_test.py b/squirrelbattle/tests/interfaces_test.py similarity index 85% rename from dungeonbattle/tests/interfaces_test.py rename to squirrelbattle/tests/interfaces_test.py index b487eac..a55a7b3 100644 --- a/dungeonbattle/tests/interfaces_test.py +++ b/squirrelbattle/tests/interfaces_test.py @@ -1,7 +1,7 @@ import unittest -from dungeonbattle.display.texturepack import TexturePack -from dungeonbattle.interfaces import Map, Tile +from squirrelbattle.display.texturepack import TexturePack +from squirrelbattle.interfaces import Map, Tile class TestInterfaces(unittest.TestCase): @@ -18,7 +18,7 @@ class TestInterfaces(unittest.TestCase): """ Try to load a map from a file. """ - m = Map.load("resources/example_map.txt") + m = Map.load("squirrelbattle/assets/example_map.txt") self.assertEqual(m.width, 52) self.assertEqual(m.height, 17) diff --git a/dungeonbattle/tests/screen.py b/squirrelbattle/tests/screen.py similarity index 100% rename from dungeonbattle/tests/screen.py rename to squirrelbattle/tests/screen.py diff --git a/dungeonbattle/tests/settings_test.py b/squirrelbattle/tests/settings_test.py similarity index 96% rename from dungeonbattle/tests/settings_test.py rename to squirrelbattle/tests/settings_test.py index 9a56048..76bcaba 100644 --- a/dungeonbattle/tests/settings_test.py +++ b/squirrelbattle/tests/settings_test.py @@ -1,6 +1,6 @@ import unittest -from dungeonbattle.settings import Settings +from squirrelbattle.settings import Settings class TestSettings(unittest.TestCase): From a7afc0c577a34ba93d6e97cbb6063e38d2398f20 Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 02:30:29 +0100 Subject: [PATCH 03/15] Prepare PyPI deployment --- .gitignore | 6 ++++++ setup.py | 43 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index 99e64f0..53db978 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,12 @@ venv/ .pytest_cache/ __pycache__ +*.pyc + +# Ignore build data +build/ +dist/ +*.egg-info/ # Don't commit settings settings.json diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..e0f8b35 --- /dev/null +++ b/setup.py @@ -0,0 +1,43 @@ +#!/usr/bin/env python3 +import os + +from setuptools import find_packages, setup + +with open("README.md", "r") as f: + long_description = f.read() + +setup( + name="squirrel-battle", + version="1.0.0", + author="ynerant", + author_email="ynerant@crans.org", + description="Watch out for squirrel's knifes!", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://gitlab.crans.org/ynerant/dungeon-battle", + packages=find_packages(), + license='GPLv3', + classifiers=[ + "Development Status :: 4 - Beta", + "Environment :: Console :: Curses", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Natural Language :: French", + "Operating System :: OS Independent", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Topic :: Games/Entertainment", + ], + python_requires='>=3.6', + include_package_data=True, + data_files=["squirrelbattle/assets/" + file + for file in os.listdir("squirrelbattle/assets")], + entry_points={ + "console_scripts": [ + "squirrel-battle = squirrelbattle.bootstrap:Bootstrap.run_game", + ] + } + +) From a8ea328460f0acffc0361e8f6c5b95e5c93ca827 Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 02:41:42 +0100 Subject: [PATCH 04/15] Game name is Squirrel Battle --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index 1e43e33..181f5f7 100644 --- a/tox.ini +++ b/tox.ini @@ -12,7 +12,7 @@ deps = pytest pytest-cov commands = - pytest --cov=dungeonbattle/ --cov-report=term-missing dungeonbattle/ + pytest --cov=squirrelbattle/ --cov-report=term-missing squirrelbattle/ [testenv:linters] deps = @@ -23,7 +23,7 @@ deps = pep8-naming pyflakes commands = - flake8 main.py dungeonbattle + flake8 main.py squirrelbattle [flake8] ignore = W503 ANN002 ANN003 ANN101 ANN102 ANN204 ANN205 From d92a5e16290f4c138fe82389535ec9845b2eb789 Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 02:47:36 +0100 Subject: [PATCH 05/15] Add only one interrogation mark in settings menu --- squirrelbattle/display/menudisplay.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/squirrelbattle/display/menudisplay.py b/squirrelbattle/display/menudisplay.py index 9108ac8..97fb789 100644 --- a/squirrelbattle/display/menudisplay.py +++ b/squirrelbattle/display/menudisplay.py @@ -64,7 +64,8 @@ class SettingsMenuDisplay(MenuDisplay): @property def values(self) -> List[str]: return [a[1][1] + (" : " - + ("?" if self.menu.waiting_for_key else a[1][0]) + + ("?" if self.menu.waiting_for_key + and a == self.menu.validate() else a[1][0]) if a[1][0] else "") for a in self.menu.values] From 00f843754a2372abfe06d9c8796a574e86c204a2 Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 02:49:59 +0100 Subject: [PATCH 06/15] Use a ResourceManager to find assets --- squirrelbattle/display/menudisplay.py | 3 ++- squirrelbattle/game.py | 3 ++- squirrelbattle/resources.py | 13 +++++++++++++ squirrelbattle/tests/entities_test.py | 3 ++- squirrelbattle/tests/interfaces_test.py | 3 ++- 5 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 squirrelbattle/resources.py diff --git a/squirrelbattle/display/menudisplay.py b/squirrelbattle/display/menudisplay.py index 97fb789..fca1ddf 100644 --- a/squirrelbattle/display/menudisplay.py +++ b/squirrelbattle/display/menudisplay.py @@ -2,6 +2,7 @@ from typing import List from squirrelbattle.menus import Menu, MainMenu from .display import Display +from ..resources import ResourceManager class MenuDisplay(Display): @@ -74,7 +75,7 @@ class MainMenuDisplay(Display): super().__init__(*args) self.menu = menu - with open("squirrelbattle/assets/ascii_art.txt", "r") as file: + with open(ResourceManager.get_asset_path("ascii_art.txt"), "r") as file: self.title = file.read().split("\n") self.pad = self.newpad(max(self.rows, len(self.title) + 30), diff --git a/squirrelbattle/game.py b/squirrelbattle/game.py index 05da3e8..b22c4ed 100644 --- a/squirrelbattle/game.py +++ b/squirrelbattle/game.py @@ -7,6 +7,7 @@ import sys from .entities.player import Player from .enums import GameMode, KeyValues, DisplayActions from .interfaces import Map +from .resources import ResourceManager from .settings import Settings from . import menus from typing import Callable @@ -38,7 +39,7 @@ class Game: Create a new game on the screen. """ # TODO generate a new map procedurally - self.map = Map.load("squirrelbattle/assets/example_map_2.txt") + self.map = Map.load(ResourceManager.get_asset_path("example_map_2.txt")) self.player = Player() self.map.add_entity(self.player) self.player.move(self.map.start_y, self.map.start_x) diff --git a/squirrelbattle/resources.py b/squirrelbattle/resources.py new file mode 100644 index 0000000..c71c267 --- /dev/null +++ b/squirrelbattle/resources.py @@ -0,0 +1,13 @@ +from pathlib import Path + + +class ResourceManager: + """ + The ResourceManager loads resources at their right place, + and stores files in config directory. + """ + BASE_DIR = Path(__file__).resolve().parent / 'assets' + + @classmethod + def get_asset_path(cls, filename: str) -> str: + return str(cls.BASE_DIR / filename) diff --git a/squirrelbattle/tests/entities_test.py b/squirrelbattle/tests/entities_test.py index 6cf2fe4..5cd6ad5 100644 --- a/squirrelbattle/tests/entities_test.py +++ b/squirrelbattle/tests/entities_test.py @@ -4,6 +4,7 @@ from squirrelbattle.entities.items import Bomb, Heart, Item from squirrelbattle.entities.monsters import Beaver, Hedgehog, Rabbit, TeddyBear from squirrelbattle.entities.player import Player from squirrelbattle.interfaces import Entity, Map +from squirrelbattle.resources import ResourceManager class TestEntities(unittest.TestCase): @@ -11,7 +12,7 @@ class TestEntities(unittest.TestCase): """ Load example map that can be used in tests. """ - self.map = Map.load("squirrelbattle/assets/example_map.txt") + self.map = Map.load(ResourceManager.get_asset_path("example_map.txt")) self.player = Player() self.map.add_entity(self.player) self.player.move(self.map.start_y, self.map.start_x) diff --git a/squirrelbattle/tests/interfaces_test.py b/squirrelbattle/tests/interfaces_test.py index a55a7b3..62f2092 100644 --- a/squirrelbattle/tests/interfaces_test.py +++ b/squirrelbattle/tests/interfaces_test.py @@ -2,6 +2,7 @@ import unittest from squirrelbattle.display.texturepack import TexturePack from squirrelbattle.interfaces import Map, Tile +from squirrelbattle.resources import ResourceManager class TestInterfaces(unittest.TestCase): @@ -18,7 +19,7 @@ class TestInterfaces(unittest.TestCase): """ Try to load a map from a file. """ - m = Map.load("squirrelbattle/assets/example_map.txt") + m = Map.load(ResourceManager.get_asset_path("example_map.txt")) self.assertEqual(m.width, 52) self.assertEqual(m.height, 17) From 0fbbf4925d496fdeea7e49e13671835ffb093aa9 Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 03:13:01 +0100 Subject: [PATCH 07/15] Store configuration in user configuration directory --- squirrelbattle/game.py | 7 ++++--- squirrelbattle/resources.py | 8 ++++++++ squirrelbattle/settings.py | 9 ++++++--- 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/squirrelbattle/game.py b/squirrelbattle/game.py index b22c4ed..f06843d 100644 --- a/squirrelbattle/game.py +++ b/squirrelbattle/game.py @@ -136,13 +136,14 @@ class Game: """ Loads the game from a file """ - if os.path.isfile("save.json"): - with open("save.json", "r") as f: + file_path = ResourceManager.get_config_path("save.json") + if os.path.isfile(file_path): + with open(file_path, "r") as f: self.load_state(json.loads(f.read())) def save_game(self) -> None: """ Saves the game to a file """ - with open("save.json", "w") as f: + with open(ResourceManager.get_config_path("save.json"), "w") as f: f.write(json.dumps(self.save_state())) diff --git a/squirrelbattle/resources.py b/squirrelbattle/resources.py index c71c267..fc6f708 100644 --- a/squirrelbattle/resources.py +++ b/squirrelbattle/resources.py @@ -7,7 +7,15 @@ class ResourceManager: and stores files in config directory. """ BASE_DIR = Path(__file__).resolve().parent / 'assets' + # FIXME This might not work on not-UNIX based systems. + CONFIG_DIR = Path.home() / '.config' / 'squirrel-battle' @classmethod def get_asset_path(cls, filename: str) -> str: return str(cls.BASE_DIR / filename) + + @classmethod + def get_config_path(cls, filename: str) -> str: + cls.CONFIG_DIR.mkdir(parents=True) if not cls.CONFIG_DIR.is_dir() \ + else None + return str(cls.CONFIG_DIR / filename) diff --git a/squirrelbattle/settings.py b/squirrelbattle/settings.py index 258d88f..6c2e31c 100644 --- a/squirrelbattle/settings.py +++ b/squirrelbattle/settings.py @@ -2,6 +2,8 @@ import json import os from typing import Any, Generator +from .resources import ResourceManager + class Settings: """ @@ -81,13 +83,14 @@ class Settings: """ Loads the settings from a file """ - if os.path.isfile("settings.json"): - with open("settings.json", "r") as f: + file_path = ResourceManager.get_config_path("settings.json") + if os.path.isfile(file_path): + with open(file_path, "r") as f: self.loads_from_string(f.read()) def write_settings(self) -> None: """ Dumps the settings into a file """ - with open("settings.json", "w") as f: + with open(ResourceManager.get_config_path("settings.json"), "w") as f: f.write(self.dumps_to_string()) From 082ac5e2608a7b531a66f150a2155690bdcd7a52 Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 03:14:34 +0100 Subject: [PATCH 08/15] Start at version 3.14 --- setup.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/setup.py b/setup.py index e0f8b35..29c391c 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ with open("README.md", "r") as f: setup( name="squirrel-battle", - version="1.0.0", + version="3.14", author="ynerant", author_email="ynerant@crans.org", description="Watch out for squirrel's knifes!", @@ -39,5 +39,4 @@ setup( "squirrel-battle = squirrelbattle.bootstrap:Bootstrap.run_game", ] } - ) From 926fba1e8292d8778bf835d1adb2dd4ad63d16ab Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 03:19:44 +0100 Subject: [PATCH 09/15] Update README to add PyPI installation --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c1d9b3..e34fcf8 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,20 @@ pour vérifier la syntaxe du code. ## Lancement du jeu -Il suffit d'exécuter `python3 main.py`. +Après clonage du projet, il suffit d'exécuter `python3 main.py`. + +Sinon, le jeu est déployé dans PyPI, et il suffit d'exécuter : + +``` +pip install squirrel-battle +``` + +pour télécharger et installer le jeu. Lancer `squirrel-battle` suffit ensuite +à lancer le jeu depuis n'importe où. Pour mettre à jour : + +``` +pip install --upgrade squirrel-battle +``` ## Gestion des émojis From b869331abb51ee75c3a3a8e84c5da37fc031a106 Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 03:29:00 +0100 Subject: [PATCH 10/15] Make Debian package --- .gitlab-ci.yml | 13 +++++++++++++ debian/README.debian | 5 +++++ debian/changelog | 5 +++++ debian/compat | 1 + debian/control | 15 +++++++++++++++ debian/copyright | 29 +++++++++++++++++++++++++++++ debian/rules | 5 +++++ 7 files changed, 73 insertions(+) create mode 100644 debian/README.debian create mode 100644 debian/changelog create mode 100644 debian/compat create mode 100644 debian/control create mode 100644 debian/copyright create mode 100644 debian/rules diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5ca51af..eef21e0 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -31,3 +31,16 @@ linters: - pip install tox script: tox -e linters allow_failure: true + +build-deb: + image: debian:buster-slim + stage: build + before_script: + - apt-get update && apt-get -y --no-install-recommends install build-essential debmake dh-python debhelper python3-all python3-setuptools + script: + - dpkg-buildpackage + - mkdir build && cp ../*.deb build/ + artifacts: + paths: + - build/*.deb + expire_in: 1 week diff --git a/debian/README.debian b/debian/README.debian new file mode 100644 index 0000000..8404efb --- /dev/null +++ b/debian/README.debian @@ -0,0 +1,5 @@ +Squirrel Battle + +Watch out for squirrel's knifes! + + -- Yohann D'ANELLO Thu, 19 Nov 2020 03:30:42 +0100 diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..fbc646d --- /dev/null +++ b/debian/changelog @@ -0,0 +1,5 @@ +squirrel-battle (3.14) beta; urgency=low + + * Initial release. + + -- Yohann D'ANELLO Thu, 19 Nov 2020 03:30:42 +0100 diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..9a03714 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +10 \ No newline at end of file diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..82f9581 --- /dev/null +++ b/debian/control @@ -0,0 +1,15 @@ +Source: squirrel-battle +Section: devel +Priority: optional +Maintainer: ynerant +Build-Depends: debhelper (>=10~), dh-python, python3-all, python3-setuptools +Standards-Version: 4.1.4 +Homepage: https://gitlab.crans.org/ynerant/dungeon-battle +X-Python3-Version: >= 3.6 + +Package: squirrel-battle +Architecture: all +Multi-Arch: foreign +Depends: ${misc:Depends}, ${python3:Depends} +Description: Squirrel Battle + Watch out for squirrel's knifes! \ No newline at end of file diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..275cafc --- /dev/null +++ b/debian/copyright @@ -0,0 +1,29 @@ + +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: shirenn +Upstream-Contact: shirenn +Source: https://gitlab.crans.org/pa/attestation + +Files: * +Copyright: 2020 Shirenn +License: GPL-3+ + 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 package; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, + Boston, MA 02110-1301 USA + . + On Debian systems, the full text of the GNU General Public + License version 3 can be found in the file + `/usr/share/common-licenses/GPL-3'. diff --git a/debian/rules b/debian/rules new file mode 100644 index 0000000..e29871f --- /dev/null +++ b/debian/rules @@ -0,0 +1,5 @@ +#!/usr/bin/make -f +export DH_VERBOSE = 1 + +%: + dh $@ --with python3 --buildsystem=pybuild From 49380d7c7a7c1f10b2131e076117730add806c4b Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 03:41:28 +0100 Subject: [PATCH 11/15] Make Debian package --- debian/copyright | 8 ++++---- debian/rules | 0 dungeonbattle/__init__.pyc | Bin 176 -> 0 bytes dungeonbattle/bootstrap.pyc | Bin 1075 -> 0 bytes 4 files changed, 4 insertions(+), 4 deletions(-) mode change 100644 => 100755 debian/rules delete mode 100644 dungeonbattle/__init__.pyc delete mode 100644 dungeonbattle/bootstrap.pyc diff --git a/debian/copyright b/debian/copyright index 275cafc..0ae9c45 100644 --- a/debian/copyright +++ b/debian/copyright @@ -1,11 +1,11 @@ Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ -Upstream-Name: shirenn -Upstream-Contact: shirenn -Source: https://gitlab.crans.org/pa/attestation +Upstream-Name: Yohann D'ANELLO +Upstream-Contact: Yohann D'ANELLO +Source: https://gitlab.crans.org/ynerant/dungeon-battle Files: * -Copyright: 2020 Shirenn +Copyright: 2020 Yohann D'ANELLO License: GPL-3+ This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public diff --git a/debian/rules b/debian/rules old mode 100644 new mode 100755 diff --git a/dungeonbattle/__init__.pyc b/dungeonbattle/__init__.pyc deleted file mode 100644 index c5124407892592c0feed40fde1506c5cf0dcda29..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 176 zcmZSn%**w~e`$O&0~9az*Q}arS^?eQX3ySiyQcL24U7;-fl+wKP)cic%q{NbvoKzSW%8QTB f%*!l^kJl@xEa3o}Zj+mzQks)$2XaFR5HkP(Lkld_ diff --git a/dungeonbattle/bootstrap.pyc b/dungeonbattle/bootstrap.pyc deleted file mode 100644 index 80c152bc030ab5343a9311a65911f7db09afefab..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1075 zcmcgqO^?$s5FI;d%9iq>l@Jnlq+Dpk9U%mZmdmb0inNf6l})TBRbp51RA{C4w1_Kb z{se!H9{@9U%7^y8X+4=Y@yB~_9R0jE`~LNZs$hH~dcUIKPASy%7tjIp0tx|wv4l=S zA3+fX96=XDKY?OGIEH!(^#r~ETmyV65~vecrgvzs_7^>=pbTRQr)94Lx=-k&b(^ld zIx9`N(nF}fnYdD{QU72lVCtk|SOK!`7ty z#yJOaO7+1%Z!jN%taV(PQVKq}g0if!z0P!7HH{ri)o7EQ*lODo6PKMm&o+ZyYgEg( zW0uuhv(nZ)yDSkqeSjmnJoII;x$-iJo0rLw9rFV@7e`_yj>TN0F=0PVDMK`s!WmVR z>TSIx{mLtHSYlg|h{o1AZ}C^bZOF*kTHhaTU?R`M@$4ubQyBdS1}uC_sS5b?#<#Hn ni$f2`E`=NL Date: Thu, 19 Nov 2020 03:45:36 +0100 Subject: [PATCH 12/15] Debian package depends on fonts-noto-color-emoji --- debian/control | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/debian/control b/debian/control index 82f9581..658a619 100644 --- a/debian/control +++ b/debian/control @@ -3,6 +3,7 @@ Section: devel Priority: optional Maintainer: ynerant Build-Depends: debhelper (>=10~), dh-python, python3-all, python3-setuptools +Depends: fonts-noto-color-emoji Standards-Version: 4.1.4 Homepage: https://gitlab.crans.org/ynerant/dungeon-battle X-Python3-Version: >= 3.6 @@ -10,6 +11,6 @@ X-Python3-Version: >= 3.6 Package: squirrel-battle Architecture: all Multi-Arch: foreign -Depends: ${misc:Depends}, ${python3:Depends} +Depends: fonts-noto-color-emoji, ${python3:Depends} Description: Squirrel Battle Watch out for squirrel's knifes! \ No newline at end of file From 58a841150b7699e5ba3c65cc71c2de2834bb4274 Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 03:54:54 +0100 Subject: [PATCH 13/15] Rename debian package to python3-squirrelbattle --- debian/control | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/debian/control b/debian/control index 658a619..6a1e372 100644 --- a/debian/control +++ b/debian/control @@ -1,4 +1,4 @@ -Source: squirrel-battle +Source: python3-squirrelbattle Section: devel Priority: optional Maintainer: ynerant @@ -8,7 +8,7 @@ Standards-Version: 4.1.4 Homepage: https://gitlab.crans.org/ynerant/dungeon-battle X-Python3-Version: >= 3.6 -Package: squirrel-battle +Package: python3-squirrelbattle Architecture: all Multi-Arch: foreign Depends: fonts-noto-color-emoji, ${python3:Depends} From 20a9743b9fdf63b7419e3a5c3b012139e9ffa042 Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 04:01:02 +0100 Subject: [PATCH 14/15] Add build Gitlab CI stage --- .gitlab-ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index eef21e0..6cb844c 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,6 +1,7 @@ stages: - test - quality-assurance + - build py37: stage: test From d4b75bac236e2e352295b94528ed26b1a0ea57de Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Thu, 19 Nov 2020 04:03:35 +0100 Subject: [PATCH 15/15] Wrong app name in Debian changelog --- debian/changelog | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/debian/changelog b/debian/changelog index fbc646d..7686c57 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,4 +1,4 @@ -squirrel-battle (3.14) beta; urgency=low +python3-squirrelbattle (3.14) beta; urgency=low * Initial release.