Update Readme

LICENSE

@@ -1,235 +1,373 @@
-GNU AFFERO GENERAL PUBLIC LICENSE
+Mozilla Public License Version 2.0
-Version 3, 19 November 2007
+==================================
 
-Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+1. Definitions
+--------------
 
-Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
 
-                            Preamble
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
 
-The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
 
-The licenses for most software and other practical works are designed to take away your freedom to share and change the works.  By contrast, our General Public Licenses are 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.
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
 
-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.
+1.5. "Incompatible With Secondary Licenses"
+    means
 
-Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
 
-A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate.  Many developers of free software are heartened and encouraged by the resulting cooperation.  However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
 
-The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community.  It requires the operator of a network server to provide the source code of the modified version running there to the users of that server.  Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
 
-An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals.  This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
 
-The precise terms and conditions for copying, distribution and modification follow.
+1.8. "License"
+    means this document.
 
-                       TERMS AND CONDITIONS
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
 
-0. Definitions.
+1.10. "Modifications"
+    means any of the following:
 
-"This License" refers to version 3 of the GNU Affero General Public License.
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
 
-"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
 
-"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.
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
 
-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.
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
 
-A "covered work" means either the unmodified Program or a work based on the Program.
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
 
-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.
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
 
-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.
+2. License Grants and Conditions
+--------------------------------
 
-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.
+2.1. Grants
 
-1. Source Code.
+Each Contributor hereby grants You a world-wide, royalty-free,
-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.
+non-exclusive license:
 
-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.
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
 
-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.
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
 
-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
+2.2. Effective Date
-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 licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
 
-The Corresponding Source for a work in source code form is that same work.
+2.3. Limitations on Grant Scope
 
