diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index 93372fb..0000000 --- a/LICENSE.md +++ /dev/null @@ -1,675 +0,0 @@ -### 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 . \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index fc3e21b..0000000 --- a/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# Описание -Этот инструмент позволяет управлять выделенным сервером ARK: Survival Evolved на Linux. Он предоставляет множество функций, чтобы получить полный список, ознакомьтесь с разделом использования. -(находится в разработке и может содержать ошибки) - -# Установка -```shell -curl https://www.arsenm.dev/lure.sh | bash & lure ar -n xpamych-repo -u https://gitflic.ru/project/xpamych/xpamych-lure-repo.git & lure in hlna-git -``` - -# Использование -Для конфигурирования параметров запускаемого сервера или кластера серверов: -```bash -hlna config -``` - -Для запуска, сконфигурированного сервера или кластера -```bash -hlna start -``` -Подробнее в [WIKI](https://gitflic.ru/project/xpamych/hln-a/wiki) - -# Спасибы -Сей софт написан при активном участии Sitisll, Xpamych, Vano, а так же при моральной поддержке Nezrimka и Vajka)) \ No newline at end of file diff --git a/hlna.py b/hlna.py deleted file mode 100755 index d7ca6ce..0000000 --- a/hlna.py +++ /dev/null @@ -1,413 +0,0 @@ -#!/usr/bin/env python3 -import os -import re -import yaml -import threading -from pathlib import Path - -import click -import colorama - -home_dir = Path.home() -dir_server = f"{home_dir}/ARK_Servers/" -config_hlna = f"{home_dir}/.config/hlna/" -mods_id = "" -listen_server = True - - -@click.group() -def hlna(): - pass - -list_config = next(os.walk(config_hlna), (None, None, []))[2] # [] if no file -x = list_config.count('.directory') -y = list_config.count('logs') -if x>0: - list_config.remove('.directory') -if y>0: - list_config.remove('logs') - - - -delist_config = next(os.walk(config_hlna+"deactivated"), (None, None, []))[2] # [] if no file -x = list_config.count('.directory') -y = list_config.count('logs') -if x>0: - list_config.remove('.directory') -if y>0: - list_config.remove('logs') - - - -def print_line(text): - "Добавление тире вокруг текста, покраска" - print(colorama.Fore.YELLOW + "-"*30) - print(colorama.Fore.GREEN + text) - print(colorama.Fore.YELLOW + "-"*30 + colorama.Style.RESET_ALL) - - -def create_dir(directory): - "Проверка и создание директории" - if not os.path.exists(directory): - os.mkdir(directory) - - -def check_int(number=""): - "Проверка на ввод числа" - while True: - try: - x = input(number) - if x == "": - return 0 - x = x.replace(' ', '') - x = x.replace(',', '') - x = int(x) - return x - except ValueError: - print("Введите число") -create_dir(dir_server) -create_dir(config_hlna) - - -@hlna.command(help='Для конфигурирования параметров запускаемого сервера или кластера серверов') -def config(map_server=list_config): - query_p = [] - port_s = [] - - cluster_dir_override = "" - cluster_id = "" - count_cluster = check_int("""Укажите требуется ли кластер? - 1. Да - 2. Нет - : """) - if count_cluster == 0: # 0 возвращает функция chek_int, если ничего не было введено - count_cluster = 2 - if count_cluster == 1: - cluster_server = True - cluster_id = input("Укажите id для кластера, любое сочетание символов: \n") - create_dir(dir_server + cluster_id) - cluster_dir_override = (dir_server + cluster_id) - else: - cluster_server = False - if map_server != []: - print("Уже установленные карты: ") - for i in map_server: - print(i) - count_maps = check_int("Укажите количество карт: \n") - if count_maps == 0: # 0 возрвращает check_int когда, ничего не было введено - count_maps = 1 - print - for i in range(count_maps): - while True: - "Проверка на выбор карты из списка" - - for k in map_server: - with open(f"{home_dir}/.config/hlna/{k}", "r") as yamlfile: - data = yaml.load(yamlfile, Loader=yaml.FullLoader) - data = data[0] - port_s.append(data['Port']) - query_p.append(data['QueryPort']) - - - os.system("clear") - amount_map = check_int("""Выберите карту из списка указав номер - 1. The Island - 2. The Center - 3. Scorched Earth - 4. Ragnarok - 5. Aberration - 6. Extinction - 7. Valguero - 8. Genesis: Part 1 - 9. Crystal Isles - 10. Genesis: Part 2 - 11. Lost Island - 12. Fjordur - : """) - if amount_map == 0: # 0 возрвращает check_int когда, ничего не было введено - amount_map = i + 1 - if 0: \n") - if port_server == 0: - if port_s == []: - port_server = 7777 - else: - port_server = max(port_s) + 2 - if port_server is port_s: # если веденный порт есть в списке портов - print("Этот порт уже занят") - else: - - break - while True: - query_port = check_int("Укажите Query-порт Сервера <27015>: \n") - if query_port == 0: - if query_p == []: - query_port = 27015 - else: - query_port = max(query_p) + 2 - if query_port is query_p: # если веденный порт есть в списке портов - print("Этот порт уже занят") - else: - - break - password_server = input("Укажите пароль Сервера: \n") - max_players = check_int("Укажите максимальное количество игроков: \n") - if max_players == 0: - max_players = 70 - yaml_create(cluster_server, map_server, name_server, port_server, query_port, password_server, max_players, cluster_id, cluster_dir_override) -def yaml_create(cluster_server, map_server, name_server, port_server, query_port, password_server, max_players, cluster_id, cluster_dir_override): - settings_hlna = [ - { - 'Cluster' : cluster_server, - 'SessionName' : name_server, - 'Port' : port_server, - 'QueryPort' : query_port, - 'ServerPassword' : password_server, - 'MaxPlayers' : max_players, - 'ModsId' : mods_id, - 'Listen' : listen_server, - 'ServerPath' : dir_server - } - ] - print(cluster_id) - if cluster_id != None: - settings_hlna[0]['clusterid'] = cluster_id - settings_hlna[0]['clusterdir'] = cluster_dir_override - with open(config_hlna + f"{map_server[-1]}", 'w') as yamlfile: - data = yaml.dump(settings_hlna, yamlfile) - print(colorama.Fore.GREEN + "Конфиг создан" + colorama.Style.RESET_ALL) - - -@hlna.command() -@click.option("-m", required=True, help="Название карты") -@click.option("-e/-d", default=True, help="-e активировать карты, -d деактивировать") -def enablemap(m,e): - m = m.split(",") - m = check_name_map(m, False) - create_dir(config_hlna + "deactivated") - if e == True: - port_s = [] - query_p = [] - for k in list_config: - with open(f"{home_dir}/.config/hlna/{k}", "r") as yamlfile: - data = yaml.load(yamlfile, Loader=yaml.FullLoader) - data = data[0] - port_s.append(data['Port']) - query_p.append(data['QueryPort']) - for i in m: - try: - if i in list_config: - print(f"Карта {i} уже есть в активных") - continue - with open(f"{home_dir}/.config/hlna/deactivated/{i}", "r") as yamlfile: - data = yaml.load(yamlfile, Loader=yaml.FullLoader) - data = data[0] - if data['Port'] in port_s: - print("Предлагаем заменить") - if data['QueryPort'] in query_p: - print("Заменить query port?") - x = os.system(f"mv {config_hlna}deactivated/{i} {config_hlna + i} 2>> {config_hlna}logs") - if x == 0: - print(f"Карта активирована - {i}") - else: - print(f"{i} либо уже активирована, либо такой карты нет") - except: - print("ошибка") - pass - else: - - for i in m: - try: - if i in delist_config: - print(f"Карта {i} уже есть в деактивированных") - continue - x = os.system(f"mv {config_hlna + i} {config_hlna}deactivated/{i} 2>> {config_hlna}logs") - if x == 0: - print(f"Карта деактивирована - {i}") - else: - print(f"{i} либо деактивирована, либо такой карты нет") - except: - pass - - - -@hlna.command() -def servers(map_server=list_config): - if map_server==[] and delist_config==[]: - print("Сервера не установлены") - else: - for i in map_server: - cluster_server, name_server, port_server, query_port, password_server, max_players, dir_server, mods_id, listen_server, cluster_id, cluster_dir_ovverride = read_yaml(i) - x = os.system(f"lsof -w -i :{port_server}") - if x == 0: - print(colorama.Fore.GREEN + "Сервер запущен" + colorama.Style.RESET_ALL) - else: - print(colorama.Fore.RED + "Сервер не запущен" + colorama.Style.RESET_ALL) - print(f""" - Сервер: {i} - Имя сервера: {name_server} - Кластер: {cluster_server} - Порт сервера: {port_server} - Query порт: {query_port} - Пароль: {password_server} - Максимальное кол-во игроков: {max_players} - Моды: {mods_id} - Кластер id: {cluster_id}""") - print("-" * 40) - print("\n") - if delist_config!=[]: - x = input("Есть неактивные сервера, показать Y/n: ") - if x!="n": - for i in delist_config: - cluster_server, name_server, port_server, query_port, password_server, max_players, dir_server, mods_id, listen_server, cluster_id, cluster_dir_ovverride = read_yaml(i, False) - print(f""" - Сервер: {i} - Имя сервера: {name_server} - Кластер: {cluster_server} - Порт сервера: {port_server} - Query порт: {query_port} - Пароль: {password_server} - Максимальное кол-во игроков: {max_players} - Моды: {mods_id} - Кластер id: {cluster_id}""") - print("-" * 40) - print("\n") - - - - -@hlna.command(help='Для запуска, сконфигурированного сервера или кластера') -@click.option('-m', default='all', help="Название карты для запуска или all для запуска все карт") -def start(m, map_server=list_config): - if map_server!=[]: - if m == "all": - print("Запускаем все активные карты") - else: - m = m.split(",") - m = check_name_map(m) - map_server = m - - else: - print("Ни одной карты не установлено") - - - for i in map_server: - cluster_server, name_server, port_server, query_port, password_server, max_players, dir_server, mods_id, listen_server, cluster_id, cluster_dir_ovverride = read_yaml(i) - create_dir(dir_server + i) - print_line("Качаем карту: " + i) - os.system(f"steamcmd +force_install_dir {dir_server + i} +login anonymous +app_update 376030 +quit") - print_line("Карта скачана: " + i) - def start(i): - os.chdir(dir_server + i + "/ShooterGame/Binaries/Linux/") - os.system(f"./ShooterGameServer {i}?SessionName={name_server}?Port={port_server}?QueryPort={query_port}?MaxPlayers={max_players}?GameModIds={mods_id}?listen={listen_server} -clusterid={cluster_id} -ClusterDirOverride={cluster_dir_ovverride}") - if os.path.exists(dir_server + i + "ShooterGame/Binaries/Linux/"): - threads = threading.Thread(target=start, args=(i,)) - threads.start() - else: - print(f"Карта {i} не установлена") - - -def read_yaml(map_server, flag=True): - if flag == True: - dirs=f"{home_dir}/.config/hlna/{map_server}" - else: - dirs=f"{home_dir}/.config/hlna/deactivated/{map_server}" - with open(dirs, "r") as yamlfile: - data = yaml.load(yamlfile, Loader=yaml.FullLoader) - data = data[0] - dir_server = data['ServerPath'] - name_server = data['SessionName'] - port_server = data['Port'] - query_port = data['QueryPort'] - password_server = data['ServerPassword'] - max_players = data['MaxPlayers'] - mods_id = data['ModsId'] - listen_server = data['Listen'] - cluster_server = data['Cluster'] - cluster_id = data['clusterid'] - cluster_dir_ovverride = data['clusterdir'] - return cluster_server, name_server, port_server, query_port, password_server, max_players, dir_server, mods_id, listen_server, cluster_id, cluster_dir_ovverride - - -def check_name_map(maps, flag=True): - map_choise = [] - for i in maps: - if (i.lower() =="theisland" or i.lower() =="the island" or i.lower() =="island" or i.lower() =="остров" or i.lower() =="the_island"): - map_choise.append("TheIsland") - elif (i.lower() =="thecenter" or i.lower() =="the center" or i.lower() =="center" or i.lower() =="центр" or i.lower() =="the_center"): - map_choise.append("TheCenter") - elif (i.lower() =="scorchedearth_p" or i.lower() =="scorchedearth" or i.lower() =="scorched" or i.lower() =="scorch" or i.lower() =="выжженные" or i.lower() =="пустыня" or i.lower() =="scorched_earth" or i.lower() =="скорч"): - map_choise.append("ScorchedEarth_P") - elif (i.lower() =="ragnarok" or i.lower() =="рагнарек" or i.lower() =="рагнарёк" or i.lower() =="рагнарок"): - map_choise.append("Ragnarok") - elif (i.lower() =="aberration_p" or i.lower() =="aberration" or i.lower() =="aberation" or i.lower() =="аберация" or i.lower() =="аберрация" or i.lower() =="абберация" or i.lower() =="theaberration"): - map_choise.append("Aberration_P") - elif (i.lower() =="extinction" or i.lower() =="theextinction" or i.lower() =="вымирание"): - map_choise.append("Extinction") - elif (i.lower() =="valguero_p" or i.lower() =="valguero" or i.lower() =="thevalguero" or i.lower() =="валгуеро" or i.lower() =="валгуэро"): - map_choise.append("Valguero_P") - elif (i.lower() =="genesis" or i.lower() =="thegenesis" or i.lower() =="genesis1" or i.lower() =="gen" or i.lower() =="gen1" or i.lower() =="gen_1" or i.lower() =="gen-1" or i.lower() =="genesis_1" or i.lower() =="генезис"): - map_choise.append("Genesis") - elif (i.lower() =="crystalisles" or i.lower() =="crystal_isles" or i.lower() =="crystal" or i.lower() =="кристальныеострова" or i.lower() =="кристальные_острова" or i.lower() =="кристальные-острова" \ - or i.lower() =="crystal-isles"): - map_choise.append("CrystalIsles") - elif (i.lower() =="gen2" or i.lower() =="gen_2" or i.lower() =="gen-2" or i.lower() =="genesis2" or i.lower() =="genesis_2" or i.lower() =="genesis-2" or i.lower() =="генезис2"): - map_choise.append("Gen2") - elif (i.lower() =="lostisland" or i.lower() =="lost_island" or i.lower() =="lost-island"): - map_choise.append("LostIsland") - elif (i.lower() =="fjordur" or i.lower() =="fjord" or i.lower() =="фьордур" or i.lower() =="фьорд") : - map_choise.append("Fjordur") - else: - print("Карта-", i, "не распознана") - continue - if flag == True: - if map_choise[-1] in list_config: - print_line(f"{i} - Подготавливаем карту {map_choise[-1]}") - else: - map_choise.pop() - print("Карта-", i, "не установлена") - else: - if map_choise[-1] in delist_config or map_choise[-1] in list_config: - print_line(f"{i} - Подготавливаем карту {map_choise[-1]}") - else: - map_choise.pop() - print("Карта -", i, "не установлена") - - return map_choise - - - -if __name__ == '__main__': - hlna() diff --git a/hlna_bot.py b/hlna_bot.py deleted file mode 100755 index f470de7..0000000 --- a/hlna_bot.py +++ /dev/null @@ -1,113 +0,0 @@ -#!/usr/bin/env python3 -import time -import os -import telebot -from telebot import types - -import hlna - - -key_api = input("Укажите ключ бота") -hlna_bot = telebot.TeleBot(f"{key_api}", parse_mode=None) -map_server = hlna.list_config - - -@hlna_bot.message_handler(commands=["start"]) -def m_start(m): - menu = types.ReplyKeyboardMarkup(resize_keyboard=True) - k_start = types.KeyboardButton("🦖 Старт") - k_stop = types.KeyboardButton("🦇 Выключить") - menu.add(k_start, k_stop) - - k_restart = types.KeyboardButton("🦕 Перезагрузить") - k_update = types.KeyboardButton("🔸 Обновить") - menu.add(k_restart, k_update) - - k_status = types.KeyboardButton("🧾 Статус") - menu.add(k_status) - - k_mods = types.KeyboardButton("⏬ Установка модов") - menu.add(k_mods) - - hlna_bot.send_message(m.chat.id, text="Привет, {0.first_name}! Это панель управления сервером".format(m.from_user), - reply_markup=menu) - - -@hlna_bot.message_handler(content_types=["text"]) -def m_chose(m): - if m.text.strip() == '🦖 Старт': - if map_server == []: - hlna_bot.send_message(m.chat.id, text="{0.first_name}, ниодна карта не установлена".format(m.from_user)) - else: - menu_start = types.ReplyKeyboardMarkup(resize_keyboard=True) - for i in map_server: - k_mapname = types.KeyboardButton(f"{i}") - menu_start.add(k_mapname) - k_back = types.KeyboardButton("Назад") - menu_start.add(k_back) - hlna_bot.send_message(m.chat.id, text="{0.first_name}, выбери карту".format(m.from_user), reply_markup=menu_start) - elif m.text.strip() == 'Назад': - m_start(m) - elif m.text.strip() == 'TheIsland': - hlna.start() -#def m_start(m): - # print("Start") - # - -# subprocess.run(["arkmanager", "start", "--alwaysrestart", "@all"]) -# elif m.text.strip() == '🦇 Выключить': -# subprocess.run(["arkmanager", "stop", "@all"]) -# elif m.text.strip() == '🦕 Перезагрузить': -# subprocess.run(["arkmanager","restart", "--alwaysrestart", "--warn", "@all"]) -# elif (m.text.strip() == '🔸 Обновить'): -# subprocess.run(["arkmanager", "update", "--update-mods", "@all"]) -# elif (m.text.strip() == '🧾 Статус'): -# x = os.system("lsof -w -i :7777") -# if x!=0: -# bot.send_message(m.chat.id, text="Сервер не работает 🛑".format( -# m.from_user)) -# else: -# bot.send_message(m.chat.id, text="Сервер работает 🟢".format( -# m.from_user)) -# -# elif (m.text.strip() == '⏬ Установка модов'): -# bot.send_message(m.from_user.id, "Введите id модификации") -# bot.register_next_step_handler(m, mods) -# else: -# pass -# else: -# if m.text.strip() == 'Zxx843Aj': -# th = Thread(target=check, args=(m,)) -# th.start() -# id.append(m.chat.id) -# bot.send_message(m.chat.id, text="{0.first_name} вы авторизованы, нажмите /start для работы с ботом".format(m.from_user)) -# return id -# def mods(m): -# id = m.text.strip() -# subprocess.run(["arkmanager", "installmods", id, "@all"]) -# subprocess.run(["arkmanager", "enablemod", id, "@all"]) -# def check(m): -# -# while True: -# x = os.system("lsof -w -i :7777") -# if x!=0: -# bot.send_message(m.chat.id, text="Сервер не работает 🛑".format( -# m.from_user)) -# bot.send_message(-1001585320535,text="Сервер не работает 🛑".format( -# m.from_user),reply_markup=types.ReplyKeyboardRemove()) -# -# while x!=0: -# time.sleep(5) -# x = os.system("lsof -w -i :7778") -# bot.send_message(m.chat.id, text="Сервер запустился 🟢".format( -# m.from_user)) -# bot.send_message(-1001585320535,text="Сервер запустился 🟢".format( -# m.from_user)) -# -# elif x == 0: -# time.sleep(30) -# pass - -print("Bot starting") -hlna_bot.polling(none_stop=True, interval=0, timeout=999) -