diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index c24ff4f..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Renée Kooi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..2fb2e74
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,675 @@
+### GNU GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+### Preamble
+
+The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom
+to share and change all versions of a program--to make sure it remains
+free software for all its users. We, the Free Software Foundation, use
+the GNU General Public License for most of our software; it applies
+also to any other work released this way by its authors. You can apply
+it to your programs, too.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you
+have certain responsibilities if you distribute copies of the
+software, or if you modify it: responsibilities to respect the freedom
+of others.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the
+manufacturer can do so. This is fundamentally incompatible with the
+aim of protecting users' freedom to change the software. The
+systematic pattern of such abuse occurs in the area of products for
+individuals to use, which is precisely where it is most unacceptable.
+Therefore, we have designed this version of the GPL to prohibit the
+practice for those products. If such problems arise substantially in
+other domains, we stand ready to extend this provision to those
+domains in future versions of the GPL, as needed to protect the
+freedom of users.
+
+Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish
+to avoid the special danger that patents applied to a free program
+could make it effectively proprietary. To prevent this, the GPL
+assures that patents cannot be used to render the program non-free.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+### TERMS AND CONDITIONS
+
+#### 0. Definitions.
+
+"This License" refers to version 3 of the GNU General Public License.
+
+"Copyright" also means copyright-like laws that apply to other kinds
+of works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of
+an exact copy. The resulting work is called a "modified version" of
+the earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user
+through a computer network, with no transfer of a copy, is not
+conveying.
+
+An interactive user interface displays "Appropriate Legal Notices" to
+the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+#### 1. Source Code.
+
+The "source code" for a work means the preferred form of the work for
+making modifications to it. "Object code" means any non-source form of
+a work.
+
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users can
+regenerate automatically from other parts of the Corresponding Source.
+
+The Corresponding Source for a work in source code form is that same
+work.
+
+#### 2. Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not convey,
+without conditions so long as your license otherwise remains in force.
+You may convey covered works to others for the sole purpose of having
+them make modifications exclusively for you, or provide you with
+facilities for running those works, provided that you comply with the
+terms of this License in conveying all material for which you do not
+control copyright. Those thus making or running the covered works for
+you must do so exclusively on your behalf, under your direction and
+control, on terms that prohibit them from making any copies of your
+copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under the
+conditions stated below. Sublicensing is not allowed; section 10 makes
+it unnecessary.
+
+#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such
+circumvention is effected by exercising rights under this License with
+respect to the covered work, and you disclaim any intention to limit
+operation or modification of the work as a means of enforcing, against
+the work's users, your or third parties' legal rights to forbid
+circumvention of technological measures.
+
+#### 4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+#### 5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these
+conditions:
+
+- a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+- b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under
+ section 7. This requirement modifies the requirement in section 4
+ to "keep intact all notices".
+- c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+- d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+#### 6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms of
+sections 4 and 5, provided that you also convey the machine-readable
+Corresponding Source under the terms of this License, in one of these
+ways:
+
+- a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+- b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the Corresponding
+ Source from a network server at no charge.
+- c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+- d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+- e) Convey the object code using peer-to-peer transmission,
+ provided you inform other peers where the object code and
+ Corresponding Source of the work are being offered to the general
+ public at no charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal,
+family, or household purposes, or (2) anything designed or sold for
+incorporation into a dwelling. In determining whether a product is a
+consumer product, doubtful cases shall be resolved in favor of
+coverage. For a particular product received by a particular user,
+"normally used" refers to a typical or common use of that class of
+product, regardless of the status of the particular user or of the way
+in which the particular user actually uses, or expects or is expected
+to use, the product. A product is a consumer product regardless of
+whether the product has substantial commercial, industrial or
+non-consumer uses, unless such uses represent the only significant
+mode of use of the product.
+
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to
+install and execute modified versions of a covered work in that User
+Product from a modified version of its Corresponding Source. The
+information must suffice to ensure that the continued functioning of
+the modified object code is in no case prevented or interfered with
+solely because modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or
+updates for a work that has been modified or installed by the
+recipient, or for the User Product in which it has been modified or
+installed. Access to a network may be denied when the modification
+itself materially and adversely affects the operation of the network
+or violates the rules and protocols for communication across the
+network.
+
+Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+#### 7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders
+of that material) supplement the terms of this License with terms:
+
+- a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+- b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+- c) Prohibiting misrepresentation of the origin of that material,
+ or requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+- d) Limiting the use for publicity purposes of names of licensors
+ or authors of the material; or
+- e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+- f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions
+ of it) with contractual assumptions of liability to the recipient,
+ for any liability that these contractual assumptions directly
+ impose on those licensors and authors.
+
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions; the
+above requirements apply either way.
+
+#### 8. Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+#### 9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or run
+a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+#### 10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+#### 11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims owned
+or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is "discriminatory" if it does not include within the
+scope of its coverage, prohibits the exercise of, or is conditioned on
+the non-exercise of one or more of the rights that are specifically
+granted under this License. You may not convey a covered work if you
+are a party to an arrangement with a third party that is in the
+business of distributing software, under which you make payment to the
+third party based on the extent of your activity of conveying the
+work, and under which the third party grants, to any of the parties
+who would receive the covered work from you, a discriminatory patent
+license (a) in connection with copies of the covered work conveyed by
+you (or copies made from those copies), or (b) primarily for and in
+connection with specific products or compilations that contain the
+covered work, unless you entered into that arrangement, or that patent
+license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+#### 12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under
+this License and any other pertinent obligations, then as a
+consequence you may not convey it at all. For example, if you agree to
+terms that obligate you to collect a royalty for further conveying
+from those to whom you convey the Program, the only way you could
+satisfy both those terms and this License would be to refrain entirely
+from conveying the Program.
+
+#### 13. Use with the GNU Affero General Public License.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+#### 14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in
+detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies that a certain numbered version of the GNU General Public
+License "or any later version" applies to it, you have the option of
+following the terms and conditions either of that numbered version or
+of any later version published by the Free Software Foundation. If the
+Program does not specify a version number of the GNU General Public
+License, you may choose any version ever published by the Free
+Software Foundation.
+
+If the Program specifies that a proxy can decide which future versions
+of the GNU General Public License can be used, that proxy's public
+statement of acceptance of a version permanently authorizes you to
+choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+#### 15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+#### 16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+#### 17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+END OF TERMS AND CONDITIONS
+
+### How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively state
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper
+mail.
+
+If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands \`show w' and \`show c' should show the
+appropriate parts of the General Public License. Of course, your
+program's commands might be different; for a GUI interface, you would
+use an "about box".
+
+You should also get your employer (if you work as a programmer) or
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. For more information on this, and how to apply and follow
+the GNU GPL, see .
+
+The GNU General Public License does not permit incorporating your
+program into proprietary programs. If your program is a subroutine
+library, you may consider it more useful to permit linking proprietary
+applications with the library. If this is what you want to do, use the
+GNU Lesser General Public License instead of this License. But first,
+please read .
diff --git a/README.md b/README.md
index b5d256c..b3e2092 100644
--- a/README.md
+++ b/README.md
@@ -57,4 +57,19 @@ In node, returns a plain object with the `data` as a Uint8ClampedArray, the `wid
## License
-[MIT](./LICENSE)
+[GPL-3.0](./LICENSE.md)
+
+Copyright (C) 2018 Renée Kooi
+
+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 .
diff --git a/package.json b/package.json
index 58b477d..8a4472d 100644
--- a/package.json
+++ b/package.json
@@ -4,12 +4,16 @@
"version": "1.1.0",
"author": "René Kooi ",
"dependencies": {
- "awestruct": "^1.0.0"
+ "awestruct": "^1.0.0",
+ "nanoassert": "^1.1.0"
},
"devDependencies": {
"buble": "^0.19.3",
+ "jascpal": "^0.1.4",
+ "pngjs": "^3.3.0",
"rimraf": "^2.6.2",
- "standard": "^10.0.0"
+ "standard": "^10.0.0",
+ "tape": "^4.8.0"
},
"keywords": [
"age of empires",
@@ -18,12 +22,12 @@
"graphics",
"slp"
],
- "license": "MIT",
+ "license": "GPL-3.0",
"main": "lib/SLP.js",
"repository": "goto-bus-stop/genie-slp",
"scripts": {
"build": "rimraf lib && buble src -o lib",
"prepublish": "npm run build",
- "test": "standard src/*.js"
+ "test": "node test && standard src/*.js test/*.js"
}
}
diff --git a/src/SLP.js b/src/SLP.js
index 53e8f0b..b398c2d 100644
--- a/src/SLP.js
+++ b/src/SLP.js
@@ -1,7 +1,6 @@
-const Struct = require('awestruct')
+const assert = require('nanoassert')
const createImageData = require('./createImageData')
-
-const t = Struct.types
+const headerStruct = require('./header')
module.exports = SLP
@@ -32,27 +31,6 @@ const RENDER_OUTLINE = 0x05
const RENDER_FILL = 0x06
const RENDER_PLAYER_FILL = 0x07
-// SLP Header
-let headerStruct = Struct({
- version: t.string(4),
- numFrames: t.int32,
- comment: t.string(24),
-
- frames: t.array('numFrames', Struct({
- cmdTableOffset: t.uint32,
- outlineTableOffset: t.uint32,
- paletteOffset: t.uint32,
- properties: t.uint32,
-
- width: t.int32,
- height: t.int32,
- hotspot: Struct({
- x: t.int32,
- y: t.int32
- })
- }))
-})
-
const getPlayerColor = (pal, idx, player) => pal[idx + 16 * player]
/**
@@ -82,13 +60,13 @@ function SLP (buf) {
* Parses the .SLP header.
*/
SLP.prototype.parseHeader = function () {
- const header = headerStruct(this.buf)
+ const header = headerStruct.decode(this.buf)
this.version = header.version
this.numFrames = header.numFrames
this.comment = header.comment
this.frames = header.frames
- this.bodyOffset = /* header */ 32 + /* frames */ 32 * header.numFrames
+ this.bodyOffset = headerStruct.decode.bytes
}
/**
@@ -128,6 +106,7 @@ SLP.prototype.parseFrame = function (id) {
y++
} else if (lowBits === SLP_COLOR_LIST) {
pxCount = cmd >> 2
+ assert.ok(pxCount > 0, 'genie-slp: found color list of length 0')
while (pxCount--) {
offset++
commands.push({ command: RENDER_COLOR, arg: /* color */ buf[offset] })
diff --git a/src/SLPEncoder.js b/src/SLPEncoder.js
new file mode 100644
index 0000000..f1dec1e
--- /dev/null
+++ b/src/SLPEncoder.js
@@ -0,0 +1,281 @@
+const assert = require('nanoassert')
+const Palette = require('jascpal')
+const headerStruct = require('./header')
+
+module.exports = SLPEncoder
+
+// SLP commands
+const SLP_END_OF_ROW = 0x0f
+const SLP_COLOR_LIST = 0x00
+const SLP_COLOR_LIST_EX = 0x02
+const SLP_COLOR_LIST_PLAYER = 0x06
+const SLP_SKIP = 0x01
+const SLP_SKIP_EX = 0x03
+const SLP_FILL = 0x07
+const SLP_FILL_PLAYER = 0x0a
+const SLP_SHADOW = 0x0b
+const SLP_EXTENDED = 0x0e
+const SLP_EX_OUTLINE1 = 0x40
+const SLP_EX_FILL_OUTLINE1 = 0x50
+const SLP_EX_OUTLINE2 = 0x60
+const SLP_EX_FILL_OUTLINE2 = 0x70
+const SLP_LINE_EMPTY = 0x8000
+
+// Render commands
+const RENDER_NEXTLINE = 0x00
+const RENDER_COLOR = 0x01
+const RENDER_SKIP = 0x02
+const RENDER_PLAYER_COLOR = 0x03
+const RENDER_SHADOW = 0x04
+const RENDER_OUTLINE = 0x05
+const RENDER_FILL = 0x06
+const RENDER_PLAYER_FILL = 0x07
+
+function last (arr) {
+ return arr[arr.length - 1]
+}
+
+function padSlice (str, len, padding = '\0') {
+ str = str.slice(0, len)
+ while (str.length < len) str += padding
+ return str
+}
+
+function detectPalette (data, options = {}) {
+ const mainColors = Object.create(null)
+ for (let i = 0; i < data.length; i += 4) {
+ const idx = String((data[i] << 16) + (data[i + 1] << 8) + data[i + 2])
+ if (!mainColors[idx]) mainColors[idx] = data.slice(0, 3)
+ }
+
+ const palette = Object.keys(mainColors).map((x) => mainColors[x])
+
+ // Pad.
+ while (palette.length < 256) {
+ palette.push([ 0, 0, 0 ])
+ }
+
+ return Palette(palette)
+}
+
+function SLPEncoder (options = {}) {
+ if (!(this instanceof SLPEncoder)) return new SLPEncoder(options)
+
+ if (!options.palette) {
+ throw new Error('SLPEncoder: `palette` option is required')
+ }
+
+ this.version = options.version || '2.0N'
+ this.comment = options.comment || ''
+ this.palette = options.palette
+ this.frames = []
+
+ this.colorIndices = {}
+ for (let i = 0; i < this.palette.length; i++) {
+ const [r, g, b] = this.palette[i]
+ const c = (r << 16) + (g << 8) + b
+ this.colorIndices[c] = i
+ }
+}
+
+SLPEncoder.detectPalette = detectPalette
+
+function pixelsToRenderCommands (palette, { width, height, data }) {
+ const commands = []
+
+ let prevCommand
+ let prevArg
+ function push (command, arg) {
+ prevCommand = command
+ prevArg = arg
+ commands.push({ command, arg })
+ }
+
+ for (let i = 0; i < data.length; i += 4) {
+ if (i > 0 && (i / 4) % width === 0) {
+ push(RENDER_NEXTLINE)
+ }
+ // transparent pixel
+ if (data[i + 3] === 0) {
+ if (prevCommand === RENDER_SKIP) {
+ last(commands).arg++
+ } else {
+ push(RENDER_SKIP, 1)
+ }
+ continue
+ }
+
+ const r = data[i]
+ const g = data[i + 1]
+ const b = data[i + 2]
+ const c = (r << 16) + (g << 8) + b
+ const index = palette[c]
+ if (index === undefined) {
+ throw new Error(`Missing color: [${r} ${g} ${b}] is not in palette`)
+ }
+ if (prevCommand === RENDER_FILL && index === prevArg.color) {
+ prevArg.pxCount++
+ } else if (prevCommand === RENDER_COLOR && index === prevArg) {
+ const prev = commands[commands.length - 2]
+ if (prev.command === RENDER_COLOR && prev.arg === index) {
+ commands.pop()
+ commands.pop()
+ push(RENDER_FILL, {
+ pxCount: 3,
+ color: index
+ })
+ } else {
+ push(RENDER_COLOR, index)
+ }
+ } else {
+ push(RENDER_COLOR, index)
+ }
+ }
+
+ return commands
+}
+
+function renderCommandsToSlpFrame ({ width, height, commands, baseOffset }) {
+ const buffer = Buffer.alloc(
+ (height * 4) + // outlines
+ (height * 4) + // cmd table offsets
+ // space for cmd table. each render command takes at most 2 bytes
+ (commands.length * 2)
+ )
+ const outlines = [
+ { left: 0, right: 0 }
+ ]
+ let offset = (height * 4) + (height * 4)
+ const offsets = [
+ offset
+ ]
+
+ let x = 0
+ let y = 0
+ for (let i = 0; i < commands.length; i++) {
+ const { command, arg } = commands[i]
+ if (command === RENDER_NEXTLINE) {
+ buffer[offset++] = SLP_END_OF_ROW
+ offsets.push(offset)
+ y++
+ x = 0
+ outlines[y] = { left: 0, right: 0 }
+ } else if (command === RENDER_COLOR) {
+ let end = i + 1
+ let pxCount = 1
+ while (x + pxCount < width && commands[end].command === RENDER_COLOR) {
+ end++
+ pxCount++
+ }
+ if (pxCount < 2 ** 6) {
+ buffer[offset++] = SLP_COLOR_LIST | (pxCount << 2)
+ for (; i < end; i++) {
+ buffer[offset++] = commands[i].arg
+ x++
+ }
+ } else {
+ // where N = pxCount, c = command:
+ // 0bNNNNccccNNNNNNNN
+ buffer[offset++] = SLP_COLOR_LIST_EX | ((pxCount & 0x0f00) >> 4)
+ buffer[offset++] = pxCount & 0xff
+ for (; i < end; i++) {
+ buffer[offset++] = commands[i].arg
+ x++
+ }
+ }
+ i--
+ } else if (command === RENDER_FILL) {
+ if (arg.pxCount < 16) {
+ buffer[offset++] = SLP_FILL | (arg.pxCount << 4)
+ } else {
+ buffer[offset++] = SLP_FILL
+ buffer[offset++] = arg.pxCount
+ }
+ buffer[offset++] = arg.color
+ x += arg.pxCount
+ } else if (command === RENDER_SKIP) {
+ if (x === 0) {
+ if (arg === width) {
+ outlines[y].left = SLP_LINE_EMPTY
+ } else {
+ outlines[y].left = arg
+ }
+ } else if (x + arg === width) {
+ outlines[y].right = arg
+ } else if (arg >= 2 ** 8) {
+ buffer[offset++] = SLP_SKIP_EX | ((arg & 0x0f00) >> 4)
+ buffer[offset++] = arg & 0xff
+ } else if (arg >= 2 ** 6) {
+ buffer[offset++] = SLP_SKIP
+ buffer[offset++] = arg
+ } else {
+ buffer[offset++] = SLP_SKIP | (arg << 2)
+ }
+ x += arg
+ }
+ }
+
+ buffer[offset++] = SLP_END_OF_ROW
+
+ // Flush outlines
+ for (let i = 0; i < outlines.length; i++) {
+ buffer.writeUInt16LE(outlines[i].left, i * 4)
+ buffer.writeUInt16LE(outlines[i].right, i * 4 + 2)
+ }
+ for (let i = 0; i < offsets.length; i++) {
+ buffer.writeUInt32LE(baseOffset + offsets[i], (height * 4) + (i * 4))
+ }
+
+ return buffer.slice(0, offset)
+}
+
+SLPEncoder.prototype.addFrame = function ({
+ width,
+ height,
+ data,
+ hotspot = { x: 0, y: 0 }
+}) {
+ const commands = pixelsToRenderCommands(this.colorIndices, { width, height, data })
+
+ this.frames.push({
+ cmdTableOffset: 0,
+ outlineTableOffset: 0,
+ paletteOffset: 0,
+ properties: 0,
+ width,
+ height,
+ hotspot,
+ data,
+ commands
+ })
+
+ return commands
+}
+
+SLPEncoder.prototype.encode = function () {
+ const header = {
+ version: padSlice(this.version, 4),
+ numFrames: this.frames.length,
+ comment: padSlice(this.comment, 24),
+ frames: this.frames
+ }
+
+ let offset = headerStruct.encodingLength(header)
+ const frameBuffers = this.frames.map((frame) => {
+ frame.outlineTableOffset = offset
+ frame.cmdTableOffset = offset + frame.height * 4
+ const buffer = renderCommandsToSlpFrame({
+ width: frame.width,
+ height: frame.height,
+ commands: frame.commands,
+ baseOffset: offset
+ })
+ offset += buffer.length
+ return buffer
+ })
+
+ return Buffer.concat([
+ headerStruct.encode(header),
+ ...frameBuffers
+ ])
+}
diff --git a/src/header.js b/src/header.js
new file mode 100644
index 0000000..ebf5b01
--- /dev/null
+++ b/src/header.js
@@ -0,0 +1,23 @@
+const struct = require('awestruct')
+const t = struct.types
+
+// SLP Header
+module.exports = struct([
+ ['version', t.string(4)],
+ ['numFrames', t.int32],
+ ['comment', t.string(24)],
+
+ ['frames', t.array('numFrames', struct([
+ ['cmdTableOffset', t.uint32],
+ ['outlineTableOffset', t.uint32],
+ ['paletteOffset', t.uint32],
+ ['properties', t.uint32],
+
+ ['width', t.int32],
+ ['height', t.int32],
+ ['hotspot', struct([
+ ['x', t.int32],
+ ['y', t.int32]
+ ])]
+ ]))]
+])
diff --git a/test/archer.js b/test/archer.js
new file mode 100644
index 0000000..87e57c6
--- /dev/null
+++ b/test/archer.js
@@ -0,0 +1,58 @@
+const fs = require('fs')
+const test = require('tape')
+const { PNG } = require('pngjs')
+const Palette = require('jascpal')
+const SLP = require('../src/SLP')
+const SLPEncoder = require('../src/SLPEncoder')
+
+const slpPath = require.resolve('./archer/12.slp')
+const pngPath = require.resolve('./archer/15.png')
+const palPath = require.resolve('./archer/palette.pal')
+
+const slp = SLP(fs.readFileSync(slpPath))
+const palette = Palette(fs.readFileSync(palPath))
+const png = PNG.sync.read(fs.readFileSync(pngPath))
+normalizeTransparentPixels(png.data)
+
+function normalizeTransparentPixels (data) {
+ for (let i = 0; i < data.length; i += 4) {
+ if (data[i] === 0xFF && data[i + 1] === 0xFF && data[i + 2] === 0xFF && data[i + 3] === 0) {
+ data[i] = data[i + 1] = data[i + 2] = 0
+ }
+ }
+}
+
+test('SLP#renderFrame', (t) => {
+ const image = slp.renderFrame(15, palette, { player: 1 })
+
+ t.equal(
+ Buffer.from(image.data).toString('base64'),
+ png.data.toString('base64'),
+ 'rendered frame should be same as comparison png'
+ )
+ t.end()
+})
+
+test('SLPEncoder', (t) => {
+ const enc = SLPEncoder({
+ palette,
+ version: '1.00',
+ comment: 'Generated by genie-slp'
+ })
+ enc.addFrame(png) // `width`, `height`, `data` props
+
+ const slpBuffer = enc.encode()
+ const slp2 = SLP(slpBuffer)
+ slp2.parseHeader()
+
+ t.equal(slp2.comment, 'Generated by genie-slp\0\0')
+
+ const image = slp.renderFrame(15, palette, { player: 1 })
+ const image2 = slp2.renderFrame(0, palette, { player: 1 })
+ t.equal(
+ Buffer.from(image.data).toString('base64'),
+ Buffer.from(image2.data).toString('base64'),
+ 'frame from generated slp should be same as original'
+ )
+ t.end()
+})
diff --git a/test/archer/12.slp b/test/archer/12.slp
new file mode 100755
index 0000000..5aefbc4
Binary files /dev/null and b/test/archer/12.slp differ
diff --git a/test/archer/15.png b/test/archer/15.png
new file mode 100755
index 0000000..bba67d7
Binary files /dev/null and b/test/archer/15.png differ
diff --git a/test/archer/palette.pal b/test/archer/palette.pal
new file mode 100644
index 0000000..b896530
--- /dev/null
+++ b/test/archer/palette.pal
@@ -0,0 +1,259 @@
+JASC-PAL
+0100
+256
+0 0 0
+0 74 161
+0 97 155
+0 74 187
+0 84 176
+0 90 184
+0 110 176
+0 110 187
+180 255 180
+0 98 210
+0 0 0
+47 47 47
+200 216 255
+87 87 87
+37 16 6
+47 26 17
+0 0 82
+0 21 130
+19 49 161
+48 93 182
+74 121 208
+110 166 235
+151 206 255
+205 250 255
+64 43 23
+67 51 27
+70 32 6
+75 57 42
+84 64 43
+87 69 37
+87 57 27
+94 74 48
+65 0 0
+105 11 0
+160 21 0
+230 11 0
+255 0 0
+255 100 100
+255 160 160
+255 220 220
+97 77 67
+103 58 21
+113 75 51
+113 75 13
+115 105 84
+125 97 72
+125 74 0
+129 116 95
+0 0 0
+0 7 0
+0 32 0
+0 59 0
+0 87 0
+0 114 0
+0 141 0
+0 169 0
+134 126 118
+135 64 0
+136 108 79
+144 100 12
+146 125 105
+153 106 55
+159 121 88
+166 74 0
+80 51 26
+140 78 9
+191 123 0
+255 199 0
+255 247 37
+255 255 97
+255 255 166
+255 255 227
+167 135 102
+172 144 115
+175 126 36
+175 151 128
+185 151 146
+186 166 135
+187 84 0
+187 156 125
+110 23 0
+150 36 0
+210 55 0
+255 80 0
+255 130 1
+255 180 21
+255 210 75
+255 235 160
+189 150 111
+191 169 115
+195 174 156
+196 170 146
+196 128 88
+196 166 135
+197 187 176
+204 160 36
+0 16 16
+0 37 41
+0 80 80
+0 120 115
+0 172 150
+38 223 170
+109 252 191
+186 255 222
+206 169 133
+207 105 12
+207 176 156
+228 162 82
+215 186 155
+216 162 121
+217 114 24
+223 234 255
+47 0 46
+79 0 75
+133 12 121
+170 47 155
+211 58 201
+241 108 232
+255 169 255
+255 210 255
+218 156 105
+222 177 136
+225 177 90
+226 195 170
+232 180 120
+235 202 181
+235 216 190
+237 199 165
+28 28 28
+67 67 67
+106 106 106
+145 145 145
+185 185 185
+223 223 223
+247 247 247
+255 255 255
+247 211 191
+248 201 138
+255 206 157
+255 225 201
+255 238 217
+255 226 161
+216 223 255
+255 255 243
+24 24 0
+37 37 17
+27 47 0
+47 57 17
+67 77 7
+77 77 47
+44 77 3
+94 84 53
+95 97 39
+97 97 67
+67 97 29
+106 115 57
+116 115 75
+87 116 7
+118 130 65
+130 136 77
+138 139 87
+148 155 100
+156 156 139
+128 157 84
+149 166 97
+175 165 106
+176 176 159
+146 176 67
+194 190 148
+165 196 108
+166 196 77
+206 187 128
+206 204 155
+204 217 77
+221 218 166
+196 226 116
+243 170 92
+3 28 0
+7 38 0
+7 47 7
+19 48 0
+27 57 17
+47 57 47
+28 62 0
+14 68 14
+41 69 28
+33 73 18
+47 87 47
+77 97 57
+67 97 67
+87 116 77
+70 119 48
+189 209 253
+106 136 97
+196 236 166
+23 53 33
+43 84 64
+37 116 57
+23 43 53
+2 33 53
+2 23 53
+33 64 64
+0 34 97
+0 51 115
+43 64 74
+0 43 74
+4 6 9
+0 123 189
+64 84 84
+0 115 207
+23 23 74
+12 23 64
+255 177 98
+0 64 125
+2 23 84
+0 138 186
+64 105 105
+0 146 197
+94 105 105
+0 74 125
+0 125 207
+95 133 65
+84 115 125
+64 105 125
+0 64 146
+0 53 135
+115 156 156
+84 146 176
+146 176 187
+255 201 121
+105 166 197
+125 197 217
+156 197 217
+109 126 33
+113 153 36
+21 118 21
+51 151 39
+70 181 59
+89 223 89
+131 245 120
+152 192 240
+0 255 0
+0 0 255
+255 255 0
+255 217 0
+240 240 255
+240 247 255
+247 247 255
+247 255 255
+85 119 52
+129 151 49
+0 255 255
+255 0 255
+0 139 210
+0 160 243
+255 255 255
diff --git a/test/index.js b/test/index.js
new file mode 100644
index 0000000..f3cff3c
--- /dev/null
+++ b/test/index.js
@@ -0,0 +1,2 @@
+require('./archer')
+require('./screen')
diff --git a/test/screen.js b/test/screen.js
new file mode 100644
index 0000000..043ff2d
--- /dev/null
+++ b/test/screen.js
@@ -0,0 +1,58 @@
+const fs = require('fs')
+const test = require('tape')
+const { PNG } = require('pngjs')
+const Palette = require('jascpal')
+const SLP = require('../src/SLP')
+const SLPEncoder = require('../src/SLPEncoder')
+
+const slpPath = require.resolve('./screen/50102.slp')
+const pngPath = require.resolve('./screen/0.png')
+const palPath = require.resolve('./screen/palette.pal')
+
+const slp = SLP(fs.readFileSync(slpPath))
+const palette = Palette(fs.readFileSync(palPath))
+const png = PNG.sync.read(fs.readFileSync(pngPath))
+normalizeTransparentPixels(png.data)
+
+function normalizeTransparentPixels (data) {
+ for (let i = 0; i < data.length; i += 4) {
+ if (data[i] === 0xFF && data[i + 1] === 0xFF && data[i + 2] === 0xFF && data[i + 3] === 0) {
+ data[i] = data[i + 1] = data[i + 2] = 0
+ }
+ }
+}
+
+test('SLP#renderFrame', (t) => {
+ const image = slp.renderFrame(0, palette)
+
+ t.equal(
+ Buffer.from(image.data).toString('base64'),
+ png.data.toString('base64'),
+ 'rendered frame should be same as comparison png'
+ )
+ t.end()
+})
+
+test('SLPEncoder', (t) => {
+ const enc = SLPEncoder({
+ palette,
+ version: '1.00',
+ comment: 'Generated by genie-slp'
+ })
+ enc.addFrame(png) // `width`, `height`, `data` props
+
+ const slpBuffer = enc.encode()
+ const slp2 = SLP(slpBuffer)
+ slp2.parseHeader()
+
+ t.equal(slp2.comment, 'Generated by genie-slp\0\0')
+
+ const image = slp.renderFrame(0, palette)
+ const image2 = slp2.renderFrame(0, palette)
+ t.equal(
+ Buffer.from(image.data).toString('base64'),
+ Buffer.from(image2.data).toString('base64'),
+ 'frame from generated slp should be same as original'
+ )
+ t.end()
+})
diff --git a/test/screen/0.png b/test/screen/0.png
new file mode 100644
index 0000000..ac8c714
Binary files /dev/null and b/test/screen/0.png differ
diff --git a/test/screen/50102.slp b/test/screen/50102.slp
new file mode 100644
index 0000000..a6816da
Binary files /dev/null and b/test/screen/50102.slp differ
diff --git a/test/screen/palette.pal b/test/screen/palette.pal
new file mode 100644
index 0000000..d598c7a
--- /dev/null
+++ b/test/screen/palette.pal
@@ -0,0 +1,259 @@
+JASC-PAL
+0100
+256
+0 0 0
+128 0 0
+0 128 0
+128 128 0
+0 0 128
+128 0 128
+0 128 128
+192 192 192
+192 220 192
+166 202 240
+16 15 12
+24 26 42
+30 32 27
+28 33 40
+37 27 16
+41 30 34
+49 40 23
+52 49 43
+14 15 79
+12 12 111
+21 40 73
+34 29 125
+49 51 71
+53 56 106
+61 65 53
+9 72 117
+59 69 69
+58 64 118
+58 99 94
+56 111 109
+75 25 16
+75 50 24
+70 58 42
+108 22 17
+102 50 27
+105 57 35
+69 61 66
+73 62 112
+112 21 89
+113 21 116
+111 53 71
+86 68 26
+81 71 49
+87 102 57
+108 76 27
+111 79 46
+119 103 22
+115 101 52
+81 77 72
+83 85 110
+88 102 81
+84 110 106
+106 86 72
+101 92 98
+113 103 76
+114 109 105
+14 14 145
+18 18 177
+47 45 148
+46 46 175
+19 19 207
+21 21 238
+23 32 212
+20 42 241
+44 44 210
+48 48 248
+8 88 142
+8 109 169
+55 67 227
+70 19 135
+64 62 195
+76 59 243
+113 52 232
+80 84 135
+79 80 175
+108 93 137
+99 76 183
+118 118 135
+112 111 181
+80 80 206
+79 79 252
+89 100 244
+111 111 206
+111 112 252
+121 132 53
+89 129 122
+118 139 78
+115 141 109
+11 157 244
+6 182 254
+33 188 255
+9 200 255
+43 204 255
+88 137 136
+108 146 141
+120 168 150
+116 176 171
+68 164 219
+123 136 255
+82 228 255
+123 195 193
+101 228 255
+145 17 17
+134 31 62
+141 43 23
+144 50 45
+175 19 19
+167 40 25
+175 48 46
+143 17 118
+141 59 84
+155 61 99
+172 60 68
+164 63 112
+133 89 29
+137 89 50
+142 109 22
+150 102 56
+178 72 22
+176 73 54
+166 120 19
+163 109 58
+136 89 69
+152 71 101
+145 110 75
+139 119 105
+176 75 75
+176 78 113
+170 118 70
+169 122 100
+204 22 22
+213 18 35
+209 48 28
+208 45 44
+244 23 23
+253 28 33
+238 44 28
+249 49 48
+255 62 69
+205 75 22
+210 71 55
+195 117 43
+250 79 54
+254 101 58
+208 79 78
+193 86 123
+200 115 84
+206 106 107
+251 80 78
+252 92 98
+253 107 81
+253 111 110
+142 57 209
+134 124 131
+185 82 131
+178 64 173
+159 90 228
+202 90 134
+214 81 171
+202 110 136
+255 123 134
+255 104 164
+147 136 23
+149 136 49
+147 164 61
+174 143 21
+175 140 49
+180 168 21
+181 172 53
+146 135 82
+148 136 112
+146 163 84
+147 170 112
+184 136 81
+175 142 111
+182 172 74
+179 168 112
+186 194 74
+171 194 123
+201 151 19
+203 144 46
+202 180 23
+205 173 53
+230 154 49
+229 177 19
+247 175 54
+197 148 90
+203 156 99
+206 175 78
+213 167 109
+243 144 83
+236 149 108
+229 184 78
+228 180 121
+215 202 21
+214 200 47
+230 216 20
+245 205 52
+251 248 22
+253 247 44
+210 204 80
+214 199 116
+221 224 81
+242 210 78
+245 204 115
+250 241 83
+254 248 109
+147 142 138
+144 142 170
+146 174 143
+141 182 171
+173 152 135
+181 167 144
+181 177 172
+156 156 251
+147 197 182
+174 199 146
+176 206 175
+151 207 195
+146 250 255
+174 215 202
+184 227 214
+180 247 246
+198 155 132
+211 176 143
+206 184 165
+254 141 140
+248 152 160
+233 186 138
+245 178 169
+195 191 237
+213 198 145
+215 198 173
+197 224 175
+249 204 146
+245 208 168
+254 236 148
+254 240 168
+207 208 207
+208 208 250
+199 231 214
+205 243 234
+242 215 198
+252 237 205
+248 248 246
+99 27 160
+255 251 240
+160 160 164
+128 128 128
+255 0 0
+0 255 0
+255 255 0
+0 0 255
+0 255 0
+0 255 255
+255 0 255