-2. Basic Permissions.
+The licenses granted in this Section 2 are the only rights granted under
-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.
+this License. No additional rights or licenses will be implied from the
-
+distribution or licensing of Covered Software under this License.
-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.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
-
+Contributor:
-Conveying under any other circumstances is permitted solely under the conditions stated below.  Sublicensing is not allowed; section 10 makes it unnecessary.
+
-
+(a) for any code that a Contributor has removed from Covered Software;
-3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+    or
-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.
+
-
+(b) for infringements caused by: (i) Your and any other third party's
-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.
+    modifications of Covered Software, or (ii) the combination of its
-
+    Contributions with other software (except as part of its Contributor
-4. Conveying Verbatim Copies.
+    Version); or
-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.
+
-
+(c) under Patent Claims infringed by Covered Software in the absence of
-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.
+    its Contributions.
-
+
-5. Conveying Modified Source Versions.
+This License does not grant any rights in the trademarks, service marks,
-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:
+or logos of any Contributor (except as may be necessary to comply with
-
+the notice requirements in Section 3.4).
-    a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
+
-
+2.4. Subsequent Licenses
-    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".
+
-
+No Contributor makes additional grants as a result of Your choice to
-    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.
+distribute the Covered Software under a subsequent version of this
-
+License (see Section 10.2) or under the terms of a Secondary License (if
-    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.
+permitted under the terms of Section 3.3).
-
+
-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.
+2.5. Representation
-
+
-6. Conveying Non-Source Forms.
+Each Contributor represents that the Contributor believes its
-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:
+Contributions are its original creation(s) or it has sufficient rights
-
+to grant the rights to its Contributions conveyed by this License.
-    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.
+
-
+2.6. Fair Use
-    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.
+
-
+This License is not intended to limit any rights You have under
-    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.
+applicable copyright doctrines of fair use, fair dealing, or other
-
+equivalents.
-    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.
+
-
+2.7. Conditions
-    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.
+
-
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
-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.
+in Section 2.1.
-
+
-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.
+3. Responsibilities
-
+-------------------
-"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.
+
-
+3.1. Distribution of Source Form
-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).
+
-
+All distribution of Covered Software in Source Code Form, including any
-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.
+Modifications that You create or to which You contribute, must be under
-
+the terms of this License. You must inform recipients that the Source
-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.
+Code Form of the Covered Software is governed by the terms of this
-
+License, and how they can obtain a copy of this License. You may not
-7. Additional Terms.
+attempt to alter or restrict the recipients' rights in the Source Code
-"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.
+Form.
-
+
-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.
+3.2. Distribution of Executable Form
-
+
-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:
+If You distribute Covered Software in Executable Form then:
-
+
-    a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
+(a) such Covered Software must also be made available in Source Code
-
+    Form, as described in Section 3.1, and You must inform recipients of
-    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
+    the Executable Form how they can obtain a copy of such Source Code
-
+    Form by reasonable means in a timely manner, at a charge no more
-    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
+    than the cost of distribution to the recipient; and
-
+
-    d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
+(b) You may distribute such Executable Form under the terms of this
-
+    License, or sublicense it under different terms, provided that the
-    e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
+    license for the Executable Form does not attempt to limit or alter
-
+    the recipients' rights in the Source Code Form under this License.
-    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.
+
-
+3.3. Distribution of a Larger Work
-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.
+
-
+You may create and distribute a Larger Work under terms of Your choice,
-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.
+provided that You also comply with the requirements of this License for
-
+the Covered Software. If the Larger Work is a combination of Covered
-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.
+Software with a work governed by one or more Secondary Licenses, and the
-
+Covered Software is not Incompatible With Secondary Licenses, this
-8. Termination.
+License permits You to additionally distribute such Covered Software
-
+under the terms of such Secondary License(s), so that the recipient of
-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).
+the Larger Work may, at their option, further distribute the Covered
-
+Software under the terms of either this License or such Secondary
-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.
+License(s).
-
+
-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.
+3.4. Notices
-
+
-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.
+You may not remove or alter the substance of any license notices
-
+(including copyright notices, patent notices, disclaimers of warranty,
-9. Acceptance Not Required for Having Copies.
+or limitations of liability) contained within the Source Code Form of
-
+the Covered Software, except that You may alter any license notices to
-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.
+the extent required to remedy known factual inaccuracies.
-
+
-10. Automatic Licensing of Downstream Recipients.
+3.5. Application of Additional Terms
-
+
-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.
+You may choose to offer, and to charge a fee for, warranty, support,
-
+indemnity or liability obligations to one or more recipients of Covered
-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.
+Software. However, You may do so only on Your own behalf, and not on
-
+behalf of any Contributor. You must make it absolutely clear that any
-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.
+such warranty, support, indemnity, or liability obligation is offered by
-
+You alone, and You hereby agree to indemnify every Contributor for any
-11. Patents.
+liability incurred by such Contributor as a result of warranty, support,
-
+indemnity or liability terms You offer. You may include additional
-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".
+disclaimers of warranty and limitations of liability specific to any
-
+jurisdiction.
-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.
+
-
+4. Inability to Comply Due to Statute or Regulation
-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 it is impossible for You to comply with any of the terms of this
-
+License with respect to some or all of the Covered Software due to
-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
+statute, judicial order, or regulation then You must: (a) comply with
-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.
+the terms of this License to the maximum extent possible; and (b)
-
+describe the limitations and the code they affect. Such description must
-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.
+be placed in a text file included with all distributions of the Covered
-
+Software under this License. Except to the extent prohibited by statute
-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.
+or regulation, such description must be sufficiently detailed for a
-
+recipient of ordinary skill to be able to understand it.
-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.
+
-
+5. Termination
-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
+5.1. The rights granted under this License will terminate automatically
-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.
+if You fail to comply with any of its terms. However, if You become
-
+compliant, then the rights granted under this License from a particular
-13. Remote Network Interaction; Use with the GNU General Public License.
+Contributor are reinstated (a) provisionally, unless and until such
-
+Contributor explicitly and finally terminates Your grants, and (b) on an
-Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software.  This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.
+ongoing basis, if such Contributor fails to notify You of the
-
+non-compliance by some reasonable means prior to 60 days after You have
-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 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 work with which it is combined will remain governed by version 3 of the GNU General Public License.
+come back into compliance. Moreover, Your grants from a particular
-
+Contributor are reinstated on an ongoing basis if such Contributor
-14. Revised Versions of this License.
+notifies You of the non-compliance by some reasonable means, this is the
-
+first time You have received notice of non-compliance with this License
-The Free Software Foundation may publish revised and/or new versions of the GNU Affero 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.
+from such Contributor, and You become compliant prior to 30 days after
-
+Your receipt of the notice.
-Each version is given a distinguishing version number.  If the Program specifies that a certain numbered version of the GNU Affero 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 Affero General Public License, you may choose any version ever published by the Free Software Foundation.
+
-
+5.2. If You initiate litigation against any entity by asserting a patent
-If the Program specifies that a proxy can decide which future versions of the GNU Affero 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.
+infringement claim (excluding declaratory judgment actions,
-
+counter-claims, and cross-claims) alleging that a Contributor Version
-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.
+directly or indirectly infringes any patent, then the rights granted to
-
+You by any and all Contributors for the Covered Software under Section
-15. Disclaimer of Warranty.
+2.1 of this License shall terminate.
-
+
-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.
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
-
+end user license agreements (excluding distributors and resellers) which
-16. Limitation of Liability.
+have been validly granted by You or Your distributors under this License
-
+prior to termination shall survive termination.
-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.
+*                                                                      *
-
+*  6. Disclaimer of Warranty                                           *
-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
+*  Covered Software is provided under this License on an "as is"       *
-
+*  basis, without warranty of any kind, either expressed, implied, or  *
-            How to Apply These Terms to Your New Programs
+*  statutory, including, without limitation, warranties that the       *
-
+*  Covered Software is free of defects, merchantable, fit for a        *
-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.
+*  particular purpose or non-infringing. The entire risk as to the     *
-
+*  quality and performance of the Covered Software is with You.        *
-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.
+*  Should any Covered Software prove defective in any respect, You     *
-
+*  (not any Contributor) assume the cost of any necessary servicing,   *
-     SGTools
+*  repair, or correction. This disclaimer of warranty constitutes an   *
-     Copyright (C) 2024  QRouland
+*  essential part of this License. No use of any Covered Software is   *
-
+*  authorized under this License except under this disclaimer.         *
-     This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
-
+************************************************************************
-     You should have received a copy of the GNU Affero General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*                                                                      *
-
+*  7. Limitation of Liability                                          *
-Also add information on how to contact you by electronic and paper mail.
+*  --------------------------                                          *
-
+*                                                                      *
-If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source.  For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code.  There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.
+*  Under no circumstances and under no legal theory, whether tort      *
-
+*  (including negligence), contract, or otherwise, shall any           *
-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 AGPL, see <http://www.gnu.org/licenses/>.
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

