diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/Main.hs b/Main.hs new file mode 100644 --- /dev/null +++ b/Main.hs @@ -0,0 +1,1078 @@ +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +module Main where + +-- base, mtl, array, containers, random, monad-loops, ncurses, astar, hfov +import Control.Monad.State +import Data.Array.IArray +import Data.Array.IO +import Data.List (sortBy, find) +import Data.Ord (comparing) +import qualified Data.Set as Set +import Data.Maybe +import System.Random +import Control.Monad.Loops (iterateUntil) +import Data.Graph.AStar (aStar) +import UI.NCurses +import FOV + +type Vector2 = (Int, Int) +type Room = (Vector2, Vector2) -- xy, size +type LevelPart = [(Vector2, Char)] -- update for array +-- change Level to include entities, dlvl, and narr, +-- then change dungeon to [dungeon] to allow many levels +type Level = Array Vector2 Char +type Neighbours = Array Vector2 (Set.Set Vector2) + +newtype GameT s m a = GameT (StateT s m a) + deriving (Functor, Monad, MonadIO, MonadTrans, MonadState s) + +type Game = GameT GameState Curses + +runGame1 :: GameState -> Game a -> Curses GameState +runGame1 s (GameT f) = execStateT f s + +io :: IO a -> Game a +io = liftIO + +curses :: Curses a -> Game a +curses = lift + +data Side = T | B | L | R -- room sides + +data ItemType = Weapon -- ']' + | Armor -- '[' + | Potion -- '!' + | Scroll -- '?' + | Corpse -- '%' + deriving (Eq, Show, Read) + +data ItemEffect = None + | Healing Int + | Death + | Teleport + | Yuck + deriving (Eq, Show, Read) + +-- TODO: use this +data EntityStats = EntityStats + { strength :: Int + , agility :: Int + , intelligence :: Int + , beauty :: Int + } deriving (Eq, Show, Read) + +data Item = Item + { iType :: ItemType + , iName :: String + , iSpeed :: Int + , iDamage :: Int + , iDefence :: Int + , iWeight :: Int -- mass in grams + , iEffect :: ItemEffect + } deriving (Eq, Show, Read) + +data Inventory = Inventory + { equWeapon :: Item + , equArmor :: Item + , equMisc :: Item + , storedItems :: [Item] + } deriving (Eq, Show, Read) + +data Entity = Entity + { pc :: Bool + , pos :: Vector2 + , sym :: Char + , name :: String + , hp :: (Int, Int) + , inv :: Inventory + , weight :: Int -- mass in grams + , speed :: Int + , nextMove :: Int + , seenL :: Array Vector2 Bool -- ^what the player has seen of the level + , seeingL :: Array Vector2 Bool -- ^what the player *currently* sees + } deriving (Eq, Show, Read) + +data GameState = GameState + { level :: Level + , entities :: [Entity] + , items :: [(Vector2, Item)] + , msgs :: [(Int, Bool, String)] -- ^ turn added, seen by player, message + , turn :: Int + , pquit :: Bool + , narr :: Neighbours + , dlvl :: Int + } deriving (Eq, Show, Read) + +-- | get the next actor and the rest +entityPQ :: [Entity] -> (Entity, [Entity]) +entityPQ en = + let (p:ren) = sortBy (comparing nextMove) en + in (p, ren) + +-- | get the player character and the rest +getPC :: [Entity] -> (Entity, [Entity]) +getPC en = + let l = sortBy (comparing pc) en + in (last l, init l) + +-- | check if the Entity is the player character +isPC :: Entity -> Bool +isPC = pc + +-- empty level +emptyL :: Level +emptyL = listArray ((1,1), (80, 22)) (repeat ' ') + +-- enemies don't use seenL/seeingL, so use this dummy array +nullA :: Array Vector2 Bool +nullA = listArray ((1,1), (2,2)) (repeat False) + +testWeapons :: [Item] +testWeapons = [Item Weapon "Sword of Test +1" 100 4 0 1500 None + ,Item Weapon "Shard of Glass" 150 2 0 300 None + ,Item Weapon "Staff of Skepticism" 50 10 0 4000 None + ] + +testArmors :: [Item] +testArmors = [Item Armor "Tested Leather Armor" 100 0 1 5000 None + ,Item Armor "Fancy Suit" 150 0 0 2000 None + ,Item Armor "Power Armor mk2" 66 0 6 30000 None + ] + +testMisc :: [Item] +testMisc = [Item Scroll "Scroll of Modern Medicine" 100 0 0 100 (Healing 6) + ,Item Potion "Potion of Alcohol" 100 0 0 700 (Healing (-1)) + ,Item Potion "Homeopathic Potion" 100 0 0 500 (Healing 0) + ,Item Scroll "Scroll of Death" 100 0 0 100 Death + ,Item Scroll "Book of Teleportation" 100 0 0 1000 Teleport + ,Item Corpse "Rodent Corpse" 100 0 0 1000 Yuck + ] + +testEnemies :: [Entity] +testEnemies = + [Entity False (0,0) 'L' "Lamar" (5,5) undefined 30000 50 0 nullA nullA + ,Entity False (0,0) 'A' "Giant Ant" (7,7) undefined 10000 99 0 nullA nullA + ,Entity False (0,0) 'm' "Mom" (8,8) undefined 60000 101 0 nullA nullA + ,Entity False (0,0) 'b' "Bear" (13,13) undefined 120000 120 0 nullA nullA + ,Entity False (0,0) 'd' "Dog" (3,3) undefined 8000 95 0 nullA nullA + ,Entity False (0,0) 'a' "Armadillo" (1,1) undefined 1000 85 0 nullA nullA + ] + +testBoss :: Entity +testBoss = + Entity False (0,0) 'G' "Dreadlord Gates" (32,32) + undefined 75000 135 0 nullA nullA + +testItems :: [Item] +testItems = testWeapons ++ testArmors ++ testMisc + +randInv :: IO Inventory +randInv = do + w <- randomElem testWeapons + a <- randomElem testArmors + m <- randomElem testMisc + return Inventory { equWeapon = w + , equArmor = a + , equMisc = m + , storedItems = [] } + +-- to save disk space, the neighbours array could be discarded here +-- and then rebuilt on load +save :: Game () +save = get >>= io . writeFile "savefile" . show + +load :: Game () +load = io (readFile "saveFile") >>= io . readIO >>= put + +mkPlayer :: Vector2 -> IO Entity +mkPlayer pos' = do + pinv <- randInv + return Entity + { pc = True + , name = "Player" + , pos = pos' + , sym = '@' + , hp = (20, 20) + , inv = pinv + , weight = 75000 + , speed = 100 + , nextMove = 0 + , seenL = listArray ((1,1), (80,22)) (repeat False) + , seeingL = listArray ((1,1), (80,22)) (repeat False) + } + +mkEnemiesOnLevel :: Int -- number of enemies + -> Int -- nextMove of enemies, set to the nextMove of the player + -- when descending the dungeon + -> Level + -> IO [Entity] +mkEnemiesOnLevel dl nm l = do + en <- randomRIO (1 * dl, 3 * dl) -- amount of enemies + es <- randFloors l en -- positions + ei <- replicateM en randInv -- inventories + em <- replicateM en (randomElem testEnemies) -- random enemies + ep <- randFloor l -- position of boss, maybe + bi <- randInv -- inventory of boss, maybe + return $ + -- add the boss on the fifth level + [testBoss { pos = ep, inv = bi, nextMove = nm } | dl == 5] ++ + -- add normal enemies + zipWith3 (\e p i -> e { pos = p, inv = i, nextMove = nm }) em es ei + +mkItemsOnLevel :: Level -> IO [(Vector2, Item)] +mkItemsOnLevel l = do + i <- randomRIO (3,9) + is <- replicateM i (randomElem testItems) + ip <- randFloors l i + return (zip ip is) + +-- | Creates a brand-new, fully filled Game. +mkDungeonLevel :: Game () +mkDungeonLevel = do + l <- io $ mkRandRooms (80, 22) -- dungeon, or level + p <- io $ randFloor l -- player position + ep <- io $ randFloor l -- exit position + is <- io $ mkItemsOnLevel l + p' <- io $ mkPlayer p -- player position + entities' <- io $ mkEnemiesOnLevel 1 0 l + put GameState + { entities = p' : entities' + , items = is + , level = l // [(ep, '>')] + , msgs = [(0, False, "Welcome to hoodie! (press ? for help)")] + , turn = 0 + , pquit = False + , narr = mkNeighbourArray l ".⋅+#SDk" + , dlvl = 1 + } + +-- | changes all the things that need the change between floors +descendLevel :: Game () +descendLevel = do + g <- get + let (p,_) = getPC (entities g) -- get player + l <- io $ mkRandRooms (80, 22) + pp <- io $ randFloor l -- new player position + ep <- io $ randFloor l -- exit position + is <- io $ mkItemsOnLevel l + let dlvl' = dlvl g + 1 + p' = p { pos = pp + , seenL = listArray ((1,1), (80,22)) (repeat False) + , seeingL = listArray ((1,1), (80,22)) (repeat False) + } + entities' <- io $ mkEnemiesOnLevel dlvl' (nextMove p + 1) l + put $ g + { entities = p' : entities' + -- level 5 is the last level + , level = if dlvl' == 5 then l else l // [(ep, '>')] + , narr = mkNeighbourArray l ".⋅+#SDk" + , items = is + , dlvl = dlvl' + } + +-- | make a random pair within given bounds +randomV2 :: (Vector2, Vector2) -> IO Vector2 +randomV2 ((x1, y1), (x2, y2)) = do + x <- randomRIO (x1, x2) + y <- randomRIO (y1, y2) + return (x,y) + +isFloor :: Level -> Vector2 -> Bool +isFloor l p = l ! p `elem` ".⋅" + +-- | find a random part of the level that's walkable +randFloor :: Level -> IO Vector2 +randFloor l = iterateUntil (isFloor l) (randomV2 (bounds l)) + +-- | find n non-repeating random positions that are walkable +randFloors :: Level -> Int -> IO [Vector2] +randFloors l n = + flip execStateT [] $ + replicateM_ n $ do + ps' <- get + xy <- iterateUntil (`notElem` ps') (liftIO $ randFloor l) + modify (xy:) + +-- | check if two rooms overlap +roomOverlap :: Room -> Room -> Bool +roomOverlap ((x1, y1), (sx1, sy1)) ((x2, y2), (sx2, sy2)) = + not (x1 > x2 + sx2 + 1 + ||y1 > y2 + sy2 + 1 + ||x2 > x1 + sx1 + 1 + ||y2 > y2 + sy1 + 1) + +-- | check if the given room overlaps any of the rooms in the list +roomOverlapAny :: Room -> [Room] -> Bool +roomOverlapAny r = any (roomOverlap r) + +-- | create a room without checking if it's within level bounds +createRoom :: Vector2 -> IO Room +createRoom (sx, sy) = do + -- all rooms need to be at least 2 tiles away from the level bounds + -- 1 tile to make room for any paths, and +1 tile because FOV crashes + -- if it tries to look at nothingness. + x <- randomRIO (3, sx - 3) + y <- randomRIO (3, sy - 3) + rx <- randomRIO (2, sx `div` 2) + ry <- randomRIO (2, sy `div` 2) + return ((x, y), (rx, ry)) + +-- | check if a room is within (x2, y2) bounds +goodRoom :: Vector2 -> Room -> Bool +goodRoom (sx, sy) ((x, y), (rx, ry)) = x + rx < sx - 3 && y + ry < sy - 3 + +-- | try really hard to make a servicable dungeon +mkRandRooms :: Vector2 -> IO Level +mkRandRooms lbounds = do + -- try 1000 times to create good non-overlapping rooms + rooms <- flip execStateT [] $ + replicateM_ 1000 $ do + rooms <- get + r <- iterateUntil (goodRoom lbounds) (liftIO (createRoom lbounds)) + unless (r `roomOverlapAny` rooms) (modify (r:)) + + when (null rooms) + (error "dungeon generator mkRandRooms didn't make any rooms") + + let room_lps = mkRooms rooms :: LevelPart + narrP = mkNeighbourArray (emptyL // room_lps) " " + + paths1 <- connectRandomRoomToAll narrP rooms + paths2 <- connectRandomRooms narrP rooms (length rooms `div` 2) + + return $ emptyL // (room_lps ++ paths1 ++ paths2) + +-- | connect a random room from the list to all rooms. Cheap way to +-- ensure that all rooms are connected. +connectRandomRoomToAll :: Neighbours -> [Room] -> IO LevelPart +connectRandomRoomToAll narrP rooms = do + rc <- randomElem rooms + concat `fmap` catMaybes `fmap` forM rooms (\r -> + if r /= rc + then connectRooms narrP r rc + else return Nothing) + +-- | make n random connections between rooms +connectRandomRooms :: Neighbours -> [Room] -> Int -> IO LevelPart +connectRandomRooms narrP rooms n = + concat `fmap` catMaybes `fmap` replicateM n + (do r1 <- randomElem rooms + r2 <- randomElem rooms + if r1 /= r2 then connectRooms narrP r1 r2 + else return Nothing) + +-- | connect two rooms, using corridors generated by A* pathfinding. +-- Randomly picks a side, so all rooms must have one tile free space +-- around them. +connectRooms :: Neighbours -> Room -> Room -> IO (Maybe LevelPart) +connectRooms narrP r1 r2 = do + side1 <- randomRIO (1, 4::Int) + side2 <- randomRIO (1, 4::Int) + let (f1, r1p') = + case side1 of + 1 -> (above, roomSideR r1 T) + 2 -> (below, roomSideR r1 B) + 3 -> (left, roomSideR r1 L) + 4 -> (right, roomSideR r1 R) + _ -> error "wait, what?" + (f2, r2p') = + case side2 of + 1 -> (above, roomSideR r2 T) + 2 -> (below, roomSideR r2 B) + 3 -> (left, roomSideR r2 L) + 4 -> (right, roomSideR r2 R) + _ -> error "you're drunk; go home" + r1p <- r1p' + r2p <- r2p' + return $ mkPath narrP r1p r2p f1 f2 + +-- | produce a random tile location from given side of the given room +roomSideR :: Room -> Side -> IO Vector2 +roomSideR ((x1, y1), (sx, sy)) s = + case s of + T -> randomRIO (x1+1, x1+sx-1) >>= \x -> return (x, y1) + B -> randomRIO (x1+1, x1+sx-1) >>= \x -> return (x, y1+sy) + R -> randomRIO (y1+1, y1+sy-1) >>= \y -> return (x1+sx, y) + L -> randomRIO (y1+1, y1+sy-1) >>= \y -> return (x1, y) + +-- utils for Data.Graph.AStar +-- | distance between two level points (taxi metric) +distance :: Vector2 -> Vector2 -> Int +distance (a1,a2) (b1, b2) = + (b1 - a1) + (b2 - a2) + +maybeLookup :: Level -> Vector2 -> Maybe Char +maybeLookup l p@(x,y) = + let ((x1, y1), (x2, y2)) = bounds l + in if x > x2 || x < x1 || y > y2 || y < y1 + then Just (l ! p) + else Nothing + +-- | create a array of the sets of neighbours for each tile +mkNeighbourArray :: Level -> String -> Neighbours +mkNeighbourArray l tt = + let (a@(x1,y1), b@(x2,y2)) = bounds l + in listArray (a, b) [setOfNeighbours l tt (x,y) | + x <- [x1..x2], + y <- [y1..y2]] + +-- | create a set of all neighbours of a point that are walkable +setOfNeighbours :: Level -> String -> Vector2 -> Set.Set Vector2 +setOfNeighbours l tt p = + Set.fromList + . map fst + . filter (\(p',_) -> l ! p' `elem` tt) + . filter (\(_,m) -> isNothing m) $ + [ (above p, l `maybeLookup` above p) + , (below p, l `maybeLookup` below p) + , (right p, l `maybeLookup` right p) + , (left p, l `maybeLookup` left p)] + +-- | aStar with defaults +simpleAStar :: Neighbours + -> Vector2 + -> Vector2 + -> Maybe [Vector2] +simpleAStar narrP start goal = + let adjdist _ _ = 1 + nset p = narrP ! p + dist = distance goal + in aStar nset adjdist dist (==goal) start + +-- | make a path between two rooms +mkPath :: Neighbours + -> Vector2 -- ^ from + -> Vector2 -- ^ to + -> (Vector2 -> Vector2) + -- pass above/below/right/left here, because if we're making + -- a path from a room, the first tile and last tiles are + -- impassable walls + -> (Vector2 -> Vector2) + -> Maybe LevelPart +mkPath narrP p1 p2 f1 f2 = do + p' <- simpleAStar narrP (f1 p1) (f2 p2) + return $ zip p' (repeat '#') ++ [(f1 p1, '#'), (p1,'+'), (p2,'+')] + +-- level construction +mkHwall :: Char -> Int -> Vector2 -> LevelPart +mkHwall ch len (x,y) = zip (zip [x..(x-1+len)] (repeat y)) (repeat ch) + +mkVwall :: Char -> Int -> Vector2 -> LevelPart +mkVwall ch len (x,y) = zip (zip (repeat x) [y..(y-1+len)]) (repeat ch) + +-- borders: +-- ┘ ┐ ┌ └ │ ─ ├ ┬ ┤ ┴ ┼ ╭ ╮ ╯ ╰ +-- ═ ║ ╒ ╓ ╔ ╕ ╖ ╗ ╘ ╙ ╚ ╛ ╜ ╝ ╞ ╟ +-- ╠ ╡ ╢ ╣ ╤ ╥ ╦ ╧ ╨ ╩ ╪ ╫ ╬ +mkRoom :: Room -> LevelPart +mkRoom ((x1, y1), (sx, sy)) = concat + -- floors + [[((x,y), '⋅') | y <- [y1..(y1+sy)], x <- [x1..(x1+sx)]] + -- walls + ,mkHwall '═' sx (x1, y1) + ,mkHwall '═' sx (x1, y1 + sy) + ,mkVwall '║' (sy+1) (x1, y1) + ,mkVwall '║' (sy+1) (x1 + sx, y1) + -- corners + ,[((x1, y1), '╔'), ((x1+sx, y1+sy), '╝') + ,((x1, y1+sy), '╚'), ((x1+sx, y1), '╗')]] + +mkRooms :: [Room] -> LevelPart +mkRooms = concatMap mkRoom + +walkableL :: Level -> Vector2 -> Bool +walkableL l p@(x,y) = + let ((x1,y1), (x2,y2)) = bounds l + in (x < x2 || x > x1 || y < y2 || y > y1) && (l ! p `elem` ".⋅+#SDk>") + +-- TODO: this needs to be fixed to account for messages over 75 chars +displayMessageLog :: Game () +displayMessageLog = do + g <- get + let ((x1,_), (x2,y2)) = bounds (level g) + curses $ draw $ do + clear (bounds (level g)) + drawStringAt (1,1) "Message log: ('p' to return)" + forM_ (zip [3..] (take (y2 - 5) (msgs g))) $ \(n,(t,_,m)) -> + drawStringAt (x1, n) $ take (x2 - 5) "[" ++ show t ++ "] " ++ m + _ <- curses $ waitForChrs "p" + curses $ draw (clear (bounds (level g))) + +helpString :: [String] +helpString = ["Hello, hoodie here (press ? again to return)" + ,"" + ,"Move with the Vi keys: hijkyubn" + ,"Attack by moving into enemies" + ,"Wait for a turn by pressing ." + ,"i to look at your inventory" + ,"a to apply your misc item" + ,", to pick up items below you" + ,"Descend to the next level with > when you are on stairs" + ,"Press p to display the message log," + ,"" + ,"q to quit, coward."] + +displayHelp :: Game () +displayHelp = do + g <- get + curses $ draw $ do + clear (bounds (level g)) + forM_ [1..length helpString] $ \y -> + drawStringAt (1, y) $ center 80 (helpString !! (y-1)) + _ <- curses $ waitForChrs "?" + curses $ draw (clear (bounds (level g))) + +displayPlayerInventory :: Game () +displayPlayerInventory = do + p <- (fst . getPC) `fmap` gets entities + addMessage $ "Inventory: W: " + ++ iName (equWeapon (inv p)) ++ + " A: " ++ iName (equArmor (inv p)) ++ + " M: " ++ iName (equMisc (inv p)) + +withReverse :: Update () -> Update () +withReverse upact = do + setAttribute AttributeReverse True + upact + setAttribute AttributeReverse False + +itemSym :: Item -> Char +itemSym i = case iType i of + Weapon -> ']' + Armor -> '[' + Potion -> '!' + Scroll -> '?' + Corpse -> '%' + +drawEverything :: Game () +drawEverything = do + g <- get + l <- gets level + let (p, en') = getPC (entities g) + seen = seenL p + seeing = seeingL p + + curses $ draw $ do + clear (bounds l) + -- draw level + forM_ (indices l) $ \i -> do + when (seen ! i) (drawStringAt i [l ! i]) + when (seeing ! i) (withReverse (drawStringAt i [l ! i])) + -- draw items + forM_ (items g) $ \(ip,i) -> + when (seeing ! ip) (drawStringAt ip [itemSym i]) + -- draw enemies + forM_ en' $ \e -> + when (seeing ! pos e) (drawStringAt (pos e) [sym e]) + -- draw player + withReverse $ drawStringAt (pos p) "@" + -- concat unseen messages and draw them + let dms = concat $ reverse $ map (\(_,_,m) -> m++" ") $ + takeWhile (\(_,b,_) -> not b) (msgs g) + unless (null dms) $ + withReverse $ drawStringAt (1,1) dms + -- draw a statusbar, displaying time, speed, dungeon level, and hp + withReverse $ drawStringAt (1, 24) $ + "Time: " ++ show (nextMove p) ++ " Speed: " ++ show (speed p) + ++ " DL: " ++ show (dlvl g) ++ " HP: " ++ show (fst (hp p)) + ++ "/" ++ show (snd (hp p)) + +above, below, right, left :: Vector2 -> Vector2 +above (x, y) = (x, y - 1) +below (x, y) = (x, y + 1) +right (x, y) = (x + 1, y) +left (x, y) = (x - 1, y) + +aboveleft, aboveright, belowleft, belowright :: Vector2 -> Vector2 +aboveleft (x, y) = (x - 1, y - 1) +aboveright (x, y) = (x + 1, y - 1) +belowleft (x, y) = (x - 1, y + 1) +belowright (x, y) = (x + 1, y + 1) + +-- | maps directional keys to movement functions +keyToDir :: Char -> Vector2 -> Vector2 +keyToDir c = + case c of + 'k' -> above + 'j' -> below + 'l' -> right + 'h' -> left + 'y' -> aboveleft + 'u' -> aboveright + 'b' -> belowleft + 'n' -> belowright + '.' -> id + _ -> error "movePlayer: controls misconfigured" + +-- | Move the player, fail to move the player, rest, or attack an entity +movePlayer :: Char -> Game () +movePlayer c = do + l <- gets level + en <- gets entities + is <- gets items + let (p,en') = getPC en + -- position player wants to move to + newp = keyToDir c (pos p) + + -- is there someone there? + case en' `getEntityAt` newp of + -- we're moving into an enemy + Just e -> attackEntity p e + -- or not + Nothing -> + if l `walkableL` newp + then do + let i = newp `lookup` is + when (isJust i) $ addMessage $ "You see here the "++iName (fromJust i) + p `moveEntityTo` newp + else addMessage "You bump into an obstacle!" + +modifyEntityAt :: [Entity] -> Vector2 -> (Entity -> Entity) -> [Entity] +modifyEntityAt es p f = + map (\e -> if e == fromJust (es `getEntityAt` p) then f e else e) es + +modifyEntityHp :: Int -> Entity -> Entity +modifyEntityHp n e = + let (hp', maxhp') = hp e + newhp = min maxhp' (hp' + n) + in e { hp = (newhp, maxhp') } + +removeEntityAt :: [Entity] -> Vector2 -> [Entity] +removeEntityAt es p = filter (\e -> pos e /= p) es + +getEntityAt :: [Entity] -> Vector2 -> Maybe Entity +getEntityAt es p = find (\e -> pos e == p) es + +anyEntityAt :: [Entity] -> Vector2 -> Bool +anyEntityAt es p = p `elem` map pos es + +addMessage :: String -> Game () +addMessage m = do + g <- get + put $ g { msgs = (turn g, False, m) : msgs g } + +descend :: Game () +descend = do + g <- get + if level g ! pos (fst (getPC (entities g))) == '>' + then do + curses $ draw $ clear (bounds (level g)) + descendLevel + addMessage "You descend into the next level!" + else addMessage "There are no stairs here!" + +-- | merge the old "seen" array with the new "seeing" array +-- to produce an updated "seen" array +updateSeen :: Array Vector2 Bool + -> Array Vector2 Bool + -> IO (Array Vector2 Bool) +updateSeen old_seen new_seeing = do + u_n_s <- thaw new_seeing :: IO (IOArray Vector2 Bool) + upds <- filter snd `fmap` getAssocs u_n_s + return $ old_seen // upds + +-- | update the "seen" and "seeing" arrays +updateVision' :: GameState -> IO GameState +updateVision' g = do + let l = level g + (p,en') = getPC (entities g) + pp = pos p + seen = seenL p + + (seeing',seen') <- do + s <- ioInit + newSeeing <- newArray (bounds l) False :: IO (IOUArray Vector2 Bool) + + let lightPoint x y = writeArray newSeeing (x, y) True + isOpaque x y = return (l ! (x, y) `elem` " ═║╔╝╚╗") + + -- use FOV's circle to write into the newSeeing array + circle s pp 5 lightPoint isOpaque + newSeeing' <- freeze newSeeing :: IO (Array Vector2 Bool) + newSeen' <- updateSeen seen newSeeing' + return (newSeeing', newSeen') + + let np = p { seenL = seen', seeingL = seeing' } + g' = g { entities = np:en' } + + return g' + +getGoodCh :: Game Char +getGoodCh = curses $ waitForChrs "?hjklyubnqsdpria.,>" + +setQuit :: Game () +setQuit = do + g <- get + put $ g { pquit = True } + +-- | Checks if the player is dead and quits if they are. +isPlayerDead :: Game () +isPlayerDead = do + en <- gets entities + let php = fst . hp .fst . getPC $ en + when (php <= 0) $ do + addMessage "Oh no! You are dead!" + setQuit + +-- | Turn or time is a measure of how long the player has been in the dungeon. +-- An entity with 100 speed and 100 speed armor takes 10 "time" to move one +-- square. Higher speed = less time taken. +setTurn :: Game () +setTurn = do + g <- get + let p = fst . getPC $ entities g + put $ g { turn = nextMove p } + +-- | This is the main update function, updating one entity per call. The +-- entity to be updated is the one with the lowest nextMove value. When the +-- entity perform a task (including nothing at all), the time cost of the task +-- is added to its nextMove. "turn" is used for the lack of a better word. +gameTurn :: Game () +gameTurn = do + processNegativeHpEntities + g <- get + let en@(e, _) = entityPQ (entities g) + if isPC e + then do + setTurn + drawEverything + ageMessages + c <- getGoodCh + case c of + 'q' -> setQuit + 'p' -> displayMessageLog + '?' -> displayHelp + ',' -> playerPickupItem + 'a' -> entityApplyItem e + 'i' -> displayPlayerInventory + 's' -> save + 'd' -> load + 'r' -> mkDungeonLevel >> updateVision + '>' -> descend >> updateVision + _ -> movePlayer c >> updateVision + else processEnemies en + isPlayerDead + +modifyEntity :: Entity -> (Entity -> Entity) -> Game () +modifyEntity e f = do + g <- get + en <- gets entities + put $ g { entities = map (\e' -> if e' == e then f e' else e') en } + +-- | The time needed to perform an action is: +-- +-- 1000 +-- -------------------------------------- +-- (speed of entity + speed of item used) +-- ---------------------------------- +-- 2 +-- +-- or equivalently: 2000 / (speed of entity + speed of item used) +-- +-- for moving around, the item speed used is that of the equipped armor +itemUseCost :: Entity -> Item -> Int +itemUseCost e i = 2000 `div` (speed e + iSpeed i) + +-- TODO: consume item or item charge on use +-- | Use your misc item to do something +entityApplyItem :: Entity -> Game () +entityApplyItem e = do + g <- get + let (p, _) = getPC (entities g) + pm = equMisc (inv e) + verb = case iType pm of + Potion -> "drink" + Scroll -> "read" + Corpse -> "squeeze" + _ -> "use" + useMsg = + if e == p + then "You " ++ verb ++ " the " ++ iName pm ++ "!" + -- don't bother using verbs for others :) + else name e ++ " uses the " ++ iName pm ++ "!" + case iEffect pm of + None -> + return () + Healing n -> do + addMessage useMsg + modifyEntity e ( modifyEntityHp n + . addEntityTime (itemUseCost e pm)) + Death -> do + -- always add useMsg + addMessage useMsg + -- only add these when the player uses items + when (e == p) $ addMessage "You feel stupid!" + modifyEntity e ( modifyEntityHp (-999)) + Teleport -> do + addMessage useMsg + newp <- io $ randFloor (level g) + modifyEntity e (modifyEntityPos newp) + addMessage "Woosh!" + updateVision + Yuck -> do + addMessage useMsg + when (e == p) $ addMessage "Yuck!" + +-- | Pick up an item, if there is one below the player. +playerPickupItem :: Game () +playerPickupItem = do + g <- get + -- items on the floor + let is = items g + -- player and friends + (p, en) = getPC (entities g) + -- current inventory + cinv = inv p + -- is there an item below us? + case pos p `lookup` is of + Nothing -> + addMessage "There's nothing here to pick up!" + Just i -> do + -- make a new inventory based on the type of the item + let newinv = case iType i of + Weapon -> cinv { equWeapon = i } + Armor -> cinv { equArmor = i } + _ -> cinv { equMisc = i } + -- item we're dropping from the player's inventory + dropped = case iType i of + Weapon -> equWeapon (inv p) + Armor -> equArmor (inv p) + _ -> equMisc (inv p) + -- commit new inventory, remove the item from the floor + -- and add the dropped item to the floor at the player's feet + put $ g { entities = p { inv = newinv } : en + , items = (pos p, dropped) : filter (/= (pos p, i)) is + } + -- picking stuff up takes time + modifyEntity p (addEntityTime (itemUseCost p i)) + -- add message + addMessage $ "You pick up the " ++ iName i ++ "!" + +-- | After one turn, set messages to viewed so they don't display any more +ageMessages :: Game () +ageMessages = do + g <- get + put $ g { msgs = map (\(t,_,m) -> (t, True, m)) (msgs g) } + +updateVision :: Game () +updateVision = get >>= io . updateVision' >>= put + +-- | Checks if the Entity current hp <= 0.3 of max +panicEntityAI :: Entity -> Bool +panicEntityAI e = + let (cHp, mHp) = hp e + hpRatio = fromIntegral cHp / fromIntegral mHp :: Double + in hpRatio <= 0.3 + +processEnemies :: (Entity, [Entity]) -> Game () +processEnemies (e, en) = do + let p = (fst . getPC) en + if panicEntityAI e + -- if the entity has low hp then use its misc item + then entityApplyItem e + else + -- if the enemy is next to the player, attack, otherwise + -- move closer to the player + if pos e `nextTo` pos p + then e `attackEntity` p + else moveEntityAI en e + +-- | subtract damage from defender, add time spent to the attacker, and +-- add messages +attackEntity :: Entity -- attacker + -> Entity -- defender + -> Game () +attackEntity atk def = do + let -- inventories of the attacker and defender + aw = equWeapon (inv atk) + da = equArmor (inv def) + -- damage done from attacker to defender is attacker's weapon attack + -- value minus defender's armor's defend value + dmg = max 0 (iDamage aw - iDefence da) + -- add messages + when (isPC def) $ addMessage $ "The " ++ name atk ++ " hits you!" + when (isPC atk) $ addMessage $ "You hit the " ++ name def ++ "!" + unless (isPC def || isPC atk) $ + addMessage $ "The " ++ name atk ++ "hits the " ++ name def ++ "!" + -- damage the defender + modifyEntity def (modifyEntityHp (-dmg)) + -- add attack cost to the attacker + modifyEntity atk (addEntityTime (itemUseCost atk aw)) + +-- | remove entities that have <= 0 current hitpoints and add messages about +-- their deaths +processNegativeHpEntities :: Game () +processNegativeHpEntities = do + g <- get + let died = filter (\e -> fst (hp e) <= 0) (entities g) + unless (null died) $ + -- death messages + do let dms = map (\e -> name e ++ " dies!") died + -- entities that are still alive + new = filter (`notElem` died) (entities g) + -- create corpses to drop at the positions where + -- the entities died + corpses = map (\e -> (pos e, entityToCorpse e)) died + -- add messages + mapM_ addMessage dms + g' <- get + put $ g' { entities = new, items = corpses ++ items g' } + +entityToCorpse :: Entity -> Item +entityToCorpse e = + Item { iType = Corpse + , iName = name e ++ " corpse" + , iSpeed = 100 + , iDamage = 0 + , iDefence = 0 + , iWeight = weight e + , iEffect = Yuck + } + +-- | cartesian distance function +cartDistance :: Vector2 -> Vector2 -> Double +cartDistance (x1, y1) (x2, y2) = + sqrt $ fromIntegral $ (x2-x1)^(2::Int) + (y2-y1)^(2::Int) + +-- | all the directions you could ever possibly want to move in to including none +directions :: [Vector2 -> Vector2] +directions = + [id, above, below, right, left + ,aboveright, aboveleft + ,belowright, belowleft] + +-- | calculate the distances between two points if you were to move the +-- *first* point in all possible directions +distances :: Vector2 -> Vector2 -> [Double] +distances a b = + map (\f -> cartDistance (f a) b) directions + +-- | Check if a is next to b +nextTo :: Vector2 -> Vector2 -> Bool +nextTo a b = any (\f -> a == f b) directions + +modifyEntityPos :: Vector2 -> Entity -> Entity +modifyEntityPos new e = e { pos = new } + +addEntityTime :: Int -> Entity -> Entity +addEntityTime n e = e { nextMove = nextMove e + n } + +moveEntityTo :: Entity -> Vector2 -> Game () +moveEntityTo e newp = + modifyEntity e ( modifyEntityPos newp + . addEntityTime (itemUseCost e (equArmor (inv e))) + ) + +-- | make a list of functions sorted by the distance that they would bring +-- the enemy to if it moved in that direction, then select the first good one +moveEntityAI :: [Entity] -- rest of the enemies + -> Entity -- the entity we're moving + -> Game () +moveEntityAI en' e = do + l <- gets level + en <- gets entities + -- player position + let pp = pos (fst (getPC en)) + -- entity position + ep = pos e + -- sort the movement functions by the distance that they would + -- bring the enemy to if it moved into that direction + sorted_funs = map snd $ sortBy (comparing fst) + (zip (distances ep pp) directions) + -- is this tile a good move? + goodmove ne = (l `walkableL` ne -- is the tile traversable? + -- is there an enemy on it? + && not (en' `anyEntityAt` ne)) + -- we can also just stand still + && ne /= pp + -- get the first function that's a good move. Since they're sorted + -- by ascending distance, it's the optimal move. There is always + -- at least one element of this list - id. + bestfunc = head $ dropWhile (\f -> not (goodmove (f ep))) sorted_funs + + -- enemies have a detection radius of 10, if the player is outside + -- it then just stand still + e `moveEntityTo` (if cartDistance ep pp < 10 then bestfunc ep else ep) + +quitCond :: Game Bool +quitCond = liftM pquit get + +runGame :: Game Bool -- ^ end condition + -> Game () -- ^ update function + -> IO GameState -- ^ end state +runGame predf logicf = do + let loop' = do + doquit <- predf + if doquit + then get + else logicf >> loop' + runCurses $ do + setEcho False + _ <- setCursorMode CursorInvisible + runGame1 undefined $ do + mkDungeonLevel + updateVision + loop' + +main :: IO () +main = do + g <- runGame quitCond gameTurn + mapM_ print (reverse (msgs g)) + +-- FOV init +ioInit :: IO Settings +ioInit = do + settings <- newSettings + setShape settings Circle + setOpaqueApply settings True + return settings + +-- ncurses stuff +draw :: Update () -> Curses () +draw ioact = do + w <- defaultWindow + updateWindow w ioact + render + +clear :: (Vector2, Vector2) -> Update () +clear ((x1, y1), (x2, y2)) = + let cs = replicate (x2-x1) ' ' + in forM_ [y1..y2+2] $ \y -> + drawStringAt (x1, y) cs + +waitForChrs :: String -> Curses Char +waitForChrs cs = loop' where + loop' = do + w <- defaultWindow + ev <- getEvent w Nothing + case ev of + Nothing -> loop' + Just (EventCharacter c) -> if c `elem` cs then return c else loop' + _ -> loop' + +drawStringAt :: Vector2 -> String -> Update () +drawStringAt (x, y) s = do + moveCursor' (y - 1, x - 1) + drawString s + +screenSize' :: Curses Vector2 +screenSize' = screenSize >>= \(y, x) -> + return (fromIntegral y, fromIntegral x) + +moveCursor' :: Vector2 -> Update () +moveCursor' (y, x) = moveCursor (fromIntegral y) (fromIntegral x) + +-- misc stuff +swap :: (a, b) -> (b, a) +swap (a, b) = (b, a) + +replaceElem :: [a] -> a -> Int -> [a] +replaceElem es e n = take n es ++ e : drop (n + 1) es + +randomElem :: [a] -> IO a +randomElem xs = (xs !!) `fmap` randomRIO (0, length xs - 1) + +center :: Int -> String -> String +center n xs = + let padding = replicate ((n - length xs) `div` 2) ' ' + in padding ++ xs ++ padding diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/hoodie.cabal b/hoodie.cabal new file mode 100644 --- /dev/null +++ b/hoodie.cabal @@ -0,0 +1,33 @@ +-- Initial hoodie.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +name: hoodie +version: 0.1.0.0 +synopsis: A small, toy roguelike +description: A small roguelike; perhaps 10% of a real one. In development +license: GPL-3 +license-file: LICENSE +author: Denis Volk +maintainer: denis.volk@gmail.com +-- copyright: +category: Game +build-type: Simple +cabal-version: >=1.8 + +source-repository head + type: git + location: https://github.com/dvolk/hoodie + +executable hoodie + main-is: Main.hs + -- other-modules: + build-depends: base ==4.6.* + , mtl ==2.1.* + , array ==0.4.* + , containers ==0.5.* + , random ==1.0.* + , monad-loops ==0.4.* + , astar ==0.2.* + , ncurses ==0.2.* + , hfov ==1.0.* + GHC-Options: -Wall