commit aa26d2934f6ed2c2a910fd186f9161c630aedd73 Author: Joshua Goins Date: Wed Feb 19 19:34:13 2025 -0500 Add initial files diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..54d2545 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +output.bin diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..47b0585 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,168 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "adler2" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "512761e0bb2578dd7380c6baaa0f4ce03e84f95e960231d1dec8bf4d7d6e2627" + +[[package]] +name = "array-init" +version = "2.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d62b7694a562cdf5a74227903507c56ab2cc8bdd1f781ed5cb4cf9c9f810bfc" + +[[package]] +name = "binrw" +version = "0.14.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d4bca59c20d6f40c2cc0802afbe1e788b89096f61bdf7aeea6bf00f10c2909b" +dependencies = [ + "array-init", + "binrw_derive", + "bytemuck", +] + +[[package]] +name = "binrw_derive" +version = "0.14.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d8ba42866ce5bced2645bfa15e97eef2c62d2bdb530510538de8dd3d04efff3c" +dependencies = [ + "either", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "bytemuck" +version = "1.21.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ef657dfab802224e671f5818e9a4935f9b1957ed18e58292690cc39e7a4092a3" + +[[package]] +name = "cc" +version = "1.2.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c3d1b2e905a3a7b00a6141adb0e4c0bb941d11caf55349d863942a1cc44e3c9" +dependencies = [ + "shlex", +] + +[[package]] +name = "cfg-if" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" + +[[package]] +name = "cmake" +version = "0.1.54" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7caa3f9de89ddbe2c607f4101924c5abec803763ae9534e4f4d7d8f84aa81f0" +dependencies = [ + "cc", +] + +[[package]] +name = "crc32fast" +version = "1.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a97769d94ddab943e4510d138150169a2758b5ef3eb191a9ee688de3e23ef7b3" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "either" +version = "1.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "60b1af1c220855b6ceac025d3f6ecdd2b7c4894bfe9cd9bda4fbb4bc7c0d4cf0" + +[[package]] +name = "flate2" +version = "1.0.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c936bfdafb507ebbf50b8074c54fa31c5be9a1e7e5f467dd659697041407d07c" +dependencies = [ + "crc32fast", + "libz-ng-sys", + "miniz_oxide", +] + +[[package]] +name = "ireko" +version = "0.1.0" +dependencies = [ + "binrw", + "flate2", +] + +[[package]] +name = "libc" +version = "0.2.169" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5aba8db14291edd000dfcc4d620c7ebfb122c613afb886ca8803fa4e128a20a" + +[[package]] +name = "libz-ng-sys" +version = "1.1.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7cee1488e961a80d172564fd6fcda11d8a4ac6672c06fe008e9213fa60520c2b" +dependencies = [ + "cmake", + "libc", +] + +[[package]] +name = "miniz_oxide" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b3b1c9bd4fe1f0f8b387f6eb9eb3b4a1aa26185e5750efb9140301703f62cd1b" +dependencies = [ + "adler2", +] + +[[package]] +name = "proc-macro2" +version = "1.0.93" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "60946a68e5f9d28b0dc1c21bb8a97ee7d018a8b322fa57838ba31cc878e22d99" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.38" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0e4dccaaaf89514f546c693ddc140f729f958c247918a13380cccc6078391acc" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "shlex" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" + +[[package]] +name = "syn" +version = "1.0.109" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "unicode-ident" +version = "1.0.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00e2473a93778eb0bad35909dff6a10d28e63f792f16ed15e404fca9d5eeedbe" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..3146190 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,8 @@ +[package] +name = "ireko" +version = "0.1.0" +edition = "2021" + +[dependencies] +flate2 = { version = "1.0", features = ["zlib-ng"], default-features = false } +binrw = { version = "0.14", features = ["std"], default-features = false } diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7bef70b --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# Ireko + +Library for reading save files from [Dolls Nest](https://store.steampowered.com/app/1839430/Dolls_Nest/). Only the demo +is supported because that's what is available at the time of writing. + +**The parser is not yet complete, and can only dump parts of the structured data. The code is also generally terrible because I'm still exploring the format.** + +## Usage + +Pass the `.sav` file you want to read as an argument. Not all `.sav` files are known to work, such as `Level.sav` and `Player.sav`. + +```shell +$ ireko DollsNestDemo/Saved/SaveGames/AR0XJGFWA6HNIQ1AAUJ9UR828/Persistent.sav +Ok( + TaggedSerialization { + size_in_bytes: 135908, + objs: [ + TaggedObject { + size_in_bytes: 135904, + entries: [ + Entry { + name: "SavedDataVersion", + type: Some( + Int( + IntProperty { + integer_size: 4, + value: 0, + }, + ), + ), + }, +... +``` + +## Technical Details + +Dolls Nest uses [the EasyMultiSave plugin](https://www.fab.com/listings/49f745a1-cbdd-4b18-8278-22ae1075d91d), which +saves using the `.sav` file extension. The save data is zlib-compressed, and decompressing them reveals a very similar +tagged structure to GVAS. See more +information [in this blog post](https://redstrate.com/blog/2025/02/reverse-engineering-dolls-nest-demo-saves/). + +## Credits & Thank You + +* [uesave-rs](https://github.com/trumank/uesave-rs) for figuring out the basics of the EasyMultiSave format. + +## License + +![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png) + +This project is licensed under the GNU General Public License 3. diff --git a/src/array_property.rs b/src/array_property.rs new file mode 100644 index 0000000..7573b25 --- /dev/null +++ b/src/array_property.rs @@ -0,0 +1,22 @@ +use crate::set_property::SetEntry; +use binrw::binrw; + +#[binrw] +#[derive(Debug)] +pub struct ArrayProperty { + pub unk: u32, + #[br(temp)] + #[bw(ignore)] + #[br(pad_before = 4)] + pub key_name_length: u32, + #[br(count = key_name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub key_name: String, + + #[br(pad_before = 1)] + pub num_array_entries: u32, + + #[br(count = num_array_entries, args { inner: (&*key_name,) })] + pub entries: Vec, +} diff --git a/src/bin/ireko.rs b/src/bin/ireko.rs new file mode 100644 index 0000000..44deb7f --- /dev/null +++ b/src/bin/ireko.rs @@ -0,0 +1,32 @@ +use binrw::BinRead; +use flate2::bufread::ZlibDecoder; +use flate2::Decompress; +use ireko::{CompressedSaveFile, TaggedSerialization}; +use std::env; +use std::io::{Cursor, Read}; + +fn main() -> Result<(), Box> { + let args: Vec = env::args().collect(); + + let mut data = std::io::Cursor::new(std::fs::read(&args[1])?); + + let compressed = CompressedSaveFile::read_le(&mut data)?; + + let mut output = vec![]; + + let mut uncompressed = vec![0; compressed.a_uncompresed_size as usize]; + + let decompress = Decompress::new(true); + + let mut d = ZlibDecoder::new_with_decompress(&*compressed.compressed_data, decompress); + let size = d.read(&mut *uncompressed)?; + output.extend_from_slice(&uncompressed[..size]); + std::fs::write("output.bin", &output)?; + + let mut cursor = Cursor::new(&uncompressed); + + let save_data = TaggedSerialization::read_le(&mut cursor); + println!("{:#?}", save_data); + + Ok(()) +} diff --git a/src/bool_property.rs b/src/bool_property.rs new file mode 100644 index 0000000..b85c135 --- /dev/null +++ b/src/bool_property.rs @@ -0,0 +1,34 @@ +use crate::read_bool_from; +use binrw::binrw; + +#[binrw] +#[derive(Debug)] +pub struct BoolProperty { + #[br(pad_before = 8, pad_after = 1)] + #[br(map = read_bool_from::)] + #[bw(ignore)] + pub value: bool, +} + +#[cfg(test)] +mod tests { + use super::*; + use binrw::BinRead; + use std::io::Cursor; + + #[test] + fn r#false() { + let data = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]; + let mut cursor = Cursor::new(data); + let decoded = BoolProperty::read_le(&mut cursor).unwrap(); + assert!(!decoded.value); + } + + #[test] + fn r#true() { + let data = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00]; + let mut cursor = Cursor::new(data); + let decoded = BoolProperty::read_le(&mut cursor).unwrap(); + assert!(decoded.value); + } +} diff --git a/src/enum_property.rs b/src/enum_property.rs new file mode 100644 index 0000000..486d7c3 --- /dev/null +++ b/src/enum_property.rs @@ -0,0 +1,7 @@ +use binrw::binrw; + +#[binrw] +#[derive(Debug)] +pub struct EnumProperty { + pub enum_unk: [u8; 9], +} diff --git a/src/float_property.rs b/src/float_property.rs new file mode 100644 index 0000000..7a4f6fc --- /dev/null +++ b/src/float_property.rs @@ -0,0 +1,28 @@ +use binrw::binrw; + +#[binrw] +#[derive(Debug)] +pub struct FloatProperty { + /// Typically 4 for f32 + pub byte_size: u32, + #[br(pad_before = 5)] + pub value: f32, +} + +#[cfg(test)] +mod tests { + use super::*; + use binrw::BinRead; + use std::io::Cursor; + + #[test] + fn value() { + let data = [ + 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x8c, 0x76, 0x9c, 0x45, + ]; + let mut cursor = Cursor::new(data); + let decoded = FloatProperty::read_le(&mut cursor).unwrap(); + assert_eq!(decoded.byte_size, 4); + assert_eq!(decoded.value, 5006.8184); + } +} diff --git a/src/int_property.rs b/src/int_property.rs new file mode 100644 index 0000000..9e7343e --- /dev/null +++ b/src/int_property.rs @@ -0,0 +1,39 @@ +use binrw::binrw; + +#[binrw] +#[derive(Debug)] +pub struct IntProperty { + /// In bytes + pub integer_size: u32, + #[br(pad_before = 5)] + pub value: u32, +} + +#[cfg(test)] +mod tests { + use super::*; + use binrw::BinRead; + use std::io::Cursor; + + #[test] + fn zero() { + let data = [ + 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + ]; + let mut cursor = Cursor::new(data); + let decoded = IntProperty::read_le(&mut cursor).unwrap(); + assert_eq!(decoded.integer_size, 4); + assert_eq!(decoded.value, 0); + } + + #[test] + fn integer() { + let data = [ + 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, + ]; + let mut cursor = Cursor::new(data); + let decoded = IntProperty::read_le(&mut cursor).unwrap(); + assert_eq!(decoded.integer_size, 4); + assert_eq!(decoded.value, 4); + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..d8845f6 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,123 @@ +pub mod array_property; +pub mod bool_property; +pub mod enum_property; +pub mod float_property; +pub mod int_property; +pub mod map_property; +pub mod name_property; +pub mod set_property; +pub mod str_property; +pub mod struct_property; +mod structs; + +use binrw::helpers::{until, until_eof}; + +use crate::array_property::ArrayProperty; +use crate::bool_property::BoolProperty; +use crate::enum_property::EnumProperty; +use crate::float_property::FloatProperty; +use crate::int_property::IntProperty; +use crate::map_property::MapProperty; +use crate::name_property::NameProperty; +use crate::set_property::SetProperty; +use crate::str_property::StrProperty; +use crate::struct_property::StructProperty; +use binrw::binrw; + +pub(crate) fn read_bool_from + std::cmp::PartialEq>(x: T) -> bool { + x == T::from(1u8) +} + +#[binrw] +#[derive(Debug)] +pub enum Property { + #[br(magic = b"IntProperty\0")] + Int(IntProperty), + #[br(magic = b"BoolProperty\0")] + Bool(BoolProperty), + #[br(magic = b"StructProperty\0")] + Struct(StructProperty), + #[br(magic = b"FloatProperty\0")] + Float(FloatProperty), + #[br(magic = b"StrProperty\0")] + String(StrProperty), + #[br(magic = b"NameProperty\0")] + Name(NameProperty), + #[br(magic = b"ArrayProperty\0")] + Array(ArrayProperty), + #[br(magic = b"MapProperty\0")] + Map(MapProperty), + #[br(magic = b"SetProperty\0")] + Set(SetProperty), + #[br(magic = b"EnumProperty\0")] + Enum(EnumProperty), +} + +// Used in ArrayProperty exclusively, but could be used instead of magic above +#[binrw] +#[derive(Debug)] +#[br(import { magic: &str })] +pub enum StringBasedProperty { + #[br(pre_assert("NameProperty" == magic))] + Name(NameProperty), + #[br(pre_assert("StructProperty" == magic))] + Struct(StructProperty), + #[br(pre_assert("FloatProperty" == magic))] + Float(FloatProperty), + #[br(pre_assert("StrProperty" == magic))] + String(StrProperty), + #[br(pre_assert("BoolProperty" == magic))] + Bool(BoolProperty), + #[br(pre_assert("IntProperty" == magic))] + Int(IntProperty), + #[br(pre_assert("MapProperty" == magic))] + Map(MapProperty), +} + +#[binrw] +#[derive(Debug)] +pub struct Entry { + #[br(temp)] + #[bw(ignore)] + pub name_length: u32, + #[br(count = name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub name: String, + #[br(temp)] + #[bw(ignore)] + #[br(if(name != "None"))] + pub type_length: Option, + #[br(if(name != "None"))] + pub r#type: Option, +} + +#[binrw] +#[derive(Debug)] +pub struct TaggedObject { + pub size_in_bytes: u32, + #[br(parse_with = until(|entry: &Entry| entry.name == "None"))] + pub entries: Vec, +} + +#[binrw] +#[derive(Debug)] +pub struct TaggedSerialization { + // Excluding the first four bytes, which is this + pub size_in_bytes: u32, + #[br(parse_with = until_eof)] + pub objs: Vec, +} + +#[binrw] +#[derive(Debug)] +pub struct CompressedSaveFile { + pub magic: u64, + pub compressed_size: u64, + pub a_compresed_size: u64, + pub a_uncompresed_size: u64, + pub b_compresed_size: u64, + pub b_uncompresed_size: u64, + #[br(count = a_compresed_size)] + pub compressed_data: Vec, +} diff --git a/src/map_property.rs b/src/map_property.rs new file mode 100644 index 0000000..b67a86c --- /dev/null +++ b/src/map_property.rs @@ -0,0 +1,265 @@ +use crate::read_bool_from; +use crate::struct_property::Struct; +use crate::structs::PrimaryAssetNameProperty; +use binrw::binrw; +use binrw::helpers::until_exclusive; + +// A struct without a name +#[binrw] +#[derive(Debug)] +pub struct AnonymousStruct { + #[br(parse_with = until_exclusive(|entry: &PrimaryAssetNameProperty| entry.property_name == "None"))] + fields: Vec, +} + +#[binrw] +#[derive(Debug)] +pub struct MapSubStructProperty { + #[br(temp)] + #[bw(ignore)] + pub unk_name_length: u32, + #[br(count = unk_name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub unk_name: String, + + #[br(temp)] + #[bw(ignore)] + pub unk_type_length: u32, + #[br(count = unk_type_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub unk_type: String, + #[br(temp)] + #[bw(ignore)] + #[br(pad_before = 8)] // dunno what this is + pub name_length: u32, + pub r#struct: Struct, +} + +#[binrw] +#[derive(Debug)] +pub struct MapSubFloatProperty { + pub value: f32, +} + +#[binrw] +#[derive(Debug)] +pub struct MapSubNameProperty { + #[br(temp)] + #[bw(ignore)] + pub sub_property_name_length: u32, + #[br(count = sub_property_name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub sub_property_name: String, +} + +#[binrw] +#[derive(Debug)] +pub struct MapSubStrProperty { + #[br(temp)] + #[bw(ignore)] + pub name_length: u32, + #[br(count = name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub name: String, +} + +#[binrw] +#[derive(Debug)] +pub struct MapSubBoolProperty { + #[br(map = read_bool_from::)] + #[bw(ignore)] + pub value: bool, +} + +#[binrw] +#[derive(Debug)] +pub struct MapSubIntProperty { + pub value: u32, +} + +#[binrw] +#[derive(Debug)] +pub struct MapSubEnumProperty { + pub enum_length: u32, + #[br(count = enum_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub r#enum: String, +} + +#[binrw] +#[derive(Debug)] +pub struct GuidStruct { + pub guid: [u8; 16], +} + +// Used in MapProperty exclusively, seems to be a shortened version of some Properties +#[binrw] +#[derive(Debug)] +#[br(import { magic: &str, unk: &UnknownType, is_value: bool })] +pub enum MabSubProperty { + #[br(pre_assert("NameProperty" == magic))] + Name(MapSubNameProperty), + #[br(pre_assert("StructProperty" == magic && *unk == UnknownType::RealStruct))] + Struct(MapSubStructProperty), + #[br(pre_assert("StructProperty" == magic && *unk == UnknownType::AnonymousStruct))] + AnonymousStruct(AnonymousStruct), // assuming all value structs are anonymous for now + #[br(pre_assert("StructProperty" == magic && *unk == UnknownType::Guid || *unk == UnknownType::Guid2))] + GuidStruct(GuidStruct), // assuming all value structs are anonymous for now + #[br(pre_assert("FloatProperty" == magic))] + Float(MapSubFloatProperty), + #[br(pre_assert("StrProperty" == magic))] + String(MapSubStrProperty), + #[br(pre_assert("BoolProperty" == magic))] + Bool(MapSubBoolProperty), + #[br(pre_assert("IntProperty" == magic))] + Int(MapSubIntProperty), + #[br(pre_assert("EnumProperty" == magic))] + Enum(MapSubEnumProperty), +} + +#[binrw] +#[derive(Debug)] +#[br(import(key_type: &str, value_type: &str, key_unk: &UnknownType, value_unk: &UnknownType))] +pub struct MapEntry { + //#[br(pad_before = 8)] + #[br(args { magic: key_type, unk: key_unk, is_value: true})] + pub key: MabSubProperty, + + #[br(args {magic: value_type, unk: value_unk, is_value: true})] + //#[br(if(!key_is_none(&key)))] + pub value: MabSubProperty, +} + +#[binrw] +#[brw(repr = u8)] +#[derive(Debug, PartialEq)] +pub enum UnknownType { + // literally all guesswork, idk + String = 0x0, + Name = 0x31, + Int = 0xBA, + RealStruct = 0x51, + Enum = 0x21, + Guid = 0x45, + IDK = 0x44, + Guid2 = 0x5, + AnonymousStruct = 0xF, +} + +#[binrw] +#[derive(Debug)] +pub struct MapProperty { + /* + pub key_unk: UnknownType, + #[br(pad_after = 2)] // actually might need all 4 bytes? + + pub value_unk: UnknownType,*/ + // Plus this int + pub size_in_bytes: u32, + + #[br(temp)] + #[bw(ignore)] + #[br(pad_before = 4)] + pub key_name_length: u32, + #[br(count = key_name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub key_name: String, + + #[br(temp)] + #[bw(ignore)] + pub value_name_length: u32, + #[br(count = value_name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub value_name: String, + + //#[br(pad_before = 5)] + // + //pub num_map_entries: u32, + #[br(count = size_in_bytes + 1)] + #[br(temp)] + #[bw(ignore)] + pub dummy_data: Vec, + // TODO: uncomment when map parsing reliably works, otherwise just dummy the data out + //#[br(count = num_map_entries, args { inner: (&*key_name, &*value_name, &key_unk, &value_unk) })] + //pub entries: Vec, +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::map_property::MabSubProperty::{Int, Name, String}; + use binrw::BinRead; + use std::io::Cursor; + + #[test] + fn simple_strmap() { + // From LocalProfile.sav i think + let data = [ + 0x31, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0c, 0x00, 0x00, 0x00, 0x53, 0x74, + 0x72, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x00, 0x0c, 0x00, 0x00, 0x00, + 0x53, 0x74, 0x72, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x1a, 0x00, 0x00, 0x00, 0x41, 0x52, 0x30, + 0x58, 0x4a, 0x47, 0x46, 0x57, 0x41, 0x36, 0x48, 0x4e, 0x49, 0x51, 0x31, 0x41, 0x41, + 0x55, 0x4a, 0x39, 0x55, 0x52, 0x38, 0x32, 0x38, 0x00, 0x07, 0x00, 0x00, 0x00, 0x4e, + 0x41, 0x4d, 0x45, 0x20, 0x31, 0x00, + ]; + let mut cursor = Cursor::new(data); + let decoded = MapProperty::read_le(&mut cursor).unwrap(); + assert_eq!(decoded.size_in_bytes, 49); + assert_eq!(decoded.key_name, "StrProperty"); + assert_eq!(decoded.value_name, "StrProperty"); + /*let String(key_property) = &decoded.entries.first().unwrap().key else { + panic!("StrProperty!") + }; + let String(value_property) = &decoded.entries.first().unwrap().value else { + panic!("StrProperty!") + }; + assert_eq!(key_property.name, "AR0XJGFWA6HNIQ1AAUJ9UR828"); + assert_eq!(value_property.name, "NAME 1");*/ + } + + #[test] + fn name_int_map() { + // From Persistent.sav, EventParams + let data = [ + 0xba, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0d, 0x00, 0x00, 0x00, 0x4e, 0x61, + 0x6d, 0x65, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x00, 0x0c, 0x00, 0x00, + 0x00, 0x49, 0x6e, 0x74, 0x50, 0x72, 0x6f, 0x70, 0x65, 0x72, 0x74, 0x79, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x07, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00, 0x00, 0x53, 0x65, + 0x6c, 0x65, 0x63, 0x74, 0x65, 0x64, 0x4d, 0x61, 0x63, 0x68, 0x69, 0x6e, 0x65, 0x00, + 0x02, 0x00, 0x00, 0x00, 0x13, 0x00, 0x00, 0x00, 0x54, 0x75, 0x74, 0x6f, 0x72, 0x69, + 0x61, 0x6c, 0x5f, 0x50, 0x6f, 0x72, 0x74, 0x61, 0x6c, 0x5f, 0x30, 0x32, 0x00, 0x01, + 0x00, 0x00, 0x00, 0x0e, 0x00, 0x00, 0x00, 0x45, 0x76, 0x65, 0x6e, 0x74, 0x59, 0x4f, + 0x5f, 0x66, 0x6c, 0x30, 0x30, 0x33, 0x00, 0x01, 0x00, 0x00, 0x00, 0x11, 0x00, 0x00, + 0x00, 0x4d, 0x30, 0x31, 0x41, 0x30, 0x31, 0x5f, 0x4e, 0x65, 0x78, 0x74, 0x53, 0x74, + 0x61, 0x67, 0x65, 0x00, 0x01, 0x00, 0x00, 0x00, 0x0f, 0x00, 0x00, 0x00, 0x4d, 0x30, + 0x31, 0x41, 0x30, 0x31, 0x5f, 0x47, 0x61, 0x74, 0x65, 0x30, 0x30, 0x31, 0x00, 0x01, + 0x00, 0x00, 0x00, 0x1a, 0x00, 0x00, 0x00, 0x4d, 0x30, 0x31, 0x41, 0x30, 0x31, 0x4d, + 0x6f, 0x6e, 0x6f, 0x72, 0x61, 0x69, 0x6c, 0x30, 0x30, 0x31, 0x54, 0x65, 0x73, 0x74, + 0x30, 0x30, 0x30, 0x31, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0f, 0x00, 0x00, 0x00, 0x4d, + 0x30, 0x31, 0x41, 0x30, 0x31, 0x5f, 0x47, 0x61, 0x74, 0x65, 0x30, 0x30, 0x35, 0x00, + 0x01, 0x00, 0x00, 0x00, + ]; + let mut cursor = Cursor::new(data); + let decoded = MapProperty::read_le(&mut cursor).unwrap(); + assert_eq!(decoded.size_in_bytes, 186); + assert_eq!(decoded.key_name, "NameProperty"); + assert_eq!(decoded.value_name, "IntProperty"); + /*let Name(key_property) = &decoded.entries.first().unwrap().key else { + panic!("Name!") + }; + let Int(value_property) = &decoded.entries.first().unwrap().value else { + panic!("Int!") + }; + assert_eq!(key_property.sub_property_name, "SelectedMachine"); + assert_eq!(value_property.value, 2);*/ + // TODO: test the rest of the values + } +} diff --git a/src/name_property.rs b/src/name_property.rs new file mode 100644 index 0000000..314a10e --- /dev/null +++ b/src/name_property.rs @@ -0,0 +1,14 @@ +use binrw::binrw; + +#[binrw] +#[derive(Debug)] +pub struct NameProperty { + #[br(temp)] + #[bw(ignore)] + #[br(pad_after = 5)] + pub property_name_length: u32, + #[br(count = property_name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub property_name: String, +} diff --git a/src/set_property.rs b/src/set_property.rs new file mode 100644 index 0000000..1988016 --- /dev/null +++ b/src/set_property.rs @@ -0,0 +1,48 @@ +use crate::StringBasedProperty; +use binrw::binrw; + +#[binrw] +#[derive(Debug)] +#[br(import(key_type: &str))] +pub struct SetEntry { + #[br(temp)] + #[bw(ignore)] + pub unk_name_length: u32, + #[br(count = unk_name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub unk_name: String, + + #[br(temp)] + #[bw(ignore)] + pub unk_type_length: u32, + #[br(count = unk_type_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub unk_type: String, + + #[br(args { magic: &unk_type })] + pub key: StringBasedProperty, +} + +#[binrw] +#[derive(Debug)] +pub struct SetProperty { + pub unk: u32, + #[br(temp)] + #[bw(ignore)] + #[br(pad_before = 4)] + pub key_name_length: u32, + #[br(count = key_name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub key_name: String, + + #[br(pad_before = 5)] + pub num_set_entries: u32, + + #[br(count = num_set_entries, args { inner: (&*key_name,) })] + pub entries: Vec, +} + +// TODO: write test diff --git a/src/str_property.rs b/src/str_property.rs new file mode 100644 index 0000000..efb6972 --- /dev/null +++ b/src/str_property.rs @@ -0,0 +1,14 @@ +use binrw::binrw; + +#[binrw] +#[derive(Debug)] +pub struct StrProperty { + #[br(temp)] + #[bw(ignore)] + #[br(pad_after = 5)] + pub name_length: u32, + #[br(count = name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub name: String, +} diff --git a/src/struct_property.rs b/src/struct_property.rs new file mode 100644 index 0000000..b649c03 --- /dev/null +++ b/src/struct_property.rs @@ -0,0 +1,51 @@ +use crate::structs::{ + DAAssembleIdDataStruct, DABuildDataStruct, DACharacterCommonStatusStruct, DALoadOptionStruct, + DAMachineColoringDataStruct, DAModuleColorStruct, DAModuleItemDataStruct, DateTimeStruct, + GuidStruct, LinearColorStruct, ParamsStruct, PrimaryAssetIdStruct, PrimaryAssetTypeStruct, + SaveSlotInfoStruct, +}; +use binrw::binrw; + +#[binrw] +#[derive(Debug)] +pub enum Struct { + #[br(magic = b"DateTime\0")] + DateTime(DateTimeStruct), + #[br(magic = b"DALoadOption\0")] + DALoadOption(DALoadOptionStruct), + #[br(magic = b"SaveSlotInfo\0")] + SaveSlotInfo(SaveSlotInfoStruct), + #[br(magic = b"DACharacterCommonStatus\0")] + DACharacterCommonStatus(DACharacterCommonStatusStruct), + #[br(magic = b"Params\0")] + Params(ParamsStruct), + #[br(magic = b"PrimaryAssetType\0")] + PrimaryAssetType(PrimaryAssetTypeStruct), + #[br(magic = b"PrimaryAssetId\0")] + PrimaryAssetId(PrimaryAssetIdStruct), + #[br(magic = b"DAModuleItemData\0")] + DAModuleItemData(DAModuleItemDataStruct), + #[br(magic = b"DABuildData\0")] + DABuildData(DABuildDataStruct), + #[br(magic = b"DAAssembleIdData\0")] + DAAssembleIdData(DAAssembleIdDataStruct), + #[br(magic = b"Guid\0")] + Guid(GuidStruct), + #[br(magic = b"DAMachineColoringData\0")] + DAMachineColoringData(DAMachineColoringDataStruct), + #[br(magic = b"DAModuleColor\0")] + DAModuleColor(DAModuleColorStruct), + #[br(magic = b"LinearColor\0")] + LinearColor(LinearColorStruct), +} + +#[binrw] +#[derive(Debug)] +pub struct StructProperty { + pub unk: u32, + #[br(temp)] + #[bw(ignore)] + #[br(pad_before = 4)] + pub name_length: u32, + pub r#struct: Struct, +} diff --git a/src/structs.rs b/src/structs.rs new file mode 100644 index 0000000..7a8ffad --- /dev/null +++ b/src/structs.rs @@ -0,0 +1,119 @@ +use crate::{Property, StringBasedProperty}; +use binrw::binrw; + +#[binrw] +#[derive(Debug)] +pub struct DateTimeStruct { + pub unk: [u8; 25], +} + +#[binrw] +#[derive(Debug)] +pub struct DALoadOptionStruct { + pub unk: [u8; 17], +} + +#[binrw] +#[derive(Debug)] +pub struct SaveSlotInfoStruct { + pub unk: [u8; 17], +} + +#[binrw] +#[derive(Debug)] +pub struct DACharacterCommonStatusStruct { + pub unk: [u8; 17], +} + +#[binrw] +#[derive(Debug)] +pub struct ParamsStruct { + pub params_value_type_length: u32, + + pub params_value: Box, +} + +#[binrw] +#[derive(Debug)] +pub struct PrimaryAssetNameProperty { + #[br(temp)] + #[bw(ignore)] + pub property_name_length: u32, + #[br(count = property_name_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + pub property_name: String, + + #[br(temp)] + #[bw(ignore)] + #[br(if(property_name != "None"))] + pub type_length: u32, + #[br(count = type_length)] + #[bw(map = |x : &String | x.as_bytes())] + #[br(map = | x: Vec | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())] + #[br(if(property_name != "None"))] + pub type_name: String, + + #[br(if(property_name != "None"))] + #[br(args { magic: &type_name})] + pub key: Option>, +} + +#[binrw] +#[derive(Debug)] +pub struct PrimaryAssetTypeStruct { + #[br(pad_before = 17)] + name: PrimaryAssetNameProperty, + #[br(pad_before = 9)] // "None" and it's length in bytes plus the null terminator + #[br(pad_after = 9)] // ditto + primary_asset_name: PrimaryAssetNameProperty, +} + +#[binrw] +#[derive(Debug)] +pub struct PrimaryAssetIdStruct { + #[br(pad_before = 17)] + asset: PrimaryAssetNameProperty, +} + +#[binrw] +#[derive(Debug)] +pub struct DAModuleItemDataStruct { + pub unk: [u8; 17], +} + +#[binrw] +#[derive(Debug)] +pub struct DABuildDataStruct { + pub unk: [u8; 17], +} + +#[binrw] +#[derive(Debug)] +pub struct DAAssembleIdDataStruct { + pub unk: [u8; 17], +} + +#[binrw] +#[derive(Debug)] +pub struct GuidStruct { + pub unk: [u8; 33], +} + +#[binrw] +#[derive(Debug)] +pub struct DAMachineColoringDataStruct { + pub unk: [u8; 17], +} + +#[binrw] +#[derive(Debug)] +pub struct DAModuleColorStruct { + pub unk: [u8; 17], +} + +#[binrw] +#[derive(Debug)] +pub struct LinearColorStruct { + pub unk: [u8; 33], +}