diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /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. + + + 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/assets/BATTLERS.toml b/assets/BATTLERS.toml new file mode 100644 index 0000000..6c1304a --- /dev/null +++ b/assets/BATTLERS.toml @@ -0,0 +1,7 @@ +["King J.J. Akke"] +hp = 100 +hands = 'big grabbies' +armor = 'regal fur' +atk = 13 +def = 6 +art = '<^===,=,~~' diff --git a/assets/GAME_ITEMS.toml b/assets/GAME_ITEMS.toml new file mode 100644 index 0000000..8efb3a0 --- /dev/null +++ b/assets/GAME_ITEMS.toml @@ -0,0 +1,52 @@ +'lil grabbies' = [ + 'hands', + 'lil grabbies (not paws) that CAN grab and grip!', + 5 +] +'fur' = [ + 'armor', + "Fernando's coat!", + 5 +] +"Landlord's Sword" = [ + 'hands', + "Old Cheese Landlord's smelly sword.", + 10 +] +'Cup of Coffee' = [ + 'potion', + 'A cup of perfectly blended and brewed coffee made by the Witch Rat.', + """ + $game_vars{coffee_consumed} = 1; + dialog('Fernando', qq(Mmm... coffee...), 0); # no redraw + item_remove('Cup of Coffee'); + status_add('Caffinated'); + """ +] +'hp potion' = [ + 'potion', + 'this potion heals Fernando to full health! great stuff!', + """ + $hp = $max_hp; + item_remove('hp potion'); + """ +] +'Cool Sword' = [ + 'hands', + 'This sword radiates coolness.', + 15 +] +'Chainmail Armor' = [ + 'armor', + """Naturally, rats can wear chainmail. +Read a book or something.""", + 7 +] +'Shrubbery' = [ + 'key item', + "Some bush that Rats that say 'Ni!' want." +] +'Frog' = [ + 'key item', + 'Frog that probably is good enough to be a familiar. Maybe.' +] diff --git a/assets/cool_cave.toml b/assets/cool_cave.toml index 66e1ceb..a218237 100644 --- a/assets/cool_cave.toml +++ b/assets/cool_cave.toml @@ -2,11 +2,11 @@ interact = [ [ 26, 32, "mountain_village" ], ] npc = [ - [14,33,"S","cool_sword", "none", "magenta_black"] + [14,33,"S", "cool_sword","cool_sword", "none", "magenta_black"] ] map_script = """ if (exists $game_vars{cool_sword} and $game_vars{cool_sword} == 1) { - delete $npcs{S}; + delete $npcs{cool_sword}; } """ [npc_movements] @@ -23,7 +23,7 @@ else { if ($chance == 2) { dialog('Cool Sword',qq(Woah. You're Cool. I'll let you wield me)); item(qq(Cool Sword)); - delete $npcs{S}; + delete $npcs{cool_sword}; $game_vars{cool_sword} = 1; } else { diff --git a/assets/gate.toml b/assets/gate.toml index e199040..bc096b2 100644 --- a/assets/gate.toml +++ b/assets/gate.toml @@ -3,15 +3,15 @@ interact = [ [ 19, 0, "other_side" ], ] npc = [ - [ 15,33, "q", "rat_ni", "random_movement", "yellow_black"], - [ 22,48, "y", "rat_ni", "random_movement", "yellow_black"], - [ 17,62, "p", "rat_ni", "random_movement", "yellow_black"], - [ 22, 6, "d", "rat_ni", "random_movement", "yellow_black"], - [ 19,12, "U", "shrubbery", "none", "cyan_black"], # comment this out + [ 15,33, "q", "q", "rat_ni", "random_movement", "yellow_black"], + [ 22,48, "y", "y", "rat_ni", "random_movement", "yellow_black"], + [ 17,62, "p", "p", "rat_ni", "random_movement", "yellow_black"], + [ 22, 6, "d", "d", "rat_ni", "random_movement", "yellow_black"], + [ 19,12, "U", "U", "shrubbery", "none", "cyan_black"], ] map_script = """ if (exists $game_vars{shrubbery} and $game_vars{shrubbery} == 3) { - $npcs{U}->[3] = 'random_movement'; + $npcs{U}->[4] = 'random_movement'; $npcs{U}->[0] = 14; $npcs{U}->[1] = 26; } @@ -37,7 +37,7 @@ elsif ($game_vars{shrubbery} == 1) { elsif ($game_vars{shrubbery} == 2) { dialog(qq(Rats that say 'Ni!'), qq(WE ARE THE RATS THAT SAY 'NI!'\nYOU HAVE A SHRUBBERY? VERY WELL, YOU MAY PASS.)); $game_vars{shrubbery} = 3; - $npcs{U}->[3] = 'random_movement'; + $npcs{U}->[4] = 'random_movement'; quest_desc_add(qq(\nI have found the shrubbery and presented it to the Rats that say 'Ni!'. They\nhave granted me passage though the only gate on this world.), 'shrubbery'); } elsif ($game_vars{shrubbery} == 3) { diff --git a/assets/inner_king_palace.toml b/assets/inner_king_palace.toml index 9f48579..47c9bfb 100644 --- a/assets/inner_king_palace.toml +++ b/assets/inner_king_palace.toml @@ -2,11 +2,11 @@ interact = [ [ 39, 39, "outer_king_palace" ] ] npc = [ - [8,66,"j","jjakke", "none", "green_black"] + [8,66,"j", "j", "jjakke", "none", "green_black"] ] map_script = """ if (exists $game_vars{jjakke} and $game_vars{jjakke} == 4) { - $npcs{j}->[4] = 'black_red'; + $npcs{j}->[5] = 'black_red'; } """ [npc_movements] @@ -47,9 +47,10 @@ elsif ($game_vars{jjakke} == 3) { else { dialog('King J.J. Akke', qq(I can't believe I died to such a... lame sword!\nx_x)); } - $npcs{j}->[4] = 'black_red'; + $npcs{j}->[5] = 'black_red'; $game_vars{jjakke} = 4; $game_vars{mom} = 5; + draw_npcs(); # force a redraw of King J.J. Akke } """ diff --git a/assets/main_menu.toml b/assets/main_menu.toml index ad5877c..d135e2d 100644 --- a/assets/main_menu.toml +++ b/assets/main_menu.toml @@ -1,5 +1,5 @@ do_this = """ -if (-e $save_file and -r $save_file) { +if (-e $game_config->{save_file} and -r $game_config->{save_file}) { move(15,11); printw("(l)oad game"); } diff --git a/assets/new_cheese.toml b/assets/new_cheese.toml index 25822c4..0892f31 100644 --- a/assets/new_cheese.toml +++ b/assets/new_cheese.toml @@ -3,9 +3,9 @@ interact = [ [28, 23, "cheese_farm"], ] npc = [ - [35,7,'F','frog','random_movement','green_black'], - [27,30,'l', 'landlord', 'random_movement', 'cyan_black'], - [ 34, 39, "S", "bush", "none", "red_green"], + [35,7,'F', 'F', 'frog','random_movement','green_black'], + [27,30,'l', 'l', 'landlord', 'random_movement', 'cyan_black'], + [ 34, 39, "S", 'S', "bush", "none", "red_green"], ] map_script = """ if (exists $game_vars{witch} and $game_vars{witch} >= 3) { diff --git a/assets/old_cheese.toml b/assets/old_cheese.toml index 6ba3880..50f577c 100644 --- a/assets/old_cheese.toml +++ b/assets/old_cheese.toml @@ -15,11 +15,11 @@ interact = [ [ 39, 37, "exit" ], [ 2, 54, "landlord_sword"], ] -npc = [ - [ 26, 26, "m", "mom", "random_movement", "green_black"], - [ 23, 13, "b", "bob", "bob1", "white_black"], - [ 36, 14, "j", "joe", "none", "white_black"], - [ 2, 54, "S", "landlord_sword", "none", "red_black" ], +npc = [ + [ 26, 26, "m", "m", "mom", "random_movement", "green_black"], + [ 23, 13, "b", "b", "bob", "bob1", "white_black"], + [ 36, 14, "j", "j", "joe", "none", "white_black"], + [ 2, 54, "S", "S", "landlord_sword", "none", "red_black" ], ] map_script = """ if (exists $game_vars{mom} and $game_vars{mom} >= 2) { @@ -35,7 +35,7 @@ none = ['w'] "fernandos_hut" = " dialog('Sign', \"Fernando's Hut\") " "bobs_hut" = " dialog('Sign', \"Bob's Hut\") " "joes_hut" = " dialog('Sign', \"Joe's Hut\") " -"landlords_house" = " dialog('Sign', \"House of the Landlord. Do not steal anything.\") " +"landlord_house" = " dialog('Sign', \"House of the Landlord. Do not steal anything.\") " stables = "dialog('Sign', 'Stables')" "cheese_farm" = "dialog('Sign', 'Cheese Farm; our only source of income. It would\nbe BAD if something happened to it.')" horse = "dialog('Horse','Neigh.')" diff --git a/assets/outer_king_palace.toml b/assets/outer_king_palace.toml index aefab91..fc11486 100644 --- a/assets/outer_king_palace.toml +++ b/assets/outer_king_palace.toml @@ -3,16 +3,16 @@ interact = [ [ 8, 35, "inner_king_palace"] ] npc = [ - [18,24, 'g', 'guardl1', 'guardl_no_caffine', 'yellow_black'], - [18,46, 'p', 'guardr1', 'guardr_no_caffine', 'yellow_black'], - [15,54, 'C', 'chainmail', 'none', 'cyan_white'], + [18,24, 'g', 'g', 'guardl1', 'guardl_no_caffine', 'yellow_black'], + [18,46, 'p', 'p', 'guardr1', 'guardr_no_caffine', 'yellow_black'], + [15,54, 'C', 'C', 'chainmail', 'none', 'cyan_white'], ] map_script = """ if (exists $game_vars{coffee_consumed}) { - $npcs{g}->[2] = 'guardl2'; - $npcs{g}->[3] = 'guardl_yes_caffine'; - $npcs{p}->[2] = 'guardr2'; - $npcs{p}->[3] = 'guardr_yes_caffine'; + $npcs{g}->[3] = 'guardl2'; + $npcs{g}->[4] = 'guardl_yes_caffine'; + $npcs{p}->[3] = 'guardr2'; + $npcs{p}->[4] = 'guardr_yes_caffine'; } if (exists $game_vars{chainmail}) { delete $npcs{C}; diff --git a/assets/test.map b/assets/test.map index 2288bec..2fe2c3b 100644 --- a/assets/test.map +++ b/assets/test.map @@ -3,7 +3,7 @@ # # # # # # -# # +# J # # # # # # # diff --git a/assets/test.toml b/assets/test.toml new file mode 100644 index 0000000..b6435b8 --- /dev/null +++ b/assets/test.toml @@ -0,0 +1,16 @@ +interact = [ +] +npc = [ + [ 15, 33, "J", "uid", "object", "movement_behavior", "red_yellow" ] +] +map_script = """ +""" +[npc_movements] +movement_behavior = ['w'] + +[objects] +object = """ + dialog('Jjakke', qq(Testing, testing. Line one!)); + dialog('Jjakke', qq(Line two!!)); + dialog('Jjakke', qq(Line three)); +""" diff --git a/assets/witch_village.toml b/assets/witch_village.toml index b50a78a..f4abcf2 100644 --- a/assets/witch_village.toml +++ b/assets/witch_village.toml @@ -3,13 +3,14 @@ interact = [ [19,30, "coffee_sign"], ] npc = [ - [16,39, "W", "witch", "random_movement", "red_black"] + [16,39, "W", "W", "witch", "random_movement", "red_black"] ] map_script = """ if (exists $game_vars{witch} and $game_vars{witch} == 4) { - $npcs{F} = [15, 36, "frog", "random_movement", "green_black"]; - move(15,36); - addstr("F"); + # eg player save the game here then load it; kinda weird to see two Sir Ribbits + if (not exists $npcs{F}) { + $npcs{F} = [15, 36, 'F', "frog", "random_movement", "green_black"]; + } } """ [npc_movements] @@ -32,7 +33,8 @@ elsif ($game_vars{witch} == 3) { item_remove(qq(Frog)); $game_vars{witch} = 4; quest_desc_add(qq(\nThe Witch Rat is happy with the frog I gave her and gave me some coffee in\nturn.), 'witch_quest'); - $npcs{F} = [15, 36, "frog", "random_movement", "green_black"]; + $npcs{F} = [15, 36, 'F', "frog", "random_movement", "green_black"]; + draw_npcs(); # draw Sir Ribbit } elsif ($game_vars{witch} == 4) { dialog('Witch Rat', qq(Thank you again for bringing me Sir Ribbet.)); diff --git a/assets/worldmap.toml b/assets/worldmap.toml index cfe92bc..c102e99 100644 --- a/assets/worldmap.toml +++ b/assets/worldmap.toml @@ -1,18 +1,18 @@ interact = [ - [ 7, 52, "gate1" ], - [ 7, 53, "gate2" ], - [ 13, 14, "old_cheese" ], - [ 8, 23, "cave_w" ], - [ 15, 33, "cave_e" ], - [ 31, 9, "new_cheese" ], - [ 36, 39, "witch_village" ], - [ 6, 61, "king" ], - [ 6, 62, "king" ], - [ 5, 61, "king" ], - [ 6, 62, "king" ], ] -npc = [ - [ 25, 13, "r", "mr_rat", "none", "white_black" ], +npc = [ + [ 25, 13, "r", "r", "mr_rat", "none", "white_black" ], + [ 13, 14, "V", "old_cheese", "old_cheese", "none", "yellow_black" ], + [ 31, 9, "V", "new_cheese", "new_cheese", "none", "yellow_black" ], + [ 36, 39, "V", "witch_village", "witch_village", "none", "yellow_black" ], + [ 6, 61, "K", "king1", "king", "none", "yellow_black"], + [ 6, 62, "K", "king2", "king", "none", "yellow_black"], + [ 5, 61, "K", "king3", "king", "none", "yellow_black"], + [ 5, 62, "K", "king4", "king", "none", "yellow_black"], + [ 7, 52, "g", "gate1", "gate1", "none", "yellow_black" ], + [ 7, 53, "g", "gate2", "gate2", "none", "yellow_black" ], + [ 8, 23, "C", "cave_w", "cave_w", "none", "yellow_black" ], + [ 15, 33, "C", "cave_e", "cave_e", "none", "yellow_black" ] ] map_script = """ """ diff --git a/check_all_tomls.pl b/check_all_tomls.pl new file mode 100755 index 0000000..1845502 --- /dev/null +++ b/check_all_tomls.pl @@ -0,0 +1,81 @@ +#!/usr/bin/env perl +# this 'check_all_tomls.pl' is licensed under the GPL3, see LICENSE file for more details. +# if LICENSE isn't available, see < https://www.gnu.org/licenses/gpl-3.0.en.html > +# +# this just evals every toml file and reports non-compile-able/non-runtime-able/invalid toml files. +# not a perfect solution but will make sure you're shit isn't totally broken + +use strict; +use warnings; +use v5.12; # readdir in while-loop + +use TOML; +use File::Slurper qw(read_text write_text); +#use Carp::Always; + +my ($game_config, $game_items, $battlers, $err); + +($game_config, $err) = from_toml(read_text('./game.pl.toml')); +if ($err) { + die $err; +} +($game_items, $err) = from_toml(read_text('./assets/GAME_ITEMS.toml')); +if ($err) { + die $err; +} +($battlers, $err) = from_toml(read_text('./assets/BATTLERS.toml')); +if ($err) { + die $err; +} + +# try to load global values by default; some toml scripts might touch them +my $player = $game_config->{newgame_player}; +my $f_y = $game_config->{newgame_y}; +my $f_x = $game_config->{newgame_x}; +my $dialog_mode = 0; +my $menu_mode = 0; +my $battle_mode = 0; +my $hp = $game_config->{newgame_hp}; +my $max_hp = $game_config->{newgame_max_hp}; +my $atk = $game_config->{newgame_atk}; +my $def = $game_config->{newgame_def}; +my $lvl = $game_config->{newgame_lvl}; +my $class = $game_config->{newgame_class}; +my $hands = $game_config->{newgame_hands}; +my $armor = $game_config->{newgame_armor}; + +my $curr_map = $game_config->{newgame_map}; +my @inventory = @{ $game_config->{newgame_inventory} }; + +my %game_vars; +my %npcs; +my %journal; + +opendir my $dh, './assets' or die 'lol lmao fucking dumbass'; +while (my $file = readdir $dh) { + next if (substr ($file, -4, 4) ne 'toml'); + my ($toml, $err) = from_toml(read_text("./assets/$file")); + if ($err) { + say "toml $file error:\n$err"; + } + ## no critic (eval) + eval $toml->{map_script} if $toml->{map_script}; + if ($@) { + say "$file (map_script)\n$@"; + } + + for (sort keys %{ $toml->{objects} }) { + eval $toml->{objects}->{$_}; + if ($@) { + say "$file $_ (object)\n$@"; + } + } +} +closedir $dh; + +# don't report subroutines that game.pl has +sub teleport {}; +sub dialog {}; +sub item {}; +sub addch {}; # Curses specific subroutine +sub quest {}; diff --git a/game.pl b/game.pl index 4b16a28..583c3bb 100755 --- a/game.pl +++ b/game.pl @@ -1,5 +1,6 @@ #!/usr/bin/env perl -# This 'game.pl' is licensed under the GPL3 +# This 'game.pl' is licensed under the GPL3 as seen in LICENSE. +# if LICENSE is not available, see < https://www.gnu.org/licenses/gpl-3.0.en.html > use strict; use warnings; @@ -11,11 +12,31 @@ use 5.010; # as utf8 'chars' are like 3+ bytes # (which would make fixing the resize bug easier) +# uncomment below when 'game.pl' is default shell for a user. +#use POSIX qw(locale_h); +#use locale; +#setlocale(LC_CTYPE, "en_US.UTF-8"); # hope you have this generated :) + use Curses; use TOML; use File::Slurper qw(read_text write_text); +use Carp::Always; +use Smart::Comments; -my $save_file = './jjakkes-fernando-game.save.toml'; +my ($game_config, $game_items, $battlers, $err); + +($game_config, $err) = from_toml(read_text('./game.pl.toml')); +if ($err) { + die $err; +} +($game_items, $err) = from_toml(read_text('./assets/GAME_ITEMS.toml')); +if ($err) { + die $err; +} +($battlers, $err) = from_toml(read_text('./assets/BATTLERS.toml')); +if ($err) { + die $err; +} initscr(); cbreak(); @@ -54,62 +75,32 @@ $SIG{'WINCH'} = sub { $size_changed = 1; }; my $max_y = 40; # Curses inits at top left, down is y+1, right is x+1 ( y,x NOT x,y ) my $max_x = 80; +my $grass = ' '; # ???? +my $empty = '.'; # ???? -my $grass = ' '; -my $empty = '.'; -my $fernando = 'f'; -my $f_y = 25; -my $f_x = 15; +my $player = $game_config->{newgame_player}; +my $f_y = $game_config->{newgame_y}; +my $f_x = $game_config->{newgame_x}; my $dialog_mode = 0; my $menu_mode = 0; my $battle_mode = 0; -my $hp = 100; -my $max_hp = 100; -my $atk = 5; -my $def = 5; -my $lvl = 1; -my $class = 'rat'; -my $hands = 'lil grabbies'; -my $armor = 'fur'; +my $hp = $game_config->{newgame_hp}; +my $max_hp = $game_config->{newgame_max_hp}; +my $atk = $game_config->{newgame_atk}; +my $def = $game_config->{newgame_def}; +my $lvl = $game_config->{newgame_lvl}; +my $class = $game_config->{newgame_class}; +my $hands = $game_config->{newgame_hands}; +my $armor = $game_config->{newgame_armor}; -my $curr_map = 'old_cheese'; +my $curr_map = $game_config->{newgame_map}; my $scripts; -my %npcs; # coming in ( 25, 23, 'r', "mr. rat", $movement_pattern, color ); actual hash %{ y, x, $object, $movement_pattern, color } +my %npcs; # coming in ( 25, 23, 'r', uid, OBJECT (in objects table), $movement_pattern, color ); actual hash uid -> %{ y, x, 'r', OBJECT, $movement_pattern, color } my %npc_movements; # %{ 'bob1' => 0 } # 0 == array index and 'bob1' refers to $scripts->{npc_movements}->{bob1} my %game_vars; -my %game_items = ( - 'lil grabbies' => ['hands', 'lil grabbies (not paws) that CAN grab and grip!', 5], - 'fur' => ['armor', 'Fernando\'s coat!',5], - 'Landlord\'s Sword' => ['hands', qq(Old Cheese Landlord's smelly sword.), 10], - 'Cup of Coffee' => ['potion', 'A cup of perfectly blended and brewed coffee made by the Witch Rat.', - sub { - $game_vars{coffee_consumed} = 1; - dialog('Fernando', qq(Mmm... coffee...)); - item_remove('Cup of Coffee'); - status_add('Caffinated'); - } - ], - 'hp potion' => ['potion', 'this potion heals Fernando to full health! great stuff!', - sub { $hp = $max_hp; item_remove('hp potion'); } - ], - 'Cool Sword' => ['hands', qq(This sword radiates coolness.), 15], - 'Chainmail Armor' => ['armor', qq(Naturally, rats can wear chainmail.\nRead a book or something.), 7], - Shrubbery => ['key item', qq(Some bush that Rats that say 'Ni!' want.)], - Frog => ['key item', qq(Frog that probably is good enough to be a familiar. Maybe.)], -); -my @inventory = ('lil grabbies', 'fur'); +my @inventory = @{ $game_config->{newgame_inventory} }; my @status = (); my %journal; -my %battlers = ( - 'King J.J. Akke' => { - hp => 100, - hands => 'big grabbies', - armor => 'regal fur', - atk => 13, - def => 6, - art => '<^===,=,~~', - }, -); my %battle_sess; sub draw_map { @@ -138,7 +129,12 @@ sub is_move_ok { sub get_scripts { my $file = shift; $file = "$file.toml"; - $scripts = from_toml(read_text('./assets/' . $file)); + my $err; + ($scripts, $err) = from_toml(read_text('./assets/' . $file)); + if ($err) { + endwin(); + die "Error parsing toml: $err"; + } create_npcs($scripts); }; @@ -146,25 +142,27 @@ sub create_npcs { undef %npcs; undef %npc_movements; my $scripts = shift; - # ( 25, 23, 'r', "mr. rat", $behavior, color ); + # 0 1 2 3 4 5 6 + # ( 25, 23, 'r', uid, "mr. rat", $behavior, color ); for my $npc (@{ $scripts->{npc} }) { - # %{ 'r' => [25, 23, "mr. rat", $behavior, color] } - $npcs{ $npc->[2] } = [$npc->[0], $npc->[1], $npc->[3], $npc->[4], $npc->[5]]; + # key uid 0 y 1 x 2 char 3 object 4 behavior 5 color + $npcs{ $npc->[3] } = [$npc->[0], $npc->[1], $npc->[2], $npc->[4], $npc->[5], $npc->[6]]; + # pain. this shit should've been oop'd away. }; }; sub draw_npcs { for my $npc (keys %npcs ) { move($npcs{$npc}->[0], $npcs{$npc}->[1]); - if ($npcs{$npc}->[4] ) { + if ($npcs{$npc}->[5] ) { attroff( COLOR_PAIR( $colors{white_black} )); - attron( COLOR_PAIR( $colors{ $npcs{$npc}->[4] } )); - addstr($npc); - attroff( COLOR_PAIR( $colors{ $npcs{$npc}->[4] } )); + attron( COLOR_PAIR( $colors{ $npcs{$npc}->[5] } )); + addstr($npcs{$npc}->[2]); + attroff( COLOR_PAIR( $colors{ $npcs{$npc}->[5] } )); attron( COLOR_PAIR( $colors{white_black} )); } else { - addstr($npc); + addstr($npcs{$npc}->[2]); } } refresh(); @@ -175,8 +173,8 @@ sub draw_npcs { # I don't feel like doing this rn. sub engage_npcs { for my $npc (keys %npcs) { - if($npcs{$npc}->[3]) { - my $behavior = $npcs{$npc}->[3]; + if($npcs{$npc}->[4]) { + my $behavior = $npcs{$npc}->[4]; if ($behavior eq 'random_movement') { random_movement_npc($npc); } @@ -226,7 +224,7 @@ sub custom_movement_npc { r => sub { my $npc = shift; return $npc->[0], $npc->[1] + 1; }, u => sub { my $npc = shift; return $npc->[0] - 1, $npc->[1]; }, d => sub { my $npc = shift; return $npc->[0] + 1, $npc->[1]; }, - w => sub { my $npc = shift; return -1, -1; }, + w => sub { return -1, -1; }, ); # enjoy, future me. :^) @@ -258,7 +256,8 @@ sub run_map_script { if ($scripts->{map_script}) { eval $scripts->{map_script}; if ($@) { - warn $@; + endwin(); + die $@; } } }; @@ -282,7 +281,7 @@ sub interact { } elsif (($interact_list->[0] == $y - 1) and $interact_list->[1] == $x) { # to the up $object = $interact_list->[2]; goto INTERACT_GOTO; - } elsif ($interact_list->[0] == $y and $interact_list->[1] == $x) { # right on top of it + } elsif ($interact_list->[0] == $y and $interact_list->[1] == $x) { # right on top of it (which is a bug but w/e) $object = $interact_list->[2]; goto INTERACT_GOTO; } @@ -290,19 +289,19 @@ sub interact { # check each and all npcs for my $npc (keys %npcs) { if ($npcs{$npc}->[0] == $y and $npcs{$npc}->[1] == $x + 1) { # to the right - $object = $npcs{$npc}->[2]; + $object = $npcs{$npc}->[3]; goto INTERACT_GOTO; } elsif ($npcs{$npc}->[0] == $y and $npcs{$npc}->[1] == $x - 1) { # to the left - $object = $npcs{$npc}->[2]; + $object = $npcs{$npc}->[3]; goto INTERACT_GOTO; } elsif (($npcs{$npc}->[0] == $y + 1) and $npcs{$npc}->[1] == $x) { # to the down - $object = $npcs{$npc}->[2]; + $object = $npcs{$npc}->[3]; goto INTERACT_GOTO; } elsif (($npcs{$npc}->[0] == $y - 1) and $npcs{$npc}->[1] == $x) { # to the up - $object = $npcs{$npc}->[2]; + $object = $npcs{$npc}->[3]; goto INTERACT_GOTO; - } elsif ($npcs{$npc}->[0] == $y and $npcs{$npc}->[1] == $x) { # right on top of it - $object = $npcs{$npc}->[2]; + } elsif ($npcs{$npc}->[0] == $y and $npcs{$npc}->[1] == $x) { # right on top of it (which is a bug but w/e) + $object = $npcs{$npc}->[3]; goto INTERACT_GOTO; } } @@ -313,19 +312,41 @@ sub interact { ## no critic (eval) eval $scripts->{objects}->{$object}; if ($@) { - warn $@; + endwin(); + die $@; } refresh(); } } sub dialog { - my ($name, $dialog) = @_; + my ($name, $dialog, $redraw) = @_; + defined $redraw or $redraw = 1; # redraw by default. $dialog_mode = 1; dialog_box(); dialog_wrap($name, $dialog); - move($f_y, $f_x); + #move($f_y, $f_x); + while () { + my $input = getchar(); + if ($input eq ' ' or $input eq KEY_ENTER) { + if ($redraw) { + endwin(); + draw_map($curr_map); + draw_npcs(); + addch($f_y, $f_x, $player); + move($f_y, $f_x); + refresh(); + $dialog_mode = 0; + last; + } + else { + # note that this doesn't toggle $dialog_mode + # inventory_item_menu() handles this ok + last; + } + } + } }; sub dialog_box { @@ -391,17 +412,6 @@ sub game_loop { } if ($dialog_mode) { - $input = getchar(); - if ($input eq ' ' or $input eq KEY_ENTER) { - endwin(); - draw_map($curr_map); - draw_npcs(); - addch($f_y, $f_x, $fernando); - move($f_y, $f_x); - refresh(); - $dialog_mode = 0; - } - next; } if ($menu_mode) { $input = getchar(); @@ -427,7 +437,7 @@ sub game_loop { %npc_movements and $save->{npc_movements} = \%npc_movements; %npcs and $save->{npcs} = \%npcs; - write_text($save_file, to_toml($save)); + write_text($game_config->{save_file}, to_toml($save)); move(1,1); printw("saved"); } elsif ($input eq 'i') { @@ -447,7 +457,7 @@ sub game_loop { } move($f_y, $f_x); - addstr($fernando); + addstr($player); move($f_y, $f_x); refresh(); $input = getchar(); @@ -616,6 +626,7 @@ sub main_menu { # } # (n)ew # load should read in a TOML file and replace the current global values + ## no critic (io layer) open my $fh, '<:utf8','./assets/main_menu' or endwin() and die "$!"; move(0,0); @@ -626,13 +637,17 @@ sub main_menu { my $script = from_toml(read_text('./assets/main_menu.toml')); ## no critic (eval) eval $script->{do_this}; + if ($@) { + endwin(); + die $@; + } while () { my $input = getchar(); if ($input eq 'n') { game_loop(1); last; } elsif ($input eq 'l') { - my $save = from_toml(read_text($save_file)); + my $save = from_toml(read_text($game_config->{save_file})); $f_y = $save->{f_y}; $f_x = $save->{f_x}; $hp = $save->{hp}; @@ -703,7 +718,7 @@ sub inventory_item_menu { printw("(equiped)"); } - my ($type, $desc, $behavior) = @{ $game_items{$id} }; + my ($type, $desc, $behavior) = @{ $game_items->{$id} }; move(++$r, 2); printw("$id: $type "); if ($type eq 'hands') { @@ -739,14 +754,14 @@ sub inventory_item_menu { printw('Inventory Item: q -> back, e -> equip (equiped)'); } elsif ($type eq 'potion') { ## no critic (eval) - eval &$behavior; - # disgusting hack + eval $behavior; + if ($@) { + endwin(); + die $@; + } if ($dialog_mode) { - my $d_input = getchar(); - if ($d_input eq ' ') { - $dialog_mode = 0; - last; - } + $dialog_mode = 0; + last; } } elsif ($type eq 'key item') { ; # nothing @@ -757,14 +772,14 @@ sub inventory_item_menu { sub item { my $item = shift; - exists $game_items{$item} + exists $game_items->{$item} and push (@inventory, $item) or dialog('system', "Sorry player, this item\n`$item'\ndoesn't exist in the game system."); } sub item_remove { my $item = shift; - exists $game_items{$item} + exists $game_items->{$item} or dialog('system', "Sorry player, this item \n`$item`\n cannot be remove as it doesn't exist in game system.") and return; @@ -797,16 +812,16 @@ sub status_add { sub battle { my $battler = shift; - exists $battlers{$battler} + exists $battlers->{$battler} or return; undef %battle_sess; - $battle_sess{hp} = $battlers{$battler}{hp}; + $battle_sess{hp} = $battlers->{$battler}{hp}; $battle_sess{battler} = $battler; - $battle_sess{atk} = $battlers{$battler}{atk}; - $battle_sess{hands} = $battlers{$battler}{hands}; - $battle_sess{def} = $battlers{$battler}{def}; - $battle_sess{armor} = $battlers{$battler}{armor}; - $battle_sess{art} = $battlers{$battler}{art}; + $battle_sess{atk} = $battlers->{$battler}{atk}; + $battle_sess{hands} = $battlers->{$battler}{hands}; + $battle_sess{def} = $battlers->{$battler}{def}; + $battle_sess{armor} = $battlers->{$battler}{armor}; + $battle_sess{art} = $battlers->{$battler}{art}; $battle_mode = 1; while () { battle_screen_update(); @@ -817,7 +832,7 @@ sub battle { endwin(); exit; } - elsif ($battle_sess{hp} < 0) { + elsif ($battle_sess{hp} <= 0) { last; } diff --git a/game.pl.toml b/game.pl.toml new file mode 100644 index 0000000..8c89707 --- /dev/null +++ b/game.pl.toml @@ -0,0 +1,19 @@ +'save_file' = './jjakkes-fernando-game.save.toml' + +newgame_map = 'old_cheese' +newgame_y = 25 +newgame_x = 15 + +grass = ' ' +empty = '.' + +newgame_player = 'f' +newgame_inventory = ['lil grabbies', 'fur'] +newgame_class = 'rat' +newgame_hp = 100 +newgame_max_hp = 100 +newgame_atk = 5 +newgame_def = 5 +newgame_lvl = 1 +newgame_hands = 'lil grabbies' +newgame_armor = 'fur'