README.md

@@ -1,13 +1,13 @@
-[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
+[![License: MPL 2.0](https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
 
 # SGTool
 
-SGTool is a library and tool for analyze of the replay of the Stormgate game. 
+SGTool is a WIP library and tool for analyze of the replay of the Stormgate game. 
 
 
 # Acknowledgement
 
-[shroudstone](https://github.com/acarapetis/shroudstone) : A project with similar goal wrote in python. We thank them for part of the reverse engineering notabally the protobuf schema also used this project.
+[shroudstone](https://github.com/acarapetis/shroudstone) : A project with similar goal wrote in python. We thank them notabally for part of the reverse engineering of the protobuf schema.
 
 # Disclamer
 

src/lib.rs

@@ -1,4 +1,13 @@
-#[macro_use] extern crate log;
+#![warn(missing_docs)]
-
+//! sgtool is a library for analyze of the replay of the Stormgate game.
+//!
+//! 
+//! # Example
+//! ```
+//! let replay_path = "replay.SGReplay";
+//! let mut buffer : Vec<u8> = vec![]; 
+//! let replay : Replay = Replay::load_file(replay_path, &mut buffer)?;
+//! ```
+//! 
 pub mod parser;
 mod protos;

src/main.rs

@@ -1,3 +1,11 @@
+//! sgtool is a tool for analyze of the replay of the Stormgate game.
+//!
+//! 
+//! # Example
+//! ```
+//! sgtool -i replays/replay.SGReplay
+//! ```
+
 extern crate pretty_env_logger;
 #[macro_use] extern crate log;
 

src/parser.rs

@@ -1,3 +1,13 @@
+//! A parser for Stormgate Replay.
+//!
+//! 
+//! # Example
+//! ```
+//! let replay_path = "replay.SGReplay";
+//! let mut buffer : Vec<u8> = vec![]; 
+//! let replay : Replay = Replay::load_file(replay_path, &mut buffer)?;
+//! ```
+
 use std::{fs::OpenOptions, io::{BufRead, BufReader, Read}, path::Path};
 use byteorder::{ByteOrder, LittleEndian};
 use flate2::bufread::GzDecoder;
@@ -6,7 +16,8 @@ use quick_protobuf::BytesReader;
 use crate::protos::stormgate::ReplayChunk;
 
 /// Stormgate Replay Header.
-/// It consists of 16 bytes at the top of the replay
+//
+// It consists of 16 bytes at the top of the replay
 #[derive(Debug, Clone)]
 pub struct Header {
     h1: u32, // 12 first bytes repsentation are unknown at the moment
@@ -14,20 +25,22 @@ pub struct Header {
 }
 
 /// Stormgate Replay Payload.
-/// After the the 16 bytes header, the actual payload of the replay of Protobuf messages that are gzipped
+///
-/// Each Protobuf messages represents events that appended in the game from the differetns clients
+// After the the 16 bytes header, the actual payload of the replay of Protobuf messages that are gzipped
+// Each Protobuf messages represents events that appended in the game from the differetns clients
 #[derive(Debug, Clone)]
 pub struct Payload<'a> {
     chunks: Vec<ReplayChunk<'a>>,
 }
 
-/// Stormgate replay
+/// Stormgate Replay.
 #[derive(Debug, Clone)]
 pub struct Replay<'a> {
     header: Header, // header of the replay
     payload: Payload<'a>, // the content of a replay is set of messages
 }
 
+/// Load n bytes into a buffer.
 fn load_part<'a, R: Read>(reader: &'a mut R) -> impl FnMut(usize) -> Result<Vec<u8>, std::io::Error> + 'a {
     move |size| {
         let mut buf = vec![0u8; size];
@@ -37,7 +50,7 @@ fn load_part<'a, R: Read>(reader: &'a mut R) -> impl FnMut(usize) -> Result<Vec<
 }
 
 impl Header {
-    /// 
+    /// Load the 16 bytes as a `Header`.
     fn load<T: BufRead>(reader: &mut T) -> Result<Header, std::io::Error> {
         let mut load = load_part(reader);
         let h1 = LittleEndian::read_u32(&load(12)?);
@@ -47,6 +60,7 @@ impl Header {
 }
 
 impl<'a> Payload<'a> {
+    /// Load the replay content as a `Payload`.
     fn load<T: BufRead>(buf_reader: &mut T, buf: &'a mut Vec<u8>) -> Result<Payload<'a>, Box<dyn std::error::Error>> {
         let mut d = GzDecoder::new(buf_reader);
         d.read_to_end(buf)?;
@@ -65,6 +79,7 @@ impl<'a> Payload<'a> {
 
 
 impl<'a> Replay<'a> {
+    
     fn load<T: BufRead>(buf_reader: &mut T, buf: &'a mut Vec<u8>) -> Result<Replay<'a>, Box<dyn std::error::Error>> {
         // Get Header
         let header = Header::load(buf_reader)?;
@@ -75,6 +90,18 @@ impl<'a> Replay<'a> {
         Ok(Replay { header, payload: data })
     }
 
+    /// Load a replay file as `Replay`.
+    /// 
+    /// # Arguments
+    /// * `path` : Path of the storgmate replay file.
+    /// * `buf` : Byte Buffer use by the parser.
+    /// 
+    /// # Example
+    /// ```
+    /// let replay_path = "replay.SGReplay";
+    /// let mut buffer : Vec<u8> = vec![]; 
+    /// let replay : Replay = Replay::load_file(replay_path, &mut buffer)?;
+    /// ```
     pub fn load_file(path: &Path, buf: &'a mut Vec<u8>) -> Result<Replay<'a>, Box<dyn std::error::Error>> {
         let file = OpenOptions::new().read(true).open(path).unwrap();
         let mut buf_reader = BufReader::new(file);
@@ -90,7 +117,7 @@ mod tests {
     #[test]
     fn load_file() {
         // Replay used is form Alpha phase of stormgate, threfore is not provided in the repo to avoid any problem with NDA at this time 
-        // TODO : when the game officially can out fix provide sample replay for testing directly in the repo
+        // TODO : when the game officially came out fix provide sample replay for testing directly in the repo
         let replay_path = Path::new("replays/CL55366-2024.05.12-01.53.SGReplay"); 
         let mut buffer : Vec<u8> = vec![];
         let r = Replay::load_file(replay_path, &mut buffer).unwrap();