| Name | animalwellsave JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | Animal Well CLI Savegame Editor/Library |
| upload_time | 2024-07-04 20:54:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> 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. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> 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 <https://www.gnu.org/licenses/>. 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: <program> Copyright (C) <year> <name of author> 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 <https://www.gnu.org/licenses/>. 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 <https://www.gnu.org/licenses/why-not-lgpl.html>. |
| keywords |
animalwell
animal well
save editor
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Python-Based CLI Animal Well Savegame Editor
============================================
`animalwellsave` is a save editor (and data backend) for editing
[Animal Well](https://store.steampowered.com/app/813230/ANIMAL_WELL/) savegames.
It supports editing nearly everything stored in the savegames. In addition
to the editing features you'd expect, it's got some features you might not
expect, including:
- Importing/Exporting specific slots
- Setting the Bunny Mural to its default, solved, or cleared state, and
importing/exporting the mural in raw or image formats
- Image import/export of the "pencil" map layer
- Forcing Kangaroo spawns to a specific room
- Respawning consumables (fruit, firecrackers) on the map
- Clearing ghosts / Lighting Candles
- Clearing out "illegal" pink-button presses and bunnny collection (acquired
via cheating or glitching) to avoid future savefile corruption or BDTP
puzzle problems
- And much more! Read on for the full details
Table of Contents
-----------------
- [Overview](#overview)
- [Running / Installation](#running--installation)
- [Easiest Method: pip](#easiest-method-pip)
- [Git Checkout (the proper way)](#git-checkout-the-proper-way)
- [Git Checkout (the lazy way)](#git-checkout-the-lazy-way)
- [Release Archives (not recommended)](#release-archives-not-recommended)
- [TODO](#todo)
- [Usage](#usage)
- [Showing Save Info](#showing-save-info)
- [Checksum](#checksum)
- [Choose Slot](#choose-slot)
- [Import/Export Slots](#importexport-slots)
- [Frame Seed](#frame-seed)
- [Global Unlocks (Figurines, etc)](#global-unlocks-figurines-etc)
- [Health](#health)
- [Spawnpoint](#spawnpoint)
- [Steps](#steps)
- [Deaths](#deaths)
- [Bubbles Popped](#bubbles-popped)
- [Berries Eaten While Full](#berries-eaten-while-full)
- [Game Ticks (Elapsed Time)](#game-ticks-elapsed-time)
- [Wings (Flight)](#wings-flight)
- [Firecrackers](#firecrackers)
- [Keys / Matches](#keys--matches)
- [Nuts](#nuts)
- [Equipment](#equipment)
- [Inventory](#inventory)
- [Map Unlocks](#map-unlocks)
- [B.B. Wand](#bb-wand)
- [Egg 65](#egg-65)
- [Cheater's Ring](#cheaters-ring)
- [Progress/Quests](#progressquests)
- [Mock Disc Location](#mock-disc-location)
- [Caged Cats](#caged-cats)
- [Kangaroo Room](#kangaroo-room)
- [K. Shards](#k-shards)
- [S. Medal and E. Medal](#s-medal-and-e-medal)
- [Animal Head Teleporters](#animal-head-teleporters)
- [Bunny Mural](#bunny-mural)
- [Mural Import/Export](#mural-importexport)
- [Flames](#flames)
- [Manticores](#manticores)
- [Teleportation Torus](#teleportation-torus)
- [Bosses](#bosses)
- [Eggs](#eggs)
- [Bunnies](#bunnies)
- [Illegal Bunnies](#illegal-bunnies)
- [Respawn Consumables](#respawn-consumables)
- [Ghosts](#ghosts)
- [Squirrels](#squirrels)
- [Buttons](#buttons)
- [Doors / Walls](#doors--walls)
- [Chests](#chests)
- [Candles](#candles)
- [Crank Puzzles](#crank-puzzles)
- [Water Reservoirs](#water-reservoirs)
- [Detonators](#detonators)
- [Destroyed Tiles](#destroyed-tiles)
- [Big Stalactites](#big-stalactites)
- [Stalactites / Stalagmites / Icicles](#stalactites--stalagmites--icicles)
- [Minimap](#minimap)
- [Map Marks](#map-marks)
- [Pencil Images](#pencil-images)
- [Library](#library)
- [Changelog](#changelog)
- [License](#license)
Overview
--------
Make sure to backup your saves before using this! I've yet to encounter any
savefile corruption, but it's always possible you could run into a weird
edge case.
Work on decoding the savegame structure has mostly been done by
[Kein](https://github.com/Kein/), [just-ero](https://github.com/just-ero),
lipsum, polinet68, avengah, and myself. My own contributions were mostly
at the beginning of the process; Kein, just-ero, and lipsum have been
responsible for the majority of the save format at this point. Many thanks
to them for filling things out!
A complete mapping of the savegame data can be found at
[Kein's awsgtools repo](https://github.com/Kein/awsgtools). At time of
writing the primary format there is an
[010 Editor](https://www.sweetscape.com/010editor/) binary template
plus an [ImHex](https://imhex.werwolv.net/) pattern. Other translations
may become available over time. A human-readable document describing the
save format can be found [at the wiki of that repo](https://github.com/Kein/awsgtools/wiki)
as well, though that document might lag behind the official templates.
Running / Installation
----------------------
This is a Python-based CLI app and library. It should run on Python 3.10+,
though it's received most of its testing on Python 3.12. There is currently
no GUI component -- you'll have to be comfortable working in the commandline
for this to work.
### Easiest Method: pip
At the basic level, once Python is installed, you can install `animalwellsave`
with a simple:
pip install animalwellsave
To also pull in the dependencies necessary to support importing/exporting
images into the "pencil" minimap layer and bunny mural, you can alternately
specify this for the installation line:
pip install animalwellsave[Images]
You could also install it for just your user with:
pip install --user animalwellsave[Images]
Once installed, there will be an `awsave` command available to run, like so:
awsave --help
Rather than doing a "global" installation as mentioned above, it's recommended
to install in a [virtual environment](https://docs.python.org/3/library/venv.html),
though. (This is true of Python apps in general.) On Unix/Mac:
cd /wherever/you/want/to/keep/the/virtualenv
python -m venv virtualenv_dir
source virtualenv_dir/bin/activate
pip install animalwellsave[Images]
Or on Windows:
cd \wherever\you\want\to\keep\the\virtualenv
python -m venv virtualenv_dir
virtualenv_dir\Scripts\activate
pip install animalwellsave[Images]
### Git Checkout (the proper way)
The app can also be run right from a git checkout. The "correct" way to
do this is with a virtual environment using
["editable" mode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html).
From the main project checkout dir (example here is for Unix/MacOS; the
activation line is different for Windows -- see above):
python -m venv .venv
source .venv/bin/activate
pip install --editable .
Optionally, to install the dependencies needed for importing/exporting images
to the "pencil" minimap layer and bunny mural, you can run:
pip install -r image-requirements.txt
Once done, you should be able to run the `awsave` command as usual:
awsave --help
### Git Checkout (the lazy way)
Alternatively, if you want to run it directly from a git checkout *without*
setting up a virtual environment and setting it to editable mode, you can
just use the shortcut `awsave.py` script right in the main dir:
./awsave.py --help
Or, you can call the cli module directly:
python -m animalwellsave.cli --help
### Release Archives (not recommended)
Bundled with official releases on the
[Github Releases Page](https://github.com/apocalyptech/animalwellsave/releases)
are Python-produced "source distribution" and "built distribution" (wheel)
files (these are also available via
[animalwellsave's pypi area](https://pypi.org/project/animalwellsave/#files)).
Neither of these are meant to be complete archives of the github repo, and will
be missing content like the "convenience" `awsave.py` script that's in the gitub
repo root. These files *can* be installed via pip, though, using the various
methods described above:
pip install animalwellsave-1.1.0.tar.gz
pip install animalwellsave-1.1.0-py3-none-any.whl
In general there's probably not much reason to manually download/install these
files; if you don't want to use `pip` to install the app, just checking out
the git repo is probably the better method. Still, if you wanted to install via
pip but not use its automatic project download features, you're welcome to
install via that method if you want. After install, the `awsave` command should
be available for use.
TODO
----
The editor currently does not attempt to support *everything* inside the
savegames. Some notable bits of data which can't be edited directly (but
which are present in the data library):
- General Crank status
- Elevator status
Some data is, likewise, not actually even present in the data library
yet:
- Some seemingly-unimportant flags have been omitted from a few areas,
for instance the global "switch" state (left/right), early-game flags
like "woke up," etc.
- Achievements *(unsure if setting these in the save would actually make
them activate on Steam)*
- Game Options
While I don't have any current plans to support the above, there are a
few other things which would be nice eventually:
- Mapping chests to their unlocks, so unlocking eggs (for instance) would
mark the relevant chests as opened. Vice-versa for disabling unlocks;
it'd be nice to close the associated chest so it could be re-acquired.
At the moment, chest opening/closing is all-or-nothing.
- Similarly, mapping buttons/reservoirs to which doors they open would be
nice, to be able to couple those a bit more closely. At the moment,
button/door states are all-or-nothing.
- Ability to perform slot actions on an exported slot file?
- Once [Kaitai Struct](https://kaitai.io/)'s
[serialization features](https://doc.kaitai.io/serialization.html)
make it into an official release, it'd be nice to convert over to that.
Something like that is really what I'd wanted to do at the start, rather
than my own janky weirdness.
- Clean up CLI options to be more consistent with pluralizations, noun-verb
ordering, abbreviations, etc. Even I often screw up the CLI options
occasionally and need to look at the `--help` output. I'll probably wait
for a Kaitai Struct rewrite to do so, though (which would likely be a 2.0
release)
Usage
-----
Here is a detailed list of all the arguments available on the CLI editor.
Note that these arguments can be chained together pretty much as long as
you want. For instance:
awsave AnimalWell.sav -i -s 0 --equip-enable all --inventory-enable pack --firecrackers 6 --upgrade-wand
### Showing Save Info
To show information about the save, including for any chosen slots, use
`-i`/`--info`:
awsave AnimalWell.sav -i
awsave AnimalWell.sav --info
The base info output will only show the "global" information which applies to
all slots. To show information on a specific slot, use the `-s`/`--slot`
argument (described in more detail below):
awsave AnimalWell.sav -i -s 1
awsave AnimalWell.sav --info --slot 1
By default, the info output will just show you things that you *have* collected
or done throughout the game. To also show information about things you *haven't*
collected or done (such as missing eggs, etc), use `-v`/`--verbose`:
awsave AnimalWell.sav -i -s 1 -v
awsave AnimalWell.sav --info --slot 1 --verbose
Additionally, the in-save data offsets for every bit of data that the data
library knows about can be printed with `-d`/`--debug`. This will show the
info for all slots as well, regardless of which slots have been chosen to show.
It will write this information to stderr:
awsave AnimalWell.sav -d
awsave AnimalWell.sav --debug
Finally, by default the info dump will use column outputs when showing long lists,
such as unlocked eggs. To have the utility only output one item per line, use
the `-1`/`--single-column` argument:
awsave AnimalWell.sav -i -s 1 -1
awsave AnimalWell.sav --info --slot 1 --single-column
### Checksum
The `--fix-checksum` option can be used to fix the savegame's checksum without
changing anything else. (The utility will automatically update the checksum if
any other changes are made to the file.) If the save has an invalid checksum,
Animal Well will spawn a Manticore friend to follow you around, so this can be
used to fix it in case any manual hex editing has been going on.
awsave AnimalWell.sav --fix-checksum
If you wanted to *intentionally* force an invalid checksum, because you'd like
a Manticore friend to go exploring with, you can use the `--invalid-checksum`
argument. If that's the *only* save-edit you want to do, you'll have to specify
the `--fix-checksum` argument as well:
awsave AnimalWell.sav --fix-checksum --invalid-checksum
### Choose Slot
Most options in the editor operate on slot data, so this argument is generally
necessary. `-s` or `--slot` can be used for this, to choose
a specific slot (`1`, `2`, or `3`), or to operate on *all* slots by
choosing `0`.
awsave AnimalWell.sav -i -s 1
awsave AnimalWell.sav --info --slot 2
Note that a few arguments (namely the various import/export arguments for slot
data, pencil minimap images, and bunny murals) do not allow using `0` to
specify "all slots."
### Import/Export Slots
Slot data can be imported or exported to allow transferring slots without
also transferring "global" data (like collected figurines, or game options).
For example, to export slot 2 into the file `slot2.dat` with the
`--export`/`--export-slot` option:
awsave AnimalWell.sav -s 2 --export slot2.dat
Then that file could be imported into another slot with the `--import`/`--import-slot`
option:
awsave AnimalWell.sav -s 3 --import slot2.dat
Note that the only data checking the import process does is to ensure that
the file being imported is exactly the right filesize (149,760 bytes).
If the filename you attempt to export to already exists, this app will
prompt you if you want to overwrite. To force overwriting without any
interactive prompt, use the `-f`/`--force` option:
awsave AnimalWell.sav -s 2 --export slot2.dat -f
### Frame Seed
The "frame seed" is presumably used for various randomizations in the
game, but the most noticeable effect is to determine which Bunny Mural
segment is presented to the user. The mural segment shown is the frame
seed modulo 50, so you could theoretically get all of the segments
yourself by editing this value 50 times. `--frame-seed` can be used
to alter the value:
awsave AnimalWell.sav --frame-seed 42
### Global Unlocks (Figurines, etc)
Some items unlocked in the game apply to all slots, such as the stopwatch,
pedometer, pink phones, and the various figurines which show up in the House.
The `--globals-enable` and `--globals-disable` arguments can be used to
toggle the various states. The special value `all` can be used to toggle
all of them at once, and the argument can be specified multiple times.
awsave AnimalWell.sav --globals-disable stopwatch --globals-disable pedometer
awsave AnimalWell.sav --globals-enable all
Valid values are: `stopwatch`, `pedometer`, `pink_phone`, `souvenir_cup`,
`origami`, `two_rabbits`, `owl`, `cat`, `fish`, `donkey`, `deco_rabbit`,
`mama_cha`, `giraffe`, `incense`, `peacock`, `otter`, `duck`, `all`.
### Health
Player health can be set with the `--health` option. Note that this is the
total number of hearts, which includes your base health, any gold hearts,
and any "extra" blue hearts. The game's maximum is probably 12, though I
haven't actually tested beyond that.
awsave AnimalWell.sav -s 1 --health 8
Relatedly, gold hearts can be added with the `--gold-hearts` option:
awsave AnimalWell.sav -s 1 --health 12 --gold-hearts 4
### Spawnpoint
The player's spawnpoint is stored in the game by room coordinates, and can
be set with the `--spawn` argument. The upper-left room is at coordinate
2,4. If there is a phone in the room that has been specified, the player
will spawn near the phone. Otherwise, the player spawns in the upper-left-most
available spot in the room.
awsave AnimalWell.sav -s 1 --spawn 11,11
### Steps
You can set the number of steps the player has walked with the `--steps`
argument:
awsave AnimalWell.sav -s 1 --steps 42
The ingame pedometer rolls over to 0 after hitting 99,999.
### Deaths
You can set the number of recorded deaths using the `--deaths` option:
awsave AnimalWell.sav -s 1 --deaths 0
### Saves
You can set the number of saves that the player has performed using the
`--saves` option. Note that the minimum legal value here is 1, since
the slot data will not be populated on-disk until the first savegame.
awsave AnimalWell.sav -s 1 --saves 1
### Bubbles Popped
The number of your B.Wand bubbles which have been popped by hummingbirds
can be altered with the `--bubbles-popped` argument:
awsave AnimalWell.sav -s 1 --bubbles-popped 42
### Berries Eaten While Full
The number of berries you've eaten while at full health can be altered
with the `--berries-eaten-while-full` argument:
awsave AnimalWell.sav -s 1 --berries-eaten-while-full 10
### Game Ticks (Elapsed Time)
The game keeps track of how many "ticks" have elapsed since the beginning
of the game. The game runs at 60fps, so this value is *not* actually in
milliseconds. There are technically two fields for this: one value which
is *just* ingame time (which does not seem to be used anywhere), and
another which includes all the time spent in "pause" menus. There are
two arguments related to ticks. First, `--ticks-copy-ingame` can be
used to copy your "ingame" counter over to the "including paused" counter,
in case you feel that your speedrun effort is being unfairly held back by
pausing:
awsave AnimalWell.sav -s 1 --ticks-copy-ingame
Alternatively, you can just set the numeric value for both at the same
time using `--ticks`:
awsave AnimalWell.sav -s 1 --ticks 0
### Wings (Flight)
A very late-game unlock gives you the ability to sprout wings and fly
around very quickly, by double-jumping. This can be enabled or disabled
using `--wings-enable` and `--wings-disable`:
awsave AnimalWell.sav -s 1 --wings-enable
awsave AnimalWell.sav -s 1 --wings-disable
### Firecrackers
Your player firecracker count can be set with the `--firecrackers` argument.
Setting this to a value greater than zero will also unlock the Firecracker
equipment, if it's not already unlocked.
awsave AnimalWell.sav -s 1 --firecrackers 3
### Keys / Matches
Keys and Matches can be set using the `--keys` and `--matches` arguments.
Note that the keys here are the "generic" ones which show up on the left in your
inventory. The maximum numbers available in the vanilla game are 6 keys, and
9 matches.
awsave AnimalWell.sav -s 1 --keys 6 --matches 9
### Nuts
The number of nuts that you've stolen from squirrels cna be set with the `--nuts`
argument. Note that the game doesn't actually report this count to the user in
any way.
awsave AnimalWell.sav -s 1 --nuts 4
### Equipment
Equipment is the various items you directly use throughout the game, like
Firecrackers, B. Wand, Disc, etc. These can be individually toggled on or off
using the `--equip-enable` and `--equip-disable` arguments. Those can be specified
more than once, and you can also use `all` as a special option to process all at
once.
awsave AnimalWell.sav -s 1 --equip-enable all
awsave AnimalWell.sav -s 1 --equip-disable disc --equip-disable yoyo
Valid values are: `firecracker`, `flute`, `lantern`, `top`, `disc`, `wand`,
`yoyo`, `slink`, `remote`, `ball`, `wheel`, `uvlight`, `all`.
Note that whenever you toggle the Disc state using this option, this utility will
by default attempt to set the game's quest states appropriately, to avoid having
you get chased by a ghost dog. This can end up changing where the Mock Disc is
in the gameworld. When giving yourself the Disc, there are two valid game states:
one with the Mock Disc in the initial dog head statue, and the other with the
Mock Disc in the M. Disc Shrine. By default, the quest-correction will set the
game to the dog-head-statue state, but you can have it put the Mock Disc in the
shrine instead with `--prefer-disc-shrine-state`:
awsave AnimalWell.sav -s 1 --equip-enable disc --prefer-disc-shrine-state
Alternatively, you can disable the auto-fix attempt entirely using the
`--dont-fix-disc-state` argument, in case you want to have a doggo friend to
keep you company (or if you're editing the quest states yourself later):
awsave AnimalWell.sav -s 1 --equip-enable disc --dont-fix-disc-state
### Inventory
Inventory refers to other items which you acquire throughout the game which are
*not* usable equipment items. These can be individually toggled on or off
using the `--inventory-enable` and `--inventory-disable` arguments. These can
be specified more than once, and you can also use `all` as a special option to
process all at once.
awsave AnimalWell.sav -s 1 --inventory-enable all
awsave AnimalWell.sav -s 1 --inventory-disable house_key --inventory-disable office_key
Valid values are: `mock_disc`, `s_medal`, `house_key`, `office_key`, `e_medal`,
`pack`, `all`.
Note that if you add the Mock Disc using this option, this utility will by default
attempt to set the game's quest state appropriately as if you'd picked up the Mock Disc
ingame. You can disable this behavior with the `--dont-fix-disc-state` argument:
awsave AnimalWell.sav -s 1 --inventory-enable mock_disc --dont-fix-disc-state
Relatedly, if you add all equipment *and* all inventory using the following options:
awsave AnimalWell.sav -s 1 --equip-enable all --inventory-enable all
... the utility will by default exclude the Mock Disc from the inventory unlocks, since
that's not actually a valid gamestate. As with the other Disc / Mock Disc options, you
can force both in your inventory at the same time by specifying `--dont-fix-disc-state`.
### Map Unlocks
The various map-feature unlocks can be enabled using the `--map-enable` argument.
The special value `all` can be used to unlock all three at once:
awsave AnimalWell.sav -s 1 --map-enable all
Valid values are: `unlock_map`, `unlock_stamps`, `unlock_pencil`, `all`.
### B.B. Wand
The B. Wand can be upgraded to the B.B. Wand (or downgraded back) using
`--upgrade-wand` and `--downgrade-wand`:
awsave AnimalWell.sav -s 1 --upgrade-wand
awsave AnimalWell.sav -s 1 --downgrade-wand
### Egg 65
Egg 65 can be enabled or disabled in your inventory using `--egg65-enable` and
`--eg65-disable`:
awsave AnimalWell.sav -s 1 --egg65-enable
awsave AnimalWell.sav -s 1 --egg65-disable
### Cheater's Ring
The Cheater's Ring can be enabled or disabled in your inventory using
`--cring-enable` and `--cring-disable`:
awsave AnimalWell.sav -s 1 --cring-enable
awsave AnimalWell.sav -s 1 --cring-disable
### Progress/Quests
There are two fields in the savegame which relate to progress / quests.
I honestly wasn't sure what to call the first one -- it includes some very
early-game flags like "game started" and "ready to hatch," but then also
includes a very late-game flag when the House Key drops after defeating the
first Manticore. The field is totally separate from the main "quest" area.
So, I settled on "progress." Apart from the House Key drop, the only other flag
the editor supports is the one that enables your HP Bar to be shown on the
screen. The arguments to edit this field are `--progress-enable` and
`--progress-disable`. The special value `all` can be used to process all
(well, both) at once:
awsave AnimalWell.sav -s 1 --progress-enable all
awsave AnimalWell.sav -s 1 --progress-disable hp_bar
Valid values are: `hp_bar`, `house_key`, `all`.
The *main* field which defines progress/quest information is rather more
complete, but note that it's not really recommended to alter this structure
directly. Some of the states in here rely on other states and other bit of data
to be a "valid" gamestate (or at least, one which could be encountered in an
unmodified game). Specific arguments exist for managing all quest state flags
supported by the editor, and should take care of any weird edge cases for you.
Still, if you want to tweak any of these by hand, they're available here. Manual
tweaking will be performed at the very *end* of the slot processing, so you can
use this argument to override any other massaging that previous processing might
have done.
The main quest state bitfield can be altered with `--quest-state-enable` and
`--quest-state-disable`. As with other options of this sort, it can be specified
more than once, and the special value `all` can be used to operate on them all at
once.
awsave AnimalWell.sav -s 1 --quest-enable house_open --quest-enable office-open
awsave AnimalWell.sav -s 1 --quest-disable all
Valid values are: `house_open`, `office_open`, `closet_open`, `unlock_map`,
`unlock_stamps`, `unlock_pencil`, `defeated_chameleon`, `cring`,
`used_s_medal`, `used_e_medal`, `wings`, `bb_wand`, `egg_65`, `torus`,
`defeated_bat`, `freed_ostrich`, `defeated_ostrich`, `fighting_eel`,
`defeated_eel`, `shrine_no_disc`, `statue_no_disc`, `all`.
### Mock Disc Location
In ordinary gameplay, the Mock Disc can either live in the Dog Head Statue, or the
Mock Disc Shrine. The `--move-disc-to-shrine` and `--move-disc-to-statue`
arguments can be used to move the Mock Disc from one to the other:
awsave AnimalWell.sav -s 1 --move-disc-to-shrine
awsave AnimalWell.sav -s 1 --move-disc-to-statue
Note that these arguments will only make changes if the Mock Disc is already stored
in one of those two locations. If you've got a nonstandard game state (due to
earlier editing, etc), you'll have to alter the various flags by hand using the
`--quest-state-enable` and `--quest-state-disable` arguments. Also note that these
arguments aren't really intended to be used alongside arguments which add or remove
the Disc or Mock Disc from player equipment/inventory -- the arguments for giving
the player the Disc, specifically, can ensure either of these two states. See
the [Equipment section](#equipment) for more detail.
### Caged Cats
The caged-cat/mother-lynx puzzle state can be set with the `--cats-free` and
`--cats-cage` arguments. This can be specified more than once, or you can use
the special `all` value to operate on all at the same time:
awsave AnimalWell.sav -s 1 --cats-free all
awsave AnimalWell.sav -s 1 --cats-cage cat_14_19_1 --cats-cage cat_14_19_2
Valid values are: `cat_16_18_1`, `cat_16_18_2`, `cat_16_18_3`, `cat_14_19_1`,
`cat_14_19_2`, `wheel`, `all`. Note that the `wheel` entry controls whether
or not the wheel-chest cage is open, in the Mother Lynx's lair. The names of
the cat cage values correspond with the room coordinates in which they're found.
### Kangaroo Room
The room in which the kangaroo next spawns can be set with the `--kangaroo-room`
argumnent. The rooms are numbered from 0 to 4, and correspond to the following
coordinates:
0. (6, 6)
1. (9, 11)
2. (12, 11)
3. (9, 13)
4. (16, 16)
The coordinates are set by the numeric index:
awsave AnimalWell.sav -s 1 --kangaroo-room 0
The kangaroo might not be immediately present when you first enter the room, but
it will be triggered into its attacking mode (often from offscreen) once you move
around to the appropriate trigger area. Once in its attacking mode, you can only
move one room away from the kangaroo before it despawns and moves on to a
different room.
### K. Shards
The state of K. Shard collection can be set with the `--kshard-collect` and
`--kshard-insert` arguments. Only one can be specified at a time, and they
set up the data to force a specific count of shards collected (ie: in your
inventory) or inserted (placed in the circular recess). This will overwrite
any existing state; if you've collected two shards already and specify that
you want 1 inserted, you will be left with a single inserted shard and none
in your inventory.
awsave AnimalWell.sav -s 1 --kshard-collect 2
awsave AnimalWell.sav -s 1 --kshard-insert 3
### S. Medal and E. Medal
The state of the S. Medal and E. Medal insertion can be set with the
`--s-medal-insert`, `--s-medal-remove`, `--e-medal-insert`, and
`--e-medal-remove` arguments. Note that removing the medal from the
recess does not automatically give you the medal in your inventory; use
the inventory management functions for that.
awsave AnimalWell.save -s 1 --s-medal-insert --e-medal-insert
awsave AnimalWell.save -s 1 --s-medal-remove --e-medal-remove
### Animal Head Teleporters
You can enable/disable the animal head teleporters using the `--teleport-enable`
and `--teleport-disable` arguments. The arguments can be specified more than
once, and you can use the special `all` value to operate on all at once.
awsave AnimalWell.sav -s 1 --teleport-enable bird --teleport-enable bear
awsave AnimalWell.sav -s 1 --teleport-disable all
Valid values are: `frog`, `fish`, `bear`, `dog`, `bird`, `squirrel`, `hippo`,
`all`.
### Bunny Mural
The Bunny Mural state can be set via a few options, though they are all just
hardcoded images. You can set the mural to its default state, to be entirely
"blank" (ie: just the "background" color), or to its solved state. Note that
the reward wall will *not* open in the solved state unless you head to the
control panel and set one pixel. (Though the wall can be opened with other
options in the editor.)
awsave AnimalWell.sav -s 1 --mural-default
awsave AnimalWell.sav -s 1 --mural-clear
awsave AnimalWell.sav -s 1 --mural-solved
### Mural Import/Export
The Bunny Mural can be exported and imported in a few different formats. First,
it can be imported or exported in the "raw" format, which is the exact same
way it's stored in savefiles and game memory. There aren't any public tools that
I'm aware of at time of writing to edit in this format, but it's available
regardless. The arguments to use are `--mural-raw-export` and `--mural-raw-import`:
awsave AnimalWell.sav -s 1 --mural-raw-export mural.dat
awsave AnimalWell.sav -s 1 --mural-raw-import mural.dat
When exporting the file, if the filename already exists, you will be prompted
to overwrite it. To skip the confirmation and always overwrite, specify `-f` or
`--force`:
awsave AnimalWell.sav -s 1 --mural-raw-export mural.dat -f
Additionally, the mural can be exported or imported as an image file, **so long as
the [Python Imaging Library (Pillow)](https://python-pillow.org/) is installed.**
If that library isn't available, these options won't be present.
Note that the file type must support "indexed" color. The most common image
formats which support indexed color are PNG and GIF -- note that JPEG *cannot*
be used for this, since that format does not support indexed color. The
arguments to use for this are `--mural-image-export` and
`--mural-image-import`:
awsave AnimalWell.sav -s 1 --mural-image-export mural.png
awsave AnimalWell.sav -s 1 --mural-image-import edited.png
As with the raw export, the utility will prompt for overwriting when necessary,
unless you also specify `-f` or `--force`:
awsave AnimalWell.sav -s 1 --mural-image-export mural.png -f
Note that imported files *must* be a 40x20 image which uses indexed color, and only
has four colors defined in its colormap. It's probably easiest to start with an
exported file to make sure the image is in the proper format. If any of the colors
in the image's colormap don't *exactly* match one of the mural's default colors,
the import process will do its best to match it to the closest color, but note that
this can end up making it look pretty bad. You'll have the best results if the
source image uses the exact colors, which are:
1. Black: `#0A1432`
2. Blue: `#64C8FF`
3. Red: `#FA6464`
4. White: `#FFE6C8`
### Flames
The four flame states can be set using the `--flame-collect` and `--flame-use`
arguments. Each of those can be specified more than once, or use the special
`all` value to operate on all at once. `--flame-collect` will merely put the
flame in your inventory, whereas `--flame-use` will put the flame in its
respective pedestal.
awsave AnimalWell.sav -s 1 --flame-collect p --flame-collect g
awsave AnimalWell.sav -s 1 --flame-use all
Valid values are: `b`, `p`, `v`, `g`, `all`.
### Manticores
The two manticore states can be set using the `--blue-manticore` and
`--red-manticore` arguments. They just have one of three states: `default`,
`overworld`, or `space`. Their default state is basically not being
present until you get to the Manticore Arena area (or set up the 65th
Egg). In "Overworld" state they will chase you around, and in "Space"
state they'll be friendly up on Bunny Island.
awsave AnimalWell.sav -s 1 --blue-manticore overworld --red-manticore space
### Teleportation Torus
The teleportation torus (two rooms right of the house/office) can be
toggled on/off with `--torus-enable` and `--torus-disable`:
awsave AnimalWell.sav -s 1 --torus-enable
awsave AnimalWell.sav -s 1 --torus-disable
### Bosses
There are several arguments to alter the state of bosses in the game, specifically:
the Chameleon, Bat, Ostriches, and Eel/Bonefish. They use the word `defeat`
to indicate getting rid of the boss, or `respawn` to bring them back:
awsave AnimalWell.sav -s 1 --chameleon-defeat
awsave AnimalWell.sav -s 1 --chameleon-respawn
awsave AnimalWell.sav -s 1 --bat-defeat
awsave AnimalWell.sav -s 1 --bat-respawn
awsave AnimalWell.sav -s 1 --ostrich-defeat
awsave AnimalWell.sav -s 1 --ostrich-respawn
awsave AnimalWell.sav -s 1 --eel-defeat
awsave AnimalWell.sav -s 1 --eel-respawn
As always, arguments can be combined into one command:
awsave AnimalWell.sav -s 1 --bat-defeat --chameleon-respawn
For the Ostriches, note that the same flag controls *both* Ostrich
bosses -- both the one which pokes at you underground, and the
wheel-bound one. The ostrich processing will also stop/start the
ostrich-controlled movable platforms as appropriate. If the app
is told to respawn the ostriches, it will also un-press the purple
button directly underneath the ostrich wheel. That way, the
ostrich won't just immediately become active again when you enter
the room again.
For the Eel/Bonefish, respawning it will put it in its pre-awakened
state.
You can also trigger an action for all four of these bosses at once with
`--bosses-defeat` or `--bosses-respawn`:
awsave AnimalWell.sav -s 1 --bosses-defeat
awsave AnimalWell.sav -s 1 --bosses-respawn
Note that specifying either of those will totally override any other boss
defeat/respawn arguments you specified.
### Eggs
Collected eggs can be enabled or disabled with the `--egg-enable` and
`--egg-disable` arguments. The arguments can be specified more than once,
and the special value `all` can be used to operate on all eggs at once.
awsave AnimalWell.sav -s 1 --egg-enable all
awsave AnimalWell.sav -s 1 --egg-disable zen --egg-disable ice
Note that this does *not* include the 65th Egg.
Valid values are: `reference`, `brown`, `raw`, `pickled`, `big`, `swan`,
`forbidden`, `shadow`, `vanity`, `service`, `depraved`, `chaos`, `upside_down`,
`evil`, `sweet`, `chocolate`, `value`, `plant`, `red`, `orange`, `sour`,
`post_modern`, `universal_basic`, `laissez_faire`, `zen`, `future`,
`friendship`, `truth`, `transcendental`, `ancient`, `magic`, `mystic`,
`holiday`, `rain`, `razzle`, `dazzle`, `virtual`, `normal`, `great`,
`gorgeous`, `planet`, `moon`, `galaxy`, `sunset`, `goodnight`, `dream`,
`travel`, `promise`, `ice`, `fire`, `bubble`, `desert`, `clover`, `brick`,
`neon`, `iridescent`, `rust`, `scarlet`, `sapphire`, `ruby`, `jade`,
`obsidian`, `crystal`, `golden`, `all`.
### Bunnies
Collected bunnies can be enabled or disabled with the `--bunny-enable`
and `--bunny-disable` arguments. The arguments can be specified more
than once, and the special value `all` can be used to operate on all
bunnies at once.
awsave AnimalWell.sav -s 1 --bunny-enable floor_is_lava --bunny-enable dream
awsave AnimalWell.sav -s 1 --bunny-disable all
This argument can't be used to collect the various "illegal" bunnies
hidden around the map (or just in game data).
Valid values are: `tutorial`, `origami`, `crow`, `ghost`, `fish_mural`, `map`,
`tv`, `uv`, `bulb`, `chinchilla`, `bunny_mural`, `duck`, `ghost_dog`, `dream`,
`floor_is_lava`, `spike_room`, `all`.
#### Illegal Bunnies
There are several "illegal" bunnies on the map which can only be acquired via
cheating (as with the Cheater's Ring) or via other map glitching techniques.
Collecting these bunnies will prevent the BDTP puzzle from being solveable, so
the `--illegal-bunny-clear` argument will remove them from your slot, in case
any have been collected:
awsave AnimalWell.sav -s 1 --illegal-bunny-clear
### Respawn Consumables
Ordinarily, fruit and firecrackers only respawn in the game world when you
die. The `--respawn-consumables` option will make them all reappear without
having to do so:
awsave AnimalWell.sav -s 1 --respawn-consumables
### Ghosts
Like with consumables, scared ghosts will stay scared until you die, at
which point they will respawn (unless a lit candle is keeping them away).
The `--clear-ghosts` and `--respawn-ghosts` arguments can be used to
frighten them all off, and cause them to respawn early, respectively:
awsave AnimalWell.sav -s 1 --clear-ghosts
awsave AnimalWell.sav -s 1 --respawn-ghosts
### Squirrels
Frightened squirrels can be respawned onto the map with the
`--respawn-squirrels` argument:
awsave AnimalWell.sav -s 1 --respawn-squirrels
### Buttons
All of the pressable buttons in the game can be pressed or released as
a group using the `--buttons-press` and `--buttons-reset` arguments. This
will process yellow (regular), purple (transient), green (machine control),
and pink (hidden) buttons. For Pink buttons, the utility will *only*
toggle "legitimate" buttons which the user is expected to be able to find.
The "illegal" buttons associated with hidden bunnies will *not* be
pressed.
awsave AnimalWell.sav -s 1 --buttons-press
awsave AnimalWell.sav -s 1 --buttons-reset
Note that resetting buttons will *not* automatically cause their related
doors/walls to revert to the closed state. Pressing buttons *will* cause
doors/walls to open once you enter the room, though, if they weren't
already open.
### Doors / Walls
There are five categories of openable doors/walls in the game:
1. "Regular" doors which are opened via button presses, water reservoirs,
or other environmental puzzles. These can be toggled with the
`--doors-open` and `--doors-close` arguments.
2. "Lockable" doors which require a key in your inventory to unlock.
There are six of these throughout the game map. They can be toggled
with the `--lockable-unlock` and `--lockable-lock` arguments.
3. The four doors in the Egg Chamber which ordinarily only open once you
have collected a minimum number of eggs. These can be toggled with
the `--eggdoor-open` and `--eggdoor-close` arguments.
4. Walls which function like doors, most typically encountered via pink
buttons or other late-game bunny puzzles, etc. These can be toggled
with the `--walls-open` and `--walls-close` arguments.
5. Other "special" doors like the House/Office/Closet doors, whose states
are mostly controlled via the [progress/quest options](#progressquests).
For "regular" doors in the game, note that if the buttons/puzzles which
opened them originally are still pressed/solved, entering the room after
closing them will just cause them to re-open again. Regardless, they can
be opened/closed like so:
awsave AnimalWell.sav -s 1 --doors-open
awsave AnimalWell.sav -s 1 --doors-close
Likewise, lockable doors can be opened/closed with:
awsave AnimalWell.sav -s 1 --lockable-unlock
awsave AnimalWell.sav -s 1 --lockable-lock
Egg Chamber doors work a little differently. Instead of being all-or-nothing,
they can be toggled individually, and the special value `all` can be used
to operate on all at once:
awsave AnimalWell.sav -s 1 --eggdoor-open all
awsave AnimalWell.sav -s 1 --eggdoor-close first --eggdoor-close third
Valid values are: `first`, `second`, `third`, `fourth`, `all`.
Moveable walls can be opened/closde like so:
awsave AnimalWell.sav -s 1 --walls-open
awsave AnimalWell.sav -s 1 --walls-close
Using the Cheater's Ring (or any other noclip cheating activity) can
allow the player to access "illegal" pink buttons which can cause extra walls
to open up in the game. At time of writing, there's a bug in the game where
opening too many of these can end up causing savefile corruption while in-game,
so they are best avoided. If you had triggered one or more of these in the
past, they can be cleaned up with the `--clear-invalid-walls` argument. This
will clean up both the moveable-wall entries and the pink button presses as
well. Note that this *cannot* fix an already-corrupted save, but it could at
least prevent a save from being corrupted after some of those pink buttons were
already hit:
awsave AnimalWell.sav -s 1 --clear-invalid-walls
Finally, the doors controlled by "quest state" information are the three doors
related to the house: the main house door, office, and closet. These can
be opened or closed with the `--house-open` and `--house-close` arguments:
awsave AnimalWell.sav -s 1 --house-open
awsave AnimalWell.sav -s 1 --house-close
### Chests
All chests in the game can be opened/closed using the `--chests-open` and
`--chests-close` arguments. Note that merely opening a chest does *not* provide
you with the item that the chest provided!
awsave AnimalWell.sav -s 1 --chests-open
awsave AnimalWell.sav -s 1 --chests-close
### Candles
Candles throughout the game can be individually lit or blown out using the
`--candles-enable` and `--candles-disable` arguments. These arguments can be
specified more than once, and the special value `all` can be used to operate on
all candles at once:
awsave AnimalWell.sav -s 1 --candles-enable all
awsave AnimalWell.sav -s 1 --candles-disable room_06_07 --candles-disable room_10_13
Valid values are: `room_04_06`, `room_08_06`, `room_04_07`, `room_06_07`,
`room_06_09`, `room_15_09`, `room_05_13`, `room_10_13`, `room_16_13`, `all`.
The numbers in the value names refer to the room coordinates containing the
candle.
### Crank Puzzles
There are four puzzles in the game which are solved by manipulating cranks/levers:
three to fill water reservoirs, and one "sine wave" puzzle. The `--solve-cranks`
argument can be used to set most of those cranks to values which will result in
the puzzle being completed. The one exception is the Seahorse Boss room, since
the cranks need to be adjusted in realtime to account for the Seahorse position
and also which reservoir is being filled at the time.
awsave AnimalWell.sav -s 1 --solve-cranks
### Water Reservoirs
The five water reservoirs in the game can be all filled up or emptied using the
`--reservoirs-fill` and `--reservoirs-empty` arguments:
awsave AnimalWell.sav -s 1 --reservoirs-fill
awsave AnimalWell.sav -s 1 --reservoirs-empty
### Detonators
The various detonators around the map can be triggered or re-armed using the
`--detonators-activate` and `--detonators-rearm` arguments:
awsave AnimalWell.sav -s 1 --detonators-activate
awsave AnimalWell.sav -s 1 --detonators-rearm
Note that merely re-arming a detonator will not automatically rebuild the
destroyed tiles from the original explosion. To spawn those back in, you can
use the `--respawn-destroyed-tiles` argument (see below).
### Destroyed Tiles
Tiles in the game can get destroyed in a variety of ways, such as the
Top/Yoyo, detonators, Manticore laser beams, etc. To respawn all destroyed
tiles in the map, you can use the `--respawn-destroyed-tiles` argument:
awsave AnimalWell.sav -s 1 --respawn-destroyed-tiles
### Big Stalactites
The state of all big stalactites can be set with the `--big-stalactites-state`
argument:
awsave AnimalWell.sav -s 1 --big-stalactites-state floor
Valid values are: `intact`, `cracked_once`, `cracked_twice`, `floor`,
`floor_cracked_once`, `floor_cracked_twice`, and `broken`. Note that all
big stalactites will reset to the "intact" state upon player death.
### Stalactites / Stalagmites / Icicles
The small stalactites, stalagmites, and icicles in the game can be cleared or
respawned using `--small-deposits-break` or `--small-deposits-respawn`:
awsave AnimalWell.sav -s 1 --small-deposits-break
awsave AnimalWell.sav -s 1 --small-deposits-respawn
Note that all small deposits respawn naturally upon player death.
### Minimap
The minimap can be revealed or cleared using the `--reveal-map` and `--clear-map`
arguments:
awsave AnimalWell.sav -s 1 --reveal-map
awsave AnimalWell.sav -s 1 --clear-map
Note that the fully-revealed map will look different than a "naturally"
fully-revealed minimap, because all of the "inner" wall space will be filled
in. When the game itself reveals the minimap, it stops right at the wall
boundaries.
### Map Marks
The user-made marks to the map using the pencil and stamps can be cleared using
the `--clear-pencil` and `--clear-stamps` options, respectively:
awsave AnimalWell.sav -s 1 --clear-pencil
awsave AnimalWell.sav -s 1 --clear-stamps
### Pencil Images
**Note:** These functions require that the [Python Imaging Library
(Pillow)](https://python-pillow.org/) is installed. If that library isn't
available, these options won't be present.
This utility can import images onto the minimap pencil layer using the
`--pencil-image-import` argument, and export the current pencil layer
into a graphics file using the `--pencil-image-export` argument. When
importing, the image will be scaled down to the minimap native resolution with
no regard to aspect ratio (if needed), and dithered into a monochrome image
(also if needed). Passing a 1-bit image with the exact correct dimensions
should result in importing without any resizing or conversion.
The minimap technically includes an "empty" border around the confines of the
playable map area, and by default this pencil-image import will consume that
entire space, which is 800x528. You can specify the `--pencil-image-playable`
argument to restrict the import size to the borders of the playable area
instead, which is 640x352.
awsave AnimalWell.sav -s 1 --pencil-image-import bunnies.jpg
awsave AnimalWell.sav -s 1 --pencil-image-import bunnies.jpg --pencil-image-playable
The imported image can be inverted by specifying `--pencil-image-invert`, in
case your image would look better that way:
awsave AnimalWell.sav -s 1 --pencil-image-import bunnies.jpg --pencil-image-invert
For exporting to a graphics file, the utility should understand most common
image format by its extension, and write the appropriate format:
awsave AnimalWell.sav -s 1 --pencil-image-export output1.jpg
awsave AnimalWell.sav -s 1 --pencil-image-export output2.png
If the export file already exists, the utility will prompt you to overwrite. To
automatically overwrite without any interactive prompt, use the `-f`/`--force`
option:
awsave AnimalWell.sav -s 1 --pencil-image-export output.jpg -f
Library
-------
The data backend should be easily usable on its own, for anyone wishing
to make programmatic changes, or write other frontends. At the moment
the best docs are just browsing through the code. I apologize for my
frequent PEP-8 violations, lack of typing hints, and idiosyncratic
coding habits, etc.
A quick example of the kinds of things that would be possible:
```py
from animalwellsave.savegame import Savegame, Equipment, Equipped
with Savegame('AnimalWell.sav') as save:
slot = save.slots[0]
print(f'Editing slot {slot.index+1} ({slot.timestamp})...')
print('Current equipment unlocked:')
for equip in sorted(slot.equipment.enabled):
print(f' - {equip}')
slot.num_steps.value = 15
slot.equipment.disable(Equipment.DISC)
slot.equipment.enable(Equipment.WHEEL)
slot.selected_equipment.value = Equipped.WHEEL
save.save()
```
See also `animalwellsave/cli.py`, which is probably the best place to look for
examples of interacting with the data.
The objects are set up to allow both defining consecutive fields within
the savefile (without specifying manual offsets), and also skipping around
using manual offsets. When offsets are specified, they are computed relative
to the "parent" object -- so for instance, the absolute offsets used in
the `Slot` class are relative to the start of the slot. The fields created
while looping through the file are all subclasses of the base `datafile.Data`
class, which will end up computing and storing the *absolute* offset
internally. The save data is mirrored in an internal `io.BytesIO` object,
which is where all changes are written. It will not actually write back out
to disk until a `save()` call has been sent.
The data objects (subclasses of `datafile.Data`) try to be easy to read, and
can be interpreted as strings or in format strings, etc. Subclasses of
`NumData` can often be used just as if they are numbers, supporting various
numerical overloads. Bitfield classes can generally be acted on like
arrays, at least in terms of looping through the options. `NumBitfieldData`
keeps an `enabled` set for ease of checking which members are enabled.
*Setting* new data should often be done via the `value` property rather than
setting it directly, though -- note in the example above where the `num_steps`
property is being set that way. `value` should also be used if you need an
actual number, such as if using it in a list index or the like.
`NumChoiceData` objects are used where the value is expected to be one of
a member of an enum. In these objects, `value` will always be the raw numeric
value still, but there's also a `choice` attribute which will correspond to
the proper enum item, if possible. The class technically supports setting
values outside the known enum values, in which case `choice` will end up
being `None`. Keep in mind that setting a value for these should still be done
via `value` rather than `choice`.
Apart from that, as I say, just looking through `cli.py` or the objects
themselves would probably be the best way to know how to use 'em.
Changelog
---------
**v1.2.0** - *Jul 4, 2024*
- New arguments:
- `--nuts` is used to set stolen-nut count
- `--small-deposits-break` and `--small-deposits-respawn` are used to
manage small stalactites/stalagmites/icicles.
- `--big-stalactites-state` is used to set all big stalactite states.
- `--illegal-bunny-clear` will remove any "illegal" bunnies from the
slot. These can otherwise interfere with the BDTP solution. (Illegal
bunnies can only be acquired via cheating/glitching, as with the Cheater's
Ring, etc.)
- Added import/export of the bunny mural, with both "raw" and real image
options, via: `--mural-raw-import`, `--mural-raw-export`,
`--mural-image-import`, and `--mural-image-export`.
- Report on status of Space / Bunny Island buttons and CE Temple chest, and
alter those states when specifying our button and chest arguments.
- Added in the chest holding the Golden Egg (at 12,19), which was otherwise
omitted from the chest opening/closing arguments.
- Fixed a bug which could cause map-feature-activations (press all buttons,
open all chests, etc) to reset/close items we don't know about. (This had
been affecting the Golden Egg chest referenced above.)
- Improve kangaroo state reporting slightly, and set its state to "Lurking"
instead of "Attacking" when setting its current room, which should make that
spawn be more reliable.
- Exclude Mock Disc from inventory unlocks if the user specifies both
`--equip-enable all` and `--inventory-enable all` (this can be disabled by
also using the `--dont-fix-disc-state` argument).
- Renamed the "extra" `PencilImages` optional dependency handling to just
`Images`
**v1.1.0** - *Jun 6, 2024*
- Added explicit arguments to set various Quest State flags without having
to manipulate those flags via the `--quest-state-*` arguments:
- Added arguments to defeat or respawn the game's bosses. Specifically:
- Chameleon
- Bat
- Ostriches
- Eel/Bonefish
- Added `--house-open` and `--house-close` arguments to manage the state of
the doors around the house.
- Added arguments to manage S. Medal and E. Medal insertion state.
- Added `--move-disc-to-shrine` and `--move-disc-to-statue` args, to
shuffle the Mock Disc between its two homes.
- Added `--solve-cranks` argument to solve most crank-related puzzles.
- Info-reporting tweaks:
- Added `--verbose` option to also show missing items (inventory, eggs, etc)
on the info output, rather than just the things that *are* present.
- Added `--debug` output to show data offsets within the savegame
- Converted info report to use columns for long lists of data, and added a
`-1`/`--single-column` argument to revert to one item per line.
- Added lit-candle report
- Improved K. Shard reporting
- Removed dash in "Post Modern" egg text
- Reworded the Dog Head Statue description in Quest State
- Fixed a bug in Mural handling which could have caused some problems for
hypothetical data reads after the mural.
- Info added to data model (though not directly accessible via the CLI):
- Elevator/Platform Data *(Ostrich Boss processing does touch this a bit)*
- Bunny Mural last-selected-pixel coordinates
**v1.0.0** - *May 31, 2024*
- Initial release
License
-------
`animalwellsave` is licensed under the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.en.html).
A copy can be found at [LICENSE.txt](LICENSE.txt).
Raw data
{
"_id": null,
"home_page": null,
"name": "animalwellsave",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "animalwell, animal well, save editor",
"author": null,
"author_email": "CJ Kucera <cj@apocalyptech.com>",
"download_url": "https://files.pythonhosted.org/packages/dc/1d/82914eed57c5fdf3b19098a36a508f0c2340704f74d5b1993f88927b12d9/animalwellsave-1.2.0.tar.gz",
"platform": null,
"description": "Python-Based CLI Animal Well Savegame Editor\n============================================\n\n`animalwellsave` is a save editor (and data backend) for editing\n[Animal Well](https://store.steampowered.com/app/813230/ANIMAL_WELL/) savegames.\nIt supports editing nearly everything stored in the savegames. In addition\nto the editing features you'd expect, it's got some features you might not\nexpect, including:\n\n - Importing/Exporting specific slots\n - Setting the Bunny Mural to its default, solved, or cleared state, and\n importing/exporting the mural in raw or image formats\n - Image import/export of the \"pencil\" map layer\n - Forcing Kangaroo spawns to a specific room\n - Respawning consumables (fruit, firecrackers) on the map\n - Clearing ghosts / Lighting Candles\n - Clearing out \"illegal\" pink-button presses and bunnny collection (acquired\n via cheating or glitching) to avoid future savefile corruption or BDTP\n puzzle problems\n - And much more! Read on for the full details\n\nTable of Contents\n-----------------\n\n - [Overview](#overview)\n - [Running / Installation](#running--installation)\n - [Easiest Method: pip](#easiest-method-pip)\n - [Git Checkout (the proper way)](#git-checkout-the-proper-way)\n - [Git Checkout (the lazy way)](#git-checkout-the-lazy-way)\n - [Release Archives (not recommended)](#release-archives-not-recommended)\n - [TODO](#todo)\n - [Usage](#usage)\n - [Showing Save Info](#showing-save-info)\n - [Checksum](#checksum)\n - [Choose Slot](#choose-slot)\n - [Import/Export Slots](#importexport-slots)\n - [Frame Seed](#frame-seed)\n - [Global Unlocks (Figurines, etc)](#global-unlocks-figurines-etc)\n - [Health](#health)\n - [Spawnpoint](#spawnpoint)\n - [Steps](#steps)\n - [Deaths](#deaths)\n - [Bubbles Popped](#bubbles-popped)\n - [Berries Eaten While Full](#berries-eaten-while-full)\n - [Game Ticks (Elapsed Time)](#game-ticks-elapsed-time)\n - [Wings (Flight)](#wings-flight)\n - [Firecrackers](#firecrackers)\n - [Keys / Matches](#keys--matches)\n - [Nuts](#nuts)\n - [Equipment](#equipment)\n - [Inventory](#inventory)\n - [Map Unlocks](#map-unlocks)\n - [B.B. Wand](#bb-wand)\n - [Egg 65](#egg-65)\n - [Cheater's Ring](#cheaters-ring)\n - [Progress/Quests](#progressquests)\n - [Mock Disc Location](#mock-disc-location)\n - [Caged Cats](#caged-cats)\n - [Kangaroo Room](#kangaroo-room)\n - [K. Shards](#k-shards)\n - [S. Medal and E. Medal](#s-medal-and-e-medal)\n - [Animal Head Teleporters](#animal-head-teleporters)\n - [Bunny Mural](#bunny-mural)\n - [Mural Import/Export](#mural-importexport)\n - [Flames](#flames)\n - [Manticores](#manticores)\n - [Teleportation Torus](#teleportation-torus)\n - [Bosses](#bosses)\n - [Eggs](#eggs)\n - [Bunnies](#bunnies)\n - [Illegal Bunnies](#illegal-bunnies)\n - [Respawn Consumables](#respawn-consumables)\n - [Ghosts](#ghosts)\n - [Squirrels](#squirrels)\n - [Buttons](#buttons)\n - [Doors / Walls](#doors--walls)\n - [Chests](#chests)\n - [Candles](#candles)\n - [Crank Puzzles](#crank-puzzles)\n - [Water Reservoirs](#water-reservoirs)\n - [Detonators](#detonators)\n - [Destroyed Tiles](#destroyed-tiles)\n - [Big Stalactites](#big-stalactites)\n - [Stalactites / Stalagmites / Icicles](#stalactites--stalagmites--icicles)\n - [Minimap](#minimap)\n - [Map Marks](#map-marks)\n - [Pencil Images](#pencil-images)\n - [Library](#library)\n - [Changelog](#changelog)\n - [License](#license)\n\nOverview\n--------\n\nMake sure to backup your saves before using this! I've yet to encounter any\nsavefile corruption, but it's always possible you could run into a weird\nedge case.\n\nWork on decoding the savegame structure has mostly been done by\n[Kein](https://github.com/Kein/), [just-ero](https://github.com/just-ero),\nlipsum, polinet68, avengah, and myself. My own contributions were mostly\nat the beginning of the process; Kein, just-ero, and lipsum have been\nresponsible for the majority of the save format at this point. Many thanks\nto them for filling things out!\n\nA complete mapping of the savegame data can be found at\n[Kein's awsgtools repo](https://github.com/Kein/awsgtools). At time of\nwriting the primary format there is an\n[010 Editor](https://www.sweetscape.com/010editor/) binary template\nplus an [ImHex](https://imhex.werwolv.net/) pattern. Other translations\nmay become available over time. A human-readable document describing the\nsave format can be found [at the wiki of that repo](https://github.com/Kein/awsgtools/wiki)\nas well, though that document might lag behind the official templates.\n\nRunning / Installation\n----------------------\n\nThis is a Python-based CLI app and library. It should run on Python 3.10+,\nthough it's received most of its testing on Python 3.12. There is currently\nno GUI component -- you'll have to be comfortable working in the commandline\nfor this to work.\n\n### Easiest Method: pip\n\nAt the basic level, once Python is installed, you can install `animalwellsave`\nwith a simple:\n\n pip install animalwellsave\n\nTo also pull in the dependencies necessary to support importing/exporting\nimages into the \"pencil\" minimap layer and bunny mural, you can alternately\nspecify this for the installation line:\n\n pip install animalwellsave[Images]\n\nYou could also install it for just your user with:\n\n pip install --user animalwellsave[Images]\n\nOnce installed, there will be an `awsave` command available to run, like so:\n\n awsave --help\n\nRather than doing a \"global\" installation as mentioned above, it's recommended\nto install in a [virtual environment](https://docs.python.org/3/library/venv.html),\nthough. (This is true of Python apps in general.) On Unix/Mac:\n\n cd /wherever/you/want/to/keep/the/virtualenv\n python -m venv virtualenv_dir\n source virtualenv_dir/bin/activate\n pip install animalwellsave[Images]\n\nOr on Windows:\n\n cd \\wherever\\you\\want\\to\\keep\\the\\virtualenv\n python -m venv virtualenv_dir\n virtualenv_dir\\Scripts\\activate\n pip install animalwellsave[Images]\n\n### Git Checkout (the proper way)\n\nThe app can also be run right from a git checkout. The \"correct\" way to \ndo this is with a virtual environment using\n[\"editable\" mode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html).\nFrom the main project checkout dir (example here is for Unix/MacOS; the\nactivation line is different for Windows -- see above):\n\n python -m venv .venv\n source .venv/bin/activate\n pip install --editable .\n\nOptionally, to install the dependencies needed for importing/exporting images\nto the \"pencil\" minimap layer and bunny mural, you can run:\n\n pip install -r image-requirements.txt\n\nOnce done, you should be able to run the `awsave` command as usual:\n\n awsave --help\n\n### Git Checkout (the lazy way)\n\nAlternatively, if you want to run it directly from a git checkout *without*\nsetting up a virtual environment and setting it to editable mode, you can\njust use the shortcut `awsave.py` script right in the main dir:\n\n ./awsave.py --help\n\nOr, you can call the cli module directly:\n\n python -m animalwellsave.cli --help\n\n### Release Archives (not recommended)\n\nBundled with official releases on the\n[Github Releases Page](https://github.com/apocalyptech/animalwellsave/releases)\nare Python-produced \"source distribution\" and \"built distribution\" (wheel)\nfiles (these are also available via\n[animalwellsave's pypi area](https://pypi.org/project/animalwellsave/#files)).\nNeither of these are meant to be complete archives of the github repo, and will\nbe missing content like the \"convenience\" `awsave.py` script that's in the gitub\nrepo root. These files *can* be installed via pip, though, using the various\nmethods described above:\n\n pip install animalwellsave-1.1.0.tar.gz\n pip install animalwellsave-1.1.0-py3-none-any.whl\n\nIn general there's probably not much reason to manually download/install these\nfiles; if you don't want to use `pip` to install the app, just checking out\nthe git repo is probably the better method. Still, if you wanted to install via\npip but not use its automatic project download features, you're welcome to\ninstall via that method if you want. After install, the `awsave` command should\nbe available for use.\n\nTODO\n----\n\nThe editor currently does not attempt to support *everything* inside the\nsavegames. Some notable bits of data which can't be edited directly (but\nwhich are present in the data library):\n\n - General Crank status\n - Elevator status\n\nSome data is, likewise, not actually even present in the data library\nyet:\n\n - Some seemingly-unimportant flags have been omitted from a few areas,\n for instance the global \"switch\" state (left/right), early-game flags\n like \"woke up,\" etc.\n - Achievements *(unsure if setting these in the save would actually make\n them activate on Steam)*\n - Game Options\n\nWhile I don't have any current plans to support the above, there are a\nfew other things which would be nice eventually:\n\n - Mapping chests to their unlocks, so unlocking eggs (for instance) would\n mark the relevant chests as opened. Vice-versa for disabling unlocks;\n it'd be nice to close the associated chest so it could be re-acquired.\n At the moment, chest opening/closing is all-or-nothing.\n - Similarly, mapping buttons/reservoirs to which doors they open would be\n nice, to be able to couple those a bit more closely. At the moment,\n button/door states are all-or-nothing.\n - Ability to perform slot actions on an exported slot file?\n - Once [Kaitai Struct](https://kaitai.io/)'s\n [serialization features](https://doc.kaitai.io/serialization.html)\n make it into an official release, it'd be nice to convert over to that.\n Something like that is really what I'd wanted to do at the start, rather\n than my own janky weirdness.\n - Clean up CLI options to be more consistent with pluralizations, noun-verb\n ordering, abbreviations, etc. Even I often screw up the CLI options\n occasionally and need to look at the `--help` output. I'll probably wait\n for a Kaitai Struct rewrite to do so, though (which would likely be a 2.0\n release)\n\nUsage\n-----\n\nHere is a detailed list of all the arguments available on the CLI editor.\nNote that these arguments can be chained together pretty much as long as\nyou want. For instance:\n\n awsave AnimalWell.sav -i -s 0 --equip-enable all --inventory-enable pack --firecrackers 6 --upgrade-wand\n\n### Showing Save Info\n\nTo show information about the save, including for any chosen slots, use\n`-i`/`--info`:\n\n awsave AnimalWell.sav -i\n awsave AnimalWell.sav --info\n\nThe base info output will only show the \"global\" information which applies to\nall slots. To show information on a specific slot, use the `-s`/`--slot`\nargument (described in more detail below):\n\n awsave AnimalWell.sav -i -s 1\n awsave AnimalWell.sav --info --slot 1\n\nBy default, the info output will just show you things that you *have* collected\nor done throughout the game. To also show information about things you *haven't*\ncollected or done (such as missing eggs, etc), use `-v`/`--verbose`:\n\n awsave AnimalWell.sav -i -s 1 -v\n awsave AnimalWell.sav --info --slot 1 --verbose\n\nAdditionally, the in-save data offsets for every bit of data that the data\nlibrary knows about can be printed with `-d`/`--debug`. This will show the\ninfo for all slots as well, regardless of which slots have been chosen to show.\nIt will write this information to stderr:\n\n awsave AnimalWell.sav -d\n awsave AnimalWell.sav --debug\n\nFinally, by default the info dump will use column outputs when showing long lists,\nsuch as unlocked eggs. To have the utility only output one item per line, use\nthe `-1`/`--single-column` argument:\n\n awsave AnimalWell.sav -i -s 1 -1\n awsave AnimalWell.sav --info --slot 1 --single-column\n\n### Checksum\n\nThe `--fix-checksum` option can be used to fix the savegame's checksum without\nchanging anything else. (The utility will automatically update the checksum if\nany other changes are made to the file.) If the save has an invalid checksum,\nAnimal Well will spawn a Manticore friend to follow you around, so this can be\nused to fix it in case any manual hex editing has been going on.\n\n awsave AnimalWell.sav --fix-checksum\n\nIf you wanted to *intentionally* force an invalid checksum, because you'd like\na Manticore friend to go exploring with, you can use the `--invalid-checksum`\nargument. If that's the *only* save-edit you want to do, you'll have to specify\nthe `--fix-checksum` argument as well:\n\n awsave AnimalWell.sav --fix-checksum --invalid-checksum\n\n### Choose Slot\n\nMost options in the editor operate on slot data, so this argument is generally\nnecessary. `-s` or `--slot` can be used for this, to choose\na specific slot (`1`, `2`, or `3`), or to operate on *all* slots by\nchoosing `0`.\n\n awsave AnimalWell.sav -i -s 1\n awsave AnimalWell.sav --info --slot 2\n\nNote that a few arguments (namely the various import/export arguments for slot\ndata, pencil minimap images, and bunny murals) do not allow using `0` to\nspecify \"all slots.\"\n\n### Import/Export Slots\n\nSlot data can be imported or exported to allow transferring slots without\nalso transferring \"global\" data (like collected figurines, or game options).\nFor example, to export slot 2 into the file `slot2.dat` with the\n`--export`/`--export-slot` option:\n\n awsave AnimalWell.sav -s 2 --export slot2.dat\n\nThen that file could be imported into another slot with the `--import`/`--import-slot`\noption:\n\n awsave AnimalWell.sav -s 3 --import slot2.dat\n\nNote that the only data checking the import process does is to ensure that\nthe file being imported is exactly the right filesize (149,760 bytes).\n\nIf the filename you attempt to export to already exists, this app will\nprompt you if you want to overwrite. To force overwriting without any\ninteractive prompt, use the `-f`/`--force` option:\n\n awsave AnimalWell.sav -s 2 --export slot2.dat -f\n\n### Frame Seed\n\nThe \"frame seed\" is presumably used for various randomizations in the\ngame, but the most noticeable effect is to determine which Bunny Mural\nsegment is presented to the user. The mural segment shown is the frame\nseed modulo 50, so you could theoretically get all of the segments\nyourself by editing this value 50 times. `--frame-seed` can be used\nto alter the value:\n\n awsave AnimalWell.sav --frame-seed 42\n\n### Global Unlocks (Figurines, etc)\n\nSome items unlocked in the game apply to all slots, such as the stopwatch,\npedometer, pink phones, and the various figurines which show up in the House.\nThe `--globals-enable` and `--globals-disable` arguments can be used to\ntoggle the various states. The special value `all` can be used to toggle\nall of them at once, and the argument can be specified multiple times.\n\n awsave AnimalWell.sav --globals-disable stopwatch --globals-disable pedometer\n awsave AnimalWell.sav --globals-enable all\n\nValid values are: `stopwatch`, `pedometer`, `pink_phone`, `souvenir_cup`,\n`origami`, `two_rabbits`, `owl`, `cat`, `fish`, `donkey`, `deco_rabbit`,\n`mama_cha`, `giraffe`, `incense`, `peacock`, `otter`, `duck`, `all`.\n\n### Health\n\nPlayer health can be set with the `--health` option. Note that this is the\ntotal number of hearts, which includes your base health, any gold hearts,\nand any \"extra\" blue hearts. The game's maximum is probably 12, though I\nhaven't actually tested beyond that.\n\n awsave AnimalWell.sav -s 1 --health 8\n\nRelatedly, gold hearts can be added with the `--gold-hearts` option:\n\n awsave AnimalWell.sav -s 1 --health 12 --gold-hearts 4\n\n### Spawnpoint\n\nThe player's spawnpoint is stored in the game by room coordinates, and can\nbe set with the `--spawn` argument. The upper-left room is at coordinate\n2,4. If there is a phone in the room that has been specified, the player\nwill spawn near the phone. Otherwise, the player spawns in the upper-left-most\navailable spot in the room.\n\n awsave AnimalWell.sav -s 1 --spawn 11,11\n\n### Steps\n\nYou can set the number of steps the player has walked with the `--steps`\nargument:\n\n awsave AnimalWell.sav -s 1 --steps 42\n\nThe ingame pedometer rolls over to 0 after hitting 99,999.\n\n### Deaths\n\nYou can set the number of recorded deaths using the `--deaths` option:\n\n awsave AnimalWell.sav -s 1 --deaths 0\n\n### Saves\n\nYou can set the number of saves that the player has performed using the\n`--saves` option. Note that the minimum legal value here is 1, since\nthe slot data will not be populated on-disk until the first savegame.\n\n awsave AnimalWell.sav -s 1 --saves 1\n\n### Bubbles Popped\n\nThe number of your B.Wand bubbles which have been popped by hummingbirds\ncan be altered with the `--bubbles-popped` argument:\n\n awsave AnimalWell.sav -s 1 --bubbles-popped 42\n\n### Berries Eaten While Full\n\nThe number of berries you've eaten while at full health can be altered\nwith the `--berries-eaten-while-full` argument:\n\n awsave AnimalWell.sav -s 1 --berries-eaten-while-full 10\n\n### Game Ticks (Elapsed Time)\n\nThe game keeps track of how many \"ticks\" have elapsed since the beginning\nof the game. The game runs at 60fps, so this value is *not* actually in\nmilliseconds. There are technically two fields for this: one value which\nis *just* ingame time (which does not seem to be used anywhere), and\nanother which includes all the time spent in \"pause\" menus. There are\ntwo arguments related to ticks. First, `--ticks-copy-ingame` can be\nused to copy your \"ingame\" counter over to the \"including paused\" counter,\nin case you feel that your speedrun effort is being unfairly held back by\npausing:\n\n awsave AnimalWell.sav -s 1 --ticks-copy-ingame\n\nAlternatively, you can just set the numeric value for both at the same\ntime using `--ticks`:\n\n awsave AnimalWell.sav -s 1 --ticks 0\n\n### Wings (Flight)\n\nA very late-game unlock gives you the ability to sprout wings and fly\naround very quickly, by double-jumping. This can be enabled or disabled\nusing `--wings-enable` and `--wings-disable`:\n\n awsave AnimalWell.sav -s 1 --wings-enable\n awsave AnimalWell.sav -s 1 --wings-disable\n\n### Firecrackers\n\nYour player firecracker count can be set with the `--firecrackers` argument.\nSetting this to a value greater than zero will also unlock the Firecracker\nequipment, if it's not already unlocked.\n\n awsave AnimalWell.sav -s 1 --firecrackers 3\n\n### Keys / Matches\n\nKeys and Matches can be set using the `--keys` and `--matches` arguments.\nNote that the keys here are the \"generic\" ones which show up on the left in your\ninventory. The maximum numbers available in the vanilla game are 6 keys, and\n9 matches.\n\n awsave AnimalWell.sav -s 1 --keys 6 --matches 9\n\n### Nuts\n\nThe number of nuts that you've stolen from squirrels cna be set with the `--nuts`\nargument. Note that the game doesn't actually report this count to the user in\nany way.\n\n awsave AnimalWell.sav -s 1 --nuts 4\n\n### Equipment\n\nEquipment is the various items you directly use throughout the game, like\nFirecrackers, B. Wand, Disc, etc. These can be individually toggled on or off\nusing the `--equip-enable` and `--equip-disable` arguments. Those can be specified\nmore than once, and you can also use `all` as a special option to process all at\nonce.\n\n awsave AnimalWell.sav -s 1 --equip-enable all\n awsave AnimalWell.sav -s 1 --equip-disable disc --equip-disable yoyo\n\nValid values are: `firecracker`, `flute`, `lantern`, `top`, `disc`, `wand`,\n`yoyo`, `slink`, `remote`, `ball`, `wheel`, `uvlight`, `all`.\n\nNote that whenever you toggle the Disc state using this option, this utility will\nby default attempt to set the game's quest states appropriately, to avoid having\nyou get chased by a ghost dog. This can end up changing where the Mock Disc is\nin the gameworld. When giving yourself the Disc, there are two valid game states:\none with the Mock Disc in the initial dog head statue, and the other with the\nMock Disc in the M. Disc Shrine. By default, the quest-correction will set the\ngame to the dog-head-statue state, but you can have it put the Mock Disc in the\nshrine instead with `--prefer-disc-shrine-state`:\n\n awsave AnimalWell.sav -s 1 --equip-enable disc --prefer-disc-shrine-state\n\nAlternatively, you can disable the auto-fix attempt entirely using the\n`--dont-fix-disc-state` argument, in case you want to have a doggo friend to\nkeep you company (or if you're editing the quest states yourself later):\n\n awsave AnimalWell.sav -s 1 --equip-enable disc --dont-fix-disc-state\n\n### Inventory\n\nInventory refers to other items which you acquire throughout the game which are\n*not* usable equipment items. These can be individually toggled on or off\nusing the `--inventory-enable` and `--inventory-disable` arguments. These can\nbe specified more than once, and you can also use `all` as a special option to\nprocess all at once.\n\n awsave AnimalWell.sav -s 1 --inventory-enable all\n awsave AnimalWell.sav -s 1 --inventory-disable house_key --inventory-disable office_key\n\nValid values are: `mock_disc`, `s_medal`, `house_key`, `office_key`, `e_medal`,\n`pack`, `all`.\n\nNote that if you add the Mock Disc using this option, this utility will by default\nattempt to set the game's quest state appropriately as if you'd picked up the Mock Disc\ningame. You can disable this behavior with the `--dont-fix-disc-state` argument:\n\n awsave AnimalWell.sav -s 1 --inventory-enable mock_disc --dont-fix-disc-state\n\nRelatedly, if you add all equipment *and* all inventory using the following options:\n\n awsave AnimalWell.sav -s 1 --equip-enable all --inventory-enable all\n\n... the utility will by default exclude the Mock Disc from the inventory unlocks, since\nthat's not actually a valid gamestate. As with the other Disc / Mock Disc options, you\ncan force both in your inventory at the same time by specifying `--dont-fix-disc-state`.\n\n### Map Unlocks\n\nThe various map-feature unlocks can be enabled using the `--map-enable` argument.\nThe special value `all` can be used to unlock all three at once:\n\n awsave AnimalWell.sav -s 1 --map-enable all\n\nValid values are: `unlock_map`, `unlock_stamps`, `unlock_pencil`, `all`.\n\n### B.B. Wand\n\nThe B. Wand can be upgraded to the B.B. Wand (or downgraded back) using\n`--upgrade-wand` and `--downgrade-wand`:\n\n awsave AnimalWell.sav -s 1 --upgrade-wand\n awsave AnimalWell.sav -s 1 --downgrade-wand\n\n### Egg 65\n\nEgg 65 can be enabled or disabled in your inventory using `--egg65-enable` and\n`--eg65-disable`:\n\n awsave AnimalWell.sav -s 1 --egg65-enable\n awsave AnimalWell.sav -s 1 --egg65-disable\n\n### Cheater's Ring\n\nThe Cheater's Ring can be enabled or disabled in your inventory using\n`--cring-enable` and `--cring-disable`:\n\n awsave AnimalWell.sav -s 1 --cring-enable\n awsave AnimalWell.sav -s 1 --cring-disable\n\n### Progress/Quests\n\nThere are two fields in the savegame which relate to progress / quests.\nI honestly wasn't sure what to call the first one -- it includes some very\nearly-game flags like \"game started\" and \"ready to hatch,\" but then also\nincludes a very late-game flag when the House Key drops after defeating the\nfirst Manticore. The field is totally separate from the main \"quest\" area.\nSo, I settled on \"progress.\" Apart from the House Key drop, the only other flag\nthe editor supports is the one that enables your HP Bar to be shown on the\nscreen. The arguments to edit this field are `--progress-enable` and\n`--progress-disable`. The special value `all` can be used to process all\n(well, both) at once:\n\n awsave AnimalWell.sav -s 1 --progress-enable all\n awsave AnimalWell.sav -s 1 --progress-disable hp_bar\n\nValid values are: `hp_bar`, `house_key`, `all`.\n\nThe *main* field which defines progress/quest information is rather more\ncomplete, but note that it's not really recommended to alter this structure\ndirectly. Some of the states in here rely on other states and other bit of data\nto be a \"valid\" gamestate (or at least, one which could be encountered in an\nunmodified game). Specific arguments exist for managing all quest state flags\nsupported by the editor, and should take care of any weird edge cases for you.\nStill, if you want to tweak any of these by hand, they're available here. Manual\ntweaking will be performed at the very *end* of the slot processing, so you can\nuse this argument to override any other massaging that previous processing might\nhave done.\n\nThe main quest state bitfield can be altered with `--quest-state-enable` and\n`--quest-state-disable`. As with other options of this sort, it can be specified\nmore than once, and the special value `all` can be used to operate on them all at\nonce.\n\n awsave AnimalWell.sav -s 1 --quest-enable house_open --quest-enable office-open\n awsave AnimalWell.sav -s 1 --quest-disable all\n\nValid values are: `house_open`, `office_open`, `closet_open`, `unlock_map`,\n`unlock_stamps`, `unlock_pencil`, `defeated_chameleon`, `cring`,\n`used_s_medal`, `used_e_medal`, `wings`, `bb_wand`, `egg_65`, `torus`,\n`defeated_bat`, `freed_ostrich`, `defeated_ostrich`, `fighting_eel`,\n`defeated_eel`, `shrine_no_disc`, `statue_no_disc`, `all`.\n\n### Mock Disc Location\n\nIn ordinary gameplay, the Mock Disc can either live in the Dog Head Statue, or the\nMock Disc Shrine. The `--move-disc-to-shrine` and `--move-disc-to-statue`\narguments can be used to move the Mock Disc from one to the other:\n\n awsave AnimalWell.sav -s 1 --move-disc-to-shrine\n awsave AnimalWell.sav -s 1 --move-disc-to-statue\n\nNote that these arguments will only make changes if the Mock Disc is already stored\nin one of those two locations. If you've got a nonstandard game state (due to\nearlier editing, etc), you'll have to alter the various flags by hand using the\n`--quest-state-enable` and `--quest-state-disable` arguments. Also note that these\narguments aren't really intended to be used alongside arguments which add or remove\nthe Disc or Mock Disc from player equipment/inventory -- the arguments for giving\nthe player the Disc, specifically, can ensure either of these two states. See\nthe [Equipment section](#equipment) for more detail.\n\n### Caged Cats\n\nThe caged-cat/mother-lynx puzzle state can be set with the `--cats-free` and\n`--cats-cage` arguments. This can be specified more than once, or you can use\nthe special `all` value to operate on all at the same time:\n\n awsave AnimalWell.sav -s 1 --cats-free all\n awsave AnimalWell.sav -s 1 --cats-cage cat_14_19_1 --cats-cage cat_14_19_2\n\nValid values are: `cat_16_18_1`, `cat_16_18_2`, `cat_16_18_3`, `cat_14_19_1`,\n`cat_14_19_2`, `wheel`, `all`. Note that the `wheel` entry controls whether\nor not the wheel-chest cage is open, in the Mother Lynx's lair. The names of\nthe cat cage values correspond with the room coordinates in which they're found.\n\n### Kangaroo Room\n\nThe room in which the kangaroo next spawns can be set with the `--kangaroo-room`\nargumnent. The rooms are numbered from 0 to 4, and correspond to the following\ncoordinates:\n\n0. (6, 6)\n1. (9, 11)\n2. (12, 11)\n3. (9, 13)\n4. (16, 16)\n\nThe coordinates are set by the numeric index:\n\n awsave AnimalWell.sav -s 1 --kangaroo-room 0\n\nThe kangaroo might not be immediately present when you first enter the room, but\nit will be triggered into its attacking mode (often from offscreen) once you move\naround to the appropriate trigger area. Once in its attacking mode, you can only\nmove one room away from the kangaroo before it despawns and moves on to a\ndifferent room.\n\n### K. Shards\n\nThe state of K. Shard collection can be set with the `--kshard-collect` and\n`--kshard-insert` arguments. Only one can be specified at a time, and they\nset up the data to force a specific count of shards collected (ie: in your\ninventory) or inserted (placed in the circular recess). This will overwrite\nany existing state; if you've collected two shards already and specify that\nyou want 1 inserted, you will be left with a single inserted shard and none\nin your inventory.\n\n awsave AnimalWell.sav -s 1 --kshard-collect 2\n awsave AnimalWell.sav -s 1 --kshard-insert 3\n\n### S. Medal and E. Medal\n\nThe state of the S. Medal and E. Medal insertion can be set with the\n`--s-medal-insert`, `--s-medal-remove`, `--e-medal-insert`, and\n`--e-medal-remove` arguments. Note that removing the medal from the\nrecess does not automatically give you the medal in your inventory; use\nthe inventory management functions for that.\n\n awsave AnimalWell.save -s 1 --s-medal-insert --e-medal-insert\n awsave AnimalWell.save -s 1 --s-medal-remove --e-medal-remove\n\n### Animal Head Teleporters\n\nYou can enable/disable the animal head teleporters using the `--teleport-enable`\nand `--teleport-disable` arguments. The arguments can be specified more than\nonce, and you can use the special `all` value to operate on all at once.\n\n awsave AnimalWell.sav -s 1 --teleport-enable bird --teleport-enable bear\n awsave AnimalWell.sav -s 1 --teleport-disable all\n\nValid values are: `frog`, `fish`, `bear`, `dog`, `bird`, `squirrel`, `hippo`,\n`all`.\n\n### Bunny Mural\n\nThe Bunny Mural state can be set via a few options, though they are all just\nhardcoded images. You can set the mural to its default state, to be entirely\n\"blank\" (ie: just the \"background\" color), or to its solved state. Note that\nthe reward wall will *not* open in the solved state unless you head to the\ncontrol panel and set one pixel. (Though the wall can be opened with other\noptions in the editor.)\n\n awsave AnimalWell.sav -s 1 --mural-default\n awsave AnimalWell.sav -s 1 --mural-clear\n awsave AnimalWell.sav -s 1 --mural-solved\n\n### Mural Import/Export\n\nThe Bunny Mural can be exported and imported in a few different formats. First,\nit can be imported or exported in the \"raw\" format, which is the exact same\nway it's stored in savefiles and game memory. There aren't any public tools that\nI'm aware of at time of writing to edit in this format, but it's available\nregardless. The arguments to use are `--mural-raw-export` and `--mural-raw-import`:\n\n awsave AnimalWell.sav -s 1 --mural-raw-export mural.dat\n awsave AnimalWell.sav -s 1 --mural-raw-import mural.dat\n\nWhen exporting the file, if the filename already exists, you will be prompted\nto overwrite it. To skip the confirmation and always overwrite, specify `-f` or\n`--force`:\n\n awsave AnimalWell.sav -s 1 --mural-raw-export mural.dat -f\n\nAdditionally, the mural can be exported or imported as an image file, **so long as\nthe [Python Imaging Library (Pillow)](https://python-pillow.org/) is installed.**\nIf that library isn't available, these options won't be present.\n\nNote that the file type must support \"indexed\" color. The most common image\nformats which support indexed color are PNG and GIF -- note that JPEG *cannot*\nbe used for this, since that format does not support indexed color. The\narguments to use for this are `--mural-image-export` and\n`--mural-image-import`:\n\n awsave AnimalWell.sav -s 1 --mural-image-export mural.png\n awsave AnimalWell.sav -s 1 --mural-image-import edited.png\n\nAs with the raw export, the utility will prompt for overwriting when necessary,\nunless you also specify `-f` or `--force`:\n\n awsave AnimalWell.sav -s 1 --mural-image-export mural.png -f\n\nNote that imported files *must* be a 40x20 image which uses indexed color, and only\nhas four colors defined in its colormap. It's probably easiest to start with an\nexported file to make sure the image is in the proper format. If any of the colors\nin the image's colormap don't *exactly* match one of the mural's default colors,\nthe import process will do its best to match it to the closest color, but note that\nthis can end up making it look pretty bad. You'll have the best results if the\nsource image uses the exact colors, which are:\n\n1. Black: `#0A1432`\n2. Blue: `#64C8FF`\n3. Red: `#FA6464`\n4. White: `#FFE6C8`\n\n\n\n### Flames\n\nThe four flame states can be set using the `--flame-collect` and `--flame-use`\narguments. Each of those can be specified more than once, or use the special\n`all` value to operate on all at once. `--flame-collect` will merely put the\nflame in your inventory, whereas `--flame-use` will put the flame in its\nrespective pedestal.\n\n awsave AnimalWell.sav -s 1 --flame-collect p --flame-collect g\n awsave AnimalWell.sav -s 1 --flame-use all\n\nValid values are: `b`, `p`, `v`, `g`, `all`.\n\n### Manticores\n\nThe two manticore states can be set using the `--blue-manticore` and\n`--red-manticore` arguments. They just have one of three states: `default`,\n`overworld`, or `space`. Their default state is basically not being\npresent until you get to the Manticore Arena area (or set up the 65th\nEgg). In \"Overworld\" state they will chase you around, and in \"Space\"\nstate they'll be friendly up on Bunny Island.\n\n awsave AnimalWell.sav -s 1 --blue-manticore overworld --red-manticore space\n\n### Teleportation Torus\n\nThe teleportation torus (two rooms right of the house/office) can be\ntoggled on/off with `--torus-enable` and `--torus-disable`:\n\n awsave AnimalWell.sav -s 1 --torus-enable\n awsave AnimalWell.sav -s 1 --torus-disable\n\n### Bosses\n\nThere are several arguments to alter the state of bosses in the game, specifically:\nthe Chameleon, Bat, Ostriches, and Eel/Bonefish. They use the word `defeat`\nto indicate getting rid of the boss, or `respawn` to bring them back:\n\n awsave AnimalWell.sav -s 1 --chameleon-defeat\n awsave AnimalWell.sav -s 1 --chameleon-respawn\n awsave AnimalWell.sav -s 1 --bat-defeat\n awsave AnimalWell.sav -s 1 --bat-respawn\n awsave AnimalWell.sav -s 1 --ostrich-defeat\n awsave AnimalWell.sav -s 1 --ostrich-respawn\n awsave AnimalWell.sav -s 1 --eel-defeat\n awsave AnimalWell.sav -s 1 --eel-respawn\n\nAs always, arguments can be combined into one command:\n\n awsave AnimalWell.sav -s 1 --bat-defeat --chameleon-respawn\n\nFor the Ostriches, note that the same flag controls *both* Ostrich\nbosses -- both the one which pokes at you underground, and the\nwheel-bound one. The ostrich processing will also stop/start the\nostrich-controlled movable platforms as appropriate. If the app\nis told to respawn the ostriches, it will also un-press the purple\nbutton directly underneath the ostrich wheel. That way, the\nostrich won't just immediately become active again when you enter\nthe room again.\n\nFor the Eel/Bonefish, respawning it will put it in its pre-awakened\nstate.\n\nYou can also trigger an action for all four of these bosses at once with\n`--bosses-defeat` or `--bosses-respawn`:\n\n awsave AnimalWell.sav -s 1 --bosses-defeat\n awsave AnimalWell.sav -s 1 --bosses-respawn\n\nNote that specifying either of those will totally override any other boss\ndefeat/respawn arguments you specified.\n\n### Eggs\n\nCollected eggs can be enabled or disabled with the `--egg-enable` and\n`--egg-disable` arguments. The arguments can be specified more than once,\nand the special value `all` can be used to operate on all eggs at once.\n\n awsave AnimalWell.sav -s 1 --egg-enable all\n awsave AnimalWell.sav -s 1 --egg-disable zen --egg-disable ice\n\nNote that this does *not* include the 65th Egg.\n\nValid values are: `reference`, `brown`, `raw`, `pickled`, `big`, `swan`,\n`forbidden`, `shadow`, `vanity`, `service`, `depraved`, `chaos`, `upside_down`,\n`evil`, `sweet`, `chocolate`, `value`, `plant`, `red`, `orange`, `sour`,\n`post_modern`, `universal_basic`, `laissez_faire`, `zen`, `future`,\n`friendship`, `truth`, `transcendental`, `ancient`, `magic`, `mystic`,\n`holiday`, `rain`, `razzle`, `dazzle`, `virtual`, `normal`, `great`,\n`gorgeous`, `planet`, `moon`, `galaxy`, `sunset`, `goodnight`, `dream`,\n`travel`, `promise`, `ice`, `fire`, `bubble`, `desert`, `clover`, `brick`,\n`neon`, `iridescent`, `rust`, `scarlet`, `sapphire`, `ruby`, `jade`,\n`obsidian`, `crystal`, `golden`, `all`.\n\n### Bunnies\n\nCollected bunnies can be enabled or disabled with the `--bunny-enable`\nand `--bunny-disable` arguments. The arguments can be specified more\nthan once, and the special value `all` can be used to operate on all\nbunnies at once.\n\n awsave AnimalWell.sav -s 1 --bunny-enable floor_is_lava --bunny-enable dream\n awsave AnimalWell.sav -s 1 --bunny-disable all\n\nThis argument can't be used to collect the various \"illegal\" bunnies\nhidden around the map (or just in game data).\n\nValid values are: `tutorial`, `origami`, `crow`, `ghost`, `fish_mural`, `map`,\n`tv`, `uv`, `bulb`, `chinchilla`, `bunny_mural`, `duck`, `ghost_dog`, `dream`,\n`floor_is_lava`, `spike_room`, `all`.\n\n#### Illegal Bunnies\n\nThere are several \"illegal\" bunnies on the map which can only be acquired via\ncheating (as with the Cheater's Ring) or via other map glitching techniques.\nCollecting these bunnies will prevent the BDTP puzzle from being solveable, so\nthe `--illegal-bunny-clear` argument will remove them from your slot, in case\nany have been collected:\n\n awsave AnimalWell.sav -s 1 --illegal-bunny-clear\n\n### Respawn Consumables\n\nOrdinarily, fruit and firecrackers only respawn in the game world when you\ndie. The `--respawn-consumables` option will make them all reappear without\nhaving to do so:\n\n awsave AnimalWell.sav -s 1 --respawn-consumables\n\n### Ghosts\n\nLike with consumables, scared ghosts will stay scared until you die, at\nwhich point they will respawn (unless a lit candle is keeping them away).\nThe `--clear-ghosts` and `--respawn-ghosts` arguments can be used to\nfrighten them all off, and cause them to respawn early, respectively:\n\n awsave AnimalWell.sav -s 1 --clear-ghosts\n awsave AnimalWell.sav -s 1 --respawn-ghosts\n\n### Squirrels\n\nFrightened squirrels can be respawned onto the map with the\n`--respawn-squirrels` argument:\n\n awsave AnimalWell.sav -s 1 --respawn-squirrels\n\n### Buttons\n\nAll of the pressable buttons in the game can be pressed or released as\na group using the `--buttons-press` and `--buttons-reset` arguments. This\nwill process yellow (regular), purple (transient), green (machine control),\nand pink (hidden) buttons. For Pink buttons, the utility will *only*\ntoggle \"legitimate\" buttons which the user is expected to be able to find.\nThe \"illegal\" buttons associated with hidden bunnies will *not* be\npressed.\n\n awsave AnimalWell.sav -s 1 --buttons-press\n awsave AnimalWell.sav -s 1 --buttons-reset\n\nNote that resetting buttons will *not* automatically cause their related\ndoors/walls to revert to the closed state. Pressing buttons *will* cause\ndoors/walls to open once you enter the room, though, if they weren't\nalready open.\n\n### Doors / Walls\n\nThere are five categories of openable doors/walls in the game:\n\n1. \"Regular\" doors which are opened via button presses, water reservoirs,\n or other environmental puzzles. These can be toggled with the\n `--doors-open` and `--doors-close` arguments.\n2. \"Lockable\" doors which require a key in your inventory to unlock.\n There are six of these throughout the game map. They can be toggled\n with the `--lockable-unlock` and `--lockable-lock` arguments.\n3. The four doors in the Egg Chamber which ordinarily only open once you\n have collected a minimum number of eggs. These can be toggled with\n the `--eggdoor-open` and `--eggdoor-close` arguments.\n4. Walls which function like doors, most typically encountered via pink\n buttons or other late-game bunny puzzles, etc. These can be toggled\n with the `--walls-open` and `--walls-close` arguments.\n5. Other \"special\" doors like the House/Office/Closet doors, whose states\n are mostly controlled via the [progress/quest options](#progressquests).\n\nFor \"regular\" doors in the game, note that if the buttons/puzzles which\nopened them originally are still pressed/solved, entering the room after\nclosing them will just cause them to re-open again. Regardless, they can\nbe opened/closed like so:\n\n awsave AnimalWell.sav -s 1 --doors-open\n awsave AnimalWell.sav -s 1 --doors-close\n\nLikewise, lockable doors can be opened/closed with:\n\n awsave AnimalWell.sav -s 1 --lockable-unlock\n awsave AnimalWell.sav -s 1 --lockable-lock\n\nEgg Chamber doors work a little differently. Instead of being all-or-nothing,\nthey can be toggled individually, and the special value `all` can be used\nto operate on all at once:\n\n awsave AnimalWell.sav -s 1 --eggdoor-open all\n awsave AnimalWell.sav -s 1 --eggdoor-close first --eggdoor-close third\n\nValid values are: `first`, `second`, `third`, `fourth`, `all`.\n\nMoveable walls can be opened/closde like so:\n\n awsave AnimalWell.sav -s 1 --walls-open\n awsave AnimalWell.sav -s 1 --walls-close\n\nUsing the Cheater's Ring (or any other noclip cheating activity) can\nallow the player to access \"illegal\" pink buttons which can cause extra walls\nto open up in the game. At time of writing, there's a bug in the game where\nopening too many of these can end up causing savefile corruption while in-game,\nso they are best avoided. If you had triggered one or more of these in the\npast, they can be cleaned up with the `--clear-invalid-walls` argument. This\nwill clean up both the moveable-wall entries and the pink button presses as\nwell. Note that this *cannot* fix an already-corrupted save, but it could at\nleast prevent a save from being corrupted after some of those pink buttons were\nalready hit:\n\n awsave AnimalWell.sav -s 1 --clear-invalid-walls\n\nFinally, the doors controlled by \"quest state\" information are the three doors\nrelated to the house: the main house door, office, and closet. These can\nbe opened or closed with the `--house-open` and `--house-close` arguments:\n\n awsave AnimalWell.sav -s 1 --house-open\n awsave AnimalWell.sav -s 1 --house-close\n\n### Chests\n\nAll chests in the game can be opened/closed using the `--chests-open` and\n`--chests-close` arguments. Note that merely opening a chest does *not* provide\nyou with the item that the chest provided!\n\n awsave AnimalWell.sav -s 1 --chests-open\n awsave AnimalWell.sav -s 1 --chests-close\n\n### Candles\n\nCandles throughout the game can be individually lit or blown out using the\n`--candles-enable` and `--candles-disable` arguments. These arguments can be\nspecified more than once, and the special value `all` can be used to operate on\nall candles at once:\n\n awsave AnimalWell.sav -s 1 --candles-enable all\n awsave AnimalWell.sav -s 1 --candles-disable room_06_07 --candles-disable room_10_13\n\nValid values are: `room_04_06`, `room_08_06`, `room_04_07`, `room_06_07`,\n`room_06_09`, `room_15_09`, `room_05_13`, `room_10_13`, `room_16_13`, `all`.\nThe numbers in the value names refer to the room coordinates containing the\ncandle.\n\n### Crank Puzzles\n\nThere are four puzzles in the game which are solved by manipulating cranks/levers:\nthree to fill water reservoirs, and one \"sine wave\" puzzle. The `--solve-cranks`\nargument can be used to set most of those cranks to values which will result in\nthe puzzle being completed. The one exception is the Seahorse Boss room, since\nthe cranks need to be adjusted in realtime to account for the Seahorse position\nand also which reservoir is being filled at the time.\n\n awsave AnimalWell.sav -s 1 --solve-cranks\n\n### Water Reservoirs\n\nThe five water reservoirs in the game can be all filled up or emptied using the\n`--reservoirs-fill` and `--reservoirs-empty` arguments:\n\n awsave AnimalWell.sav -s 1 --reservoirs-fill\n awsave AnimalWell.sav -s 1 --reservoirs-empty\n\n### Detonators\n\nThe various detonators around the map can be triggered or re-armed using the\n`--detonators-activate` and `--detonators-rearm` arguments:\n\n awsave AnimalWell.sav -s 1 --detonators-activate\n awsave AnimalWell.sav -s 1 --detonators-rearm\n\nNote that merely re-arming a detonator will not automatically rebuild the\ndestroyed tiles from the original explosion. To spawn those back in, you can\nuse the `--respawn-destroyed-tiles` argument (see below).\n\n### Destroyed Tiles\n\nTiles in the game can get destroyed in a variety of ways, such as the\nTop/Yoyo, detonators, Manticore laser beams, etc. To respawn all destroyed\ntiles in the map, you can use the `--respawn-destroyed-tiles` argument:\n\n awsave AnimalWell.sav -s 1 --respawn-destroyed-tiles\n\n### Big Stalactites\n\nThe state of all big stalactites can be set with the `--big-stalactites-state`\nargument:\n\n awsave AnimalWell.sav -s 1 --big-stalactites-state floor\n\nValid values are: `intact`, `cracked_once`, `cracked_twice`, `floor`,\n`floor_cracked_once`, `floor_cracked_twice`, and `broken`. Note that all\nbig stalactites will reset to the \"intact\" state upon player death.\n\n### Stalactites / Stalagmites / Icicles\n\nThe small stalactites, stalagmites, and icicles in the game can be cleared or\nrespawned using `--small-deposits-break` or `--small-deposits-respawn`:\n\n awsave AnimalWell.sav -s 1 --small-deposits-break\n awsave AnimalWell.sav -s 1 --small-deposits-respawn\n\nNote that all small deposits respawn naturally upon player death.\n\n### Minimap\n\nThe minimap can be revealed or cleared using the `--reveal-map` and `--clear-map`\narguments:\n\n awsave AnimalWell.sav -s 1 --reveal-map\n awsave AnimalWell.sav -s 1 --clear-map\n\nNote that the fully-revealed map will look different than a \"naturally\"\nfully-revealed minimap, because all of the \"inner\" wall space will be filled\nin. When the game itself reveals the minimap, it stops right at the wall\nboundaries.\n\n### Map Marks\n\nThe user-made marks to the map using the pencil and stamps can be cleared using\nthe `--clear-pencil` and `--clear-stamps` options, respectively:\n\n awsave AnimalWell.sav -s 1 --clear-pencil\n awsave AnimalWell.sav -s 1 --clear-stamps\n\n### Pencil Images\n\n**Note:** These functions require that the [Python Imaging Library\n(Pillow)](https://python-pillow.org/) is installed. If that library isn't\navailable, these options won't be present.\n\nThis utility can import images onto the minimap pencil layer using the\n`--pencil-image-import` argument, and export the current pencil layer\ninto a graphics file using the `--pencil-image-export` argument. When\nimporting, the image will be scaled down to the minimap native resolution with\nno regard to aspect ratio (if needed), and dithered into a monochrome image\n(also if needed). Passing a 1-bit image with the exact correct dimensions\nshould result in importing without any resizing or conversion.\n\nThe minimap technically includes an \"empty\" border around the confines of the\nplayable map area, and by default this pencil-image import will consume that\nentire space, which is 800x528. You can specify the `--pencil-image-playable`\nargument to restrict the import size to the borders of the playable area\ninstead, which is 640x352.\n\n awsave AnimalWell.sav -s 1 --pencil-image-import bunnies.jpg\n awsave AnimalWell.sav -s 1 --pencil-image-import bunnies.jpg --pencil-image-playable\n\n\n\nThe imported image can be inverted by specifying `--pencil-image-invert`, in\ncase your image would look better that way:\n\n awsave AnimalWell.sav -s 1 --pencil-image-import bunnies.jpg --pencil-image-invert\n\nFor exporting to a graphics file, the utility should understand most common\nimage format by its extension, and write the appropriate format:\n\n awsave AnimalWell.sav -s 1 --pencil-image-export output1.jpg\n awsave AnimalWell.sav -s 1 --pencil-image-export output2.png\n\nIf the export file already exists, the utility will prompt you to overwrite. To\nautomatically overwrite without any interactive prompt, use the `-f`/`--force`\noption:\n\n awsave AnimalWell.sav -s 1 --pencil-image-export output.jpg -f\n\nLibrary\n-------\n\nThe data backend should be easily usable on its own, for anyone wishing\nto make programmatic changes, or write other frontends. At the moment\nthe best docs are just browsing through the code. I apologize for my\nfrequent PEP-8 violations, lack of typing hints, and idiosyncratic\ncoding habits, etc.\n\nA quick example of the kinds of things that would be possible:\n\n```py\nfrom animalwellsave.savegame import Savegame, Equipment, Equipped\n\nwith Savegame('AnimalWell.sav') as save:\n slot = save.slots[0]\n print(f'Editing slot {slot.index+1} ({slot.timestamp})...')\n print('Current equipment unlocked:')\n for equip in sorted(slot.equipment.enabled):\n print(f' - {equip}')\n slot.num_steps.value = 15\n slot.equipment.disable(Equipment.DISC)\n slot.equipment.enable(Equipment.WHEEL)\n slot.selected_equipment.value = Equipped.WHEEL\n save.save()\n```\n\nSee also `animalwellsave/cli.py`, which is probably the best place to look for\nexamples of interacting with the data.\n\nThe objects are set up to allow both defining consecutive fields within\nthe savefile (without specifying manual offsets), and also skipping around\nusing manual offsets. When offsets are specified, they are computed relative\nto the \"parent\" object -- so for instance, the absolute offsets used in\nthe `Slot` class are relative to the start of the slot. The fields created\nwhile looping through the file are all subclasses of the base `datafile.Data`\nclass, which will end up computing and storing the *absolute* offset\ninternally. The save data is mirrored in an internal `io.BytesIO` object,\nwhich is where all changes are written. It will not actually write back out\nto disk until a `save()` call has been sent.\n\nThe data objects (subclasses of `datafile.Data`) try to be easy to read, and\ncan be interpreted as strings or in format strings, etc. Subclasses of\n`NumData` can often be used just as if they are numbers, supporting various\nnumerical overloads. Bitfield classes can generally be acted on like\narrays, at least in terms of looping through the options. `NumBitfieldData`\nkeeps an `enabled` set for ease of checking which members are enabled.\n\n*Setting* new data should often be done via the `value` property rather than\nsetting it directly, though -- note in the example above where the `num_steps`\nproperty is being set that way. `value` should also be used if you need an\nactual number, such as if using it in a list index or the like.\n\n`NumChoiceData` objects are used where the value is expected to be one of\na member of an enum. In these objects, `value` will always be the raw numeric\nvalue still, but there's also a `choice` attribute which will correspond to\nthe proper enum item, if possible. The class technically supports setting\nvalues outside the known enum values, in which case `choice` will end up\nbeing `None`. Keep in mind that setting a value for these should still be done\nvia `value` rather than `choice`.\n\nApart from that, as I say, just looking through `cli.py` or the objects\nthemselves would probably be the best way to know how to use 'em.\n\nChangelog\n---------\n\n**v1.2.0** - *Jul 4, 2024*\n - New arguments:\n - `--nuts` is used to set stolen-nut count\n - `--small-deposits-break` and `--small-deposits-respawn` are used to\n manage small stalactites/stalagmites/icicles.\n - `--big-stalactites-state` is used to set all big stalactite states.\n - `--illegal-bunny-clear` will remove any \"illegal\" bunnies from the\n slot. These can otherwise interfere with the BDTP solution. (Illegal\n bunnies can only be acquired via cheating/glitching, as with the Cheater's\n Ring, etc.)\n - Added import/export of the bunny mural, with both \"raw\" and real image\n options, via: `--mural-raw-import`, `--mural-raw-export`,\n `--mural-image-import`, and `--mural-image-export`.\n - Report on status of Space / Bunny Island buttons and CE Temple chest, and\n alter those states when specifying our button and chest arguments.\n - Added in the chest holding the Golden Egg (at 12,19), which was otherwise\n omitted from the chest opening/closing arguments.\n - Fixed a bug which could cause map-feature-activations (press all buttons,\n open all chests, etc) to reset/close items we don't know about. (This had\n been affecting the Golden Egg chest referenced above.)\n - Improve kangaroo state reporting slightly, and set its state to \"Lurking\"\n instead of \"Attacking\" when setting its current room, which should make that\n spawn be more reliable.\n - Exclude Mock Disc from inventory unlocks if the user specifies both\n `--equip-enable all` and `--inventory-enable all` (this can be disabled by\n also using the `--dont-fix-disc-state` argument).\n - Renamed the \"extra\" `PencilImages` optional dependency handling to just\n `Images`\n\n**v1.1.0** - *Jun 6, 2024*\n - Added explicit arguments to set various Quest State flags without having\n to manipulate those flags via the `--quest-state-*` arguments:\n - Added arguments to defeat or respawn the game's bosses. Specifically:\n - Chameleon\n - Bat\n - Ostriches\n - Eel/Bonefish\n - Added `--house-open` and `--house-close` arguments to manage the state of\n the doors around the house.\n - Added arguments to manage S. Medal and E. Medal insertion state.\n - Added `--move-disc-to-shrine` and `--move-disc-to-statue` args, to\n shuffle the Mock Disc between its two homes.\n - Added `--solve-cranks` argument to solve most crank-related puzzles.\n - Info-reporting tweaks:\n - Added `--verbose` option to also show missing items (inventory, eggs, etc)\n on the info output, rather than just the things that *are* present.\n - Added `--debug` output to show data offsets within the savegame\n - Converted info report to use columns for long lists of data, and added a\n `-1`/`--single-column` argument to revert to one item per line.\n - Added lit-candle report\n - Improved K. Shard reporting\n - Removed dash in \"Post Modern\" egg text\n - Reworded the Dog Head Statue description in Quest State\n - Fixed a bug in Mural handling which could have caused some problems for\n hypothetical data reads after the mural.\n - Info added to data model (though not directly accessible via the CLI):\n - Elevator/Platform Data *(Ostrich Boss processing does touch this a bit)*\n - Bunny Mural last-selected-pixel coordinates\n\n**v1.0.0** - *May 31, 2024*\n - Initial release\n\nLicense\n-------\n\n`animalwellsave` is licensed under the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.en.html).\nA copy can be found at [LICENSE.txt](LICENSE.txt).\n\n",
"bugtrack_url": null,
"license": "GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> 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. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> 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 <https://www.gnu.org/licenses/>. 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: <program> Copyright (C) <year> <name of author> 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 <https://www.gnu.org/licenses/>. 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 <https://www.gnu.org/licenses/why-not-lgpl.html>. ",
"summary": "Animal Well CLI Savegame Editor/Library",
"version": "1.2.0",
"project_urls": {
"Issues": "https://github.com/apocalyptech/animalwellsave/issues",
"Repository": "https://github.com/apocalyptech/animalwellsave"
},
"split_keywords": [
"animalwell",
" animal well",
" save editor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6f01f2659ba5376d612115c09865facaa6ea7b079f17e353bf4cd25e3785561c",
"md5": "cb2670f07fc5e99b93d783a04f549da9",
"sha256": "29b97de9286fd78e2144a6a956c0a25a07f77366aa567acd4e4a38f17215f031"
},
"downloads": -1,
"filename": "animalwellsave-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb2670f07fc5e99b93d783a04f549da9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 93488,
"upload_time": "2024-07-04T20:54:53",
"upload_time_iso_8601": "2024-07-04T20:54:53.316807Z",
"url": "https://files.pythonhosted.org/packages/6f/01/f2659ba5376d612115c09865facaa6ea7b079f17e353bf4cd25e3785561c/animalwellsave-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc1d82914eed57c5fdf3b19098a36a508f0c2340704f74d5b1993f88927b12d9",
"md5": "ba091fbaa9e22bce2a27e81a298689c7",
"sha256": "fdeca1b1f4d4847b093e6f83694e571b034bdb24052c10e48e638e29182d9276"
},
"downloads": -1,
"filename": "animalwellsave-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "ba091fbaa9e22bce2a27e81a298689c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 137996,
"upload_time": "2024-07-04T20:54:54",
"upload_time_iso_8601": "2024-07-04T20:54:54.921080Z",
"url": "https://files.pythonhosted.org/packages/dc/1d/82914eed57c5fdf3b19098a36a508f0c2340704f74d5b1993f88927b12d9/animalwellsave-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-04 20:54:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apocalyptech",
"github_project": "animalwellsave",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "animalwellsave"
}
