Initial commit
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
Minetest Quake
|
||||
Copyright (C) 2020 Marco
|
||||
|
||||
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 <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
Minetest Quake Copyright (C) 2020 Marco
|
||||
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
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
|
@ -0,0 +1,138 @@
|
|||
# Arena_lib docs
|
||||
|
||||
> Arena_lib is a library for Minetest working as a core for any arena-like minigame you have in mind
|
||||
|
||||
## Preamble
|
||||
|
||||
Let's start by addressing the elephant in the room: "why not creating a separate mod instead of an API for devs? It sounds complicated"
|
||||
|
||||
Unfortunately creating a separate mod containing a system which stores every mod in a different table to be put inside the storage is a giant headache and not the best thing when it comes to performance. For instance, let's say you want to customize what happens when a player respawns and you have three different minigames relying on arena_lib: specifically, you want to override the respawn behaviour of only ONE of your minigames. But, well, if you do override the respawn event, every minigame will be affected because they depend on the same mod. So you could create a different list for exceptions in case an event gets called... for every possible event. And iterate not only for each mod you have, but also for every exception. Every time someone respawns. Or dies. Or joins. Or leaves. Or, well, you got it. Sounds fun, right? :^))))
|
||||
I tried making the files as clear as possible, separating sections and writing down this separate English markdown file. Also, yes, comments inside the scripts are in Italian because I prefer to focus on the code rather than do an additional, however small, effort to think in another language (AKA I'm Italian). Love you long time, hope it'll be useful to someone.
|
||||
|
||||
|
||||
## 1. Arenas
|
||||
It all starts with a table called `arena_libs.arenas = {}`. Here is where every new arena created gets put.
|
||||
An arena is a table having as a key an ID and as a value its parameters. They are:
|
||||
* `name`: (string) the name of the arena, declared when creating it
|
||||
* `sign`: (pos) the position of the sign associated with the arena.
|
||||
* `players`: (table) where to store players
|
||||
* `max_players`: (string) default is 4
|
||||
* `min_players`: (string) default is 2. When this value is reached, a queue starts
|
||||
* `kill_cap`: (int) the goal to win (it'll be expanded for games such as Capture the point)
|
||||
* `kill_leader`: (string) who's the actual kill leader
|
||||
* `in_queue`: (bool) about phases, look at "Arena phases" down below
|
||||
* `in_loading`: (bool)
|
||||
* `in_game`: (bool)
|
||||
* `in_celebration`: (bool)
|
||||
* `enabled`: (bool) by default an arena is disabled, to avoid any damage
|
||||
|
||||
Being arenas stored by ID, they can be easily retrieved by `arena_libs.arenas[THEARENAID]`.
|
||||
|
||||
There are two ways to know an arena ID: the first is in-game via the two debug utilities:
|
||||
* `arena_lib.print_arenas(sender)`: coincise
|
||||
* `arena_lib.print_arena_info(sender, arena_name)`: extended with much more information
|
||||
|
||||
The second is via code by the function `arena_libs.get_arenaID_by_player(p_name)`.
|
||||
(Trivia: this function does NOT iterate between areas; instead, there is a local table called `players_in_game` which takes a player name as a key and the arena ID they're in as an index. So it simply returns `players_in_game[p_name]`)
|
||||
|
||||
### 1.1 Creating and removing arenas
|
||||
There are two functions for it and they all need to be connected to some command in your mod. The functions are
|
||||
* `arena_lib.create_arena(sender, arena_name)`: it doesn't accept duplicates. Sender is a string
|
||||
* `arena_lib.remove_arena(arena_name)`: if a game is taking place in it, it won't go through
|
||||
|
||||
#### 1.1.1 Storing arenas
|
||||
Arenas and their settings are stored inside the mod storage. What is *not* stored are players, their stats and such.
|
||||
Better said, these kind of parameters are emptied every time the server starts. And not when it ends, because handling situations like crashes is simply not possible.
|
||||
|
||||
### 1.2 Setting up an arena
|
||||
Two things are needed to have an arena up to go: spawners and signs. There are two functions for that:
|
||||
* `arena_lib.set_spawner(sender, arena_name, spawner_ID)`
|
||||
* `arena_lib.set_sign(sender, arena_name)`
|
||||
|
||||
#### 1.2.1 Spawners
|
||||
`arena_lib.set_spawner(sender, arena_name, spawner_ID)` creates a spawner where the sender is standing, so be sure to stand where you want the spawn point to be.
|
||||
`spawner_ID` is optional and it does make a difference: with it, it overrides an existing spawner (if exists), without it, it creates a new one. Spawners can't exceed the maximum players of an arena and, more specifically, the must be the same number.
|
||||
I suggest you using [ChatCmdBuilder](https://rubenwardy.com/minetest_modding_book/en/players/chat_complex.html) by rubenwardy and connect the `set_spawner` function to two separate subcommands such as:
|
||||
|
||||
```
|
||||
ChatCmdBuilder.new("NAMEOFYOURCOMMAND", function(cmd)
|
||||
|
||||
cmd:sub("setspawn :arena", function(name, arena)
|
||||
arena_lib.set_spawner(name, arena)
|
||||
end)
|
||||
|
||||
cmd:sub("setspawn :arena :spawnID:int", function(name, arena, spawn_ID)
|
||||
arena_lib.set_spawner(name, arena, spawn_ID)
|
||||
end)
|
||||
|
||||
[etc.]
|
||||
```
|
||||
|
||||
#### 1.2.2 Signs
|
||||
`arena_lib.set_sign(sender, arena_name)` gives the player an item to hit a sign with. There must be one and one only sign for arena, and when hit it becomes the access to the arena.
|
||||
|
||||
#### 1.2.3 Enabling an arena
|
||||
When a sign has been set, it won't work. This because an arena must be enabled manually via
|
||||
`arena_lib.enable_arena(sender, arena_ID)`
|
||||
If all the conditions are met, you'll receive a confirmation. If not, you'll receive a reason and the arena will remain disabled. The only reason right now is not having set all the spawners.
|
||||
|
||||
Arenas can be disabled too, via
|
||||
`arena_lib.disable_arena(sender, arena_ID)`
|
||||
In order to do that, no game must be taking place.
|
||||
|
||||
### 1.3 Arena phases
|
||||
An arena comes in 4 phases, each one of them linked to a specific function:
|
||||
* `waiting phase`: it's the queuing process. People hit a sign waiting for other players to play with
|
||||
* `loading phase`: it's the pre-match. By default players get teleported in the arena not being able to do anything but jump
|
||||
* `fighting phase`: the actual game
|
||||
* `celebration phase`: the after-match. By default people stroll around for the arena knowing who won, waiting to be teleported
|
||||
|
||||
The 4 functions, intertwined with the previously mentioned phases are:
|
||||
* `arena_lib.load_arena(arena_ID)`: between the waiting and the loading phase. Called when the queue timer reaches 0, it teleports people inside.
|
||||
* `arena_lib.start_arena(arena)`: between the loading and the fighting phase. Called when the loading phase timer reaches 0.
|
||||
* `arena_lib.load_celebration(arena_ID, winner_name)`: between the fighting and the celebration phase. Called when the winning conditions are met.
|
||||
* `arena_lib.end_arena(arena)`: at the very end of the celebration phase. It teleports people outside the arena
|
||||
|
||||
Overriding these functions is not recommended. Instead, there are 4 respective functions made specifically to customize the behaviour of the formers, sharing the same variables. They are called *after* the function they're associated with and by default they are empty, so feel free to override them. They are:
|
||||
* `arena_lib.on_load(arena_ID)`
|
||||
* `arena_lib.on_start(arena)`
|
||||
* `arena_lib.on_celebration(arena_ID, winner_name)`
|
||||
* `arena_lib.on_end(arena, players)`
|
||||
|
||||
So for example if we want to add an object in the first slot when they join the pre-match, we can simply do:
|
||||
|
||||
```
|
||||
function arena_lib.on_load(arena_ID)
|
||||
|
||||
local arena = arena_lib.arenas[arena_ID]
|
||||
local item = ItemStack("default:dirt")
|
||||
|
||||
for pl_name, stats in pairs(arena.players) do
|
||||
pl_name:get_inventory():set_stack("main", 1, item)
|
||||
end
|
||||
|
||||
end
|
||||
```
|
||||
|
||||
## 2. Configuration
|
||||
|
||||
First of all follow the basic README.md instructions, adding the content of the library inside a folder called `arena_lib` INSIDE your mod (beware of the textures) and adding this line in your `init.lua`.
|
||||
`dofile(minetest.get_modpath("YOURMODNAME") .. "/arena_lib/api.lua")`
|
||||
|
||||
Then, to better config the library, go in your `init.lua` and call the `arena_lib.settings` function.
|
||||
The parameters are:
|
||||
* `prefix`: what's gonna appear in most of the lines printed by your mod. Default is `[arena_lib] `
|
||||
* `hub_spawn_point`: where players will be teleported when a match ends and when they reconnect. Default is `{ x = 0, y = 20, z = 0 }`
|
||||
* `load_time`: the time between the loading state and the start of the match. Default is 3
|
||||
* `celebration_time`: the time between the celebration state and the end of the match. Default is 3
|
||||
* `immunity_time`: the duration of the immunity right after respawning. Default is 3
|
||||
* `immunity_slot`: the slot whereto put the immunity item. Default is 9 (the first slot of the inventory minus the hotbar)
|
||||
|
||||
### 2.1 Commands
|
||||
You need to connect the functions of the library with your mod in order to use them. The best way is with commands and again I suggest you the [ChatCmdBuilder](https://rubenwardy.com/minetest_modding_book/en/players/chat_complex.html) by rubenwardy. [This](https://gitlab.com/zughy-friends-minetest/minetest-quake/-/blob/master/commands.lua) is what I came up with in my Quake minigame, which relies on arena_lib.
|
||||
|
||||
## 3. Collaborating
|
||||
Something's wrong? Feel free to open an issue, go for a pull request and whatnot. I'd really appreciate it :)
|
||||
|
||||
## 4. About the author(s)
|
||||
I'm Zughy (Marco), a professional Italian pixel artist who fights for FOSS and digital ethics. If this library spared you a lot of time and you want to support me somehow, please consider donating on [LiberaPay](https://it.liberapay.com/EticaDigitale/) directly to my educational Italian project (because not everyone speaks English and Italian media don't talk about these topics much). Also, this project wouldn't have been possible if it hadn't been for some friends who helped me testing through: `SonoMichele`, `_Zaizen_` and `Xx_Crazyminer_xX`
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
Minetest Quake
|
||||
Copyright (C) 2020 Marco
|
||||
|
||||
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 <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
Minetest Quake Copyright (C) 2020 Marco
|
||||
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
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
|
@ -0,0 +1,34 @@
|
|||
# Arena_lib
|
||||
|
||||
Arena_lib is a library for Minetest working as a core for any arena minigame you have in mind.
|
||||
It comes with an arena manager and a signs system. The latter creates a bridge inside your own server between the hub and your actual mod (deathmatch, capture the flag, assault, you name it). In other words, you don't have to do the boring job and you can focus exclusively on your minigame :*
|
||||
|
||||
<a href="https://liberapay.com/EticaDigitale/donate"><img src="https://i.imgur.com/4B2PxjP.png" alt="Support my work"/></a>
|
||||
|
||||
### Config
|
||||
1) **You DON'T need to create a different folder in your mods path.** Instead, create a folder called `arena_lib` inside your specific mod folder and put all the files of this repo there (mind the textures!).
|
||||
|
||||
2) Add this in your init.lua
|
||||
`dofile(minetest.get_modpath("YOURMODNAME") .. "/arena_lib/api.lua")`
|
||||
|
||||
3) You can customize the lib calling
|
||||
|
||||
```
|
||||
arena_lib.settings({
|
||||
prefix = "[whatever] "
|
||||
--other parameters
|
||||
})
|
||||
```
|
||||
in your init.lua.
|
||||
|
||||
4) For an in-depth understanding of what you can do with the library, have a look at the [full documentation](https://gitlab.com/zughy-friends-minetest/arena_lib/-/blob/master/DOCS.md).
|
||||
|
||||
### Dependencies
|
||||
Default
|
||||
[signs_lib](https://gitlab.com/VanessaE/signs_lib) by Vanessa Dannenberg
|
||||
|
||||
### Known conflicts
|
||||
`Beds` or any other mod overriding the default respawn system
|
||||
|
||||
#### Mods relying on arena_lib
|
||||
[Quake](https://gitlab.com/zughy-friends-minetest/minetest-quake)
|
|
@ -0,0 +1,641 @@
|
|||
arena_lib = {}
|
||||
arena_lib.arenas = {}
|
||||
arena_lib.mod_name = minetest.get_current_modname()
|
||||
|
||||
dofile(minetest.get_modpath(arena_lib.mod_name) .. "/arena_lib/debug_utilities.lua")
|
||||
dofile(minetest.get_modpath(arena_lib.mod_name) .. "/arena_lib/items.lua")
|
||||
dofile(minetest.get_modpath(arena_lib.mod_name) .. "/arena_lib/player_manager.lua")
|
||||
dofile(minetest.get_modpath(arena_lib.mod_name) .. "/arena_lib/signs.lua")
|
||||
|
||||
----------------------------------------------
|
||||
--------------GESTIONE STORAGE----------------
|
||||
----------------------------------------------
|
||||
|
||||
local storage = minetest.get_mod_storage()
|
||||
--storage:set_string("arenas", nil) -- PER RESETTARE LO STORAGE
|
||||
|
||||
if minetest.deserialize(storage:get_string("arenas")) ~= nil then
|
||||
arena_lib.arenas = minetest.deserialize(storage:get_string("arenas"))
|
||||
|
||||
-- resetto lo stato delle arene, nel caso il server sia crashato o sia stato
|
||||
-- stoppato con partite in corso. L'alternativa è mettere una cosa simile in
|
||||
-- update_storage() copiando ricorsivamente la tabella e rimuovendo il tutto
|
||||
-- nella tabella copiata, ma è più pesante. E non posso metterlo in
|
||||
-- minetest.register_on_shutdown() perché se crasha non viene chiamato
|
||||
for id, arena in pairs(arena_lib.arenas) do
|
||||
arena.players = {}
|
||||
arena.murderer = ""
|
||||
arena.cop = ""
|
||||
arena.in_queue = false
|
||||
arena.in_loading = false
|
||||
arena.in_game = false
|
||||
arena.in_celebration = false
|
||||
|
||||
minetest.after(0.01, function()
|
||||
if not arena.sign.x then return end --se non è ancora stato registrato nessun cartello per l'arena, evito il crash
|
||||
arena_lib.update_sign(arena.sign, arena)
|
||||
end)
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
---------------DICHIARAZIONI------------------
|
||||
----------------------------------------------
|
||||
|
||||
local function update_storage() end
|
||||
local function new_arena() end
|
||||
local function next_ID() end
|
||||
|
||||
local arenasID
|
||||
local players_in_game = {} --KEY: player name, INDEX: arenaID
|
||||
local players_in_queue = {} --KEY: player name, INDEX: arenaID
|
||||
|
||||
local arena_default_max_players = 4
|
||||
local arena_default_min_players = 2
|
||||
local arena_default_kill_cap = 10
|
||||
|
||||
local arena_default = {
|
||||
name = "",
|
||||
sign = {},
|
||||
players = {}, --KEY: player name, INDEX: kills, deaths, killstreak
|
||||
spawn_points = {},
|
||||
max_players = arena_default_max_players,
|
||||
min_players = arena_default_min_players,
|
||||
kill_cap = arena_default_kill_cap,
|
||||
murderer = "",
|
||||
cop ="",
|
||||
in_queue = false,
|
||||
in_loading = false,
|
||||
in_game = false,
|
||||
in_celebration = false,
|
||||
enabled = false
|
||||
}
|
||||
|
||||
local prefix = "[Arena_lib] "
|
||||
local hub_spawn_point = { x = 0, y = 15, z = 0}
|
||||
local load_time = 3
|
||||
local celebration_time = 3
|
||||
local immunity_time = 3
|
||||
local immunity_slot = 9 --people may have tweaked the slots, hence the custom parameter
|
||||
|
||||
|
||||
-- call this in your mod to override the last block of values
|
||||
function arena_lib.settings(def)
|
||||
|
||||
if def.prefix then
|
||||
prefix = def.prefix
|
||||
end
|
||||
|
||||
if def.hub_spawn_point then
|
||||
hub_spawn_point = def.hub_spawn_point
|
||||
end
|
||||
|
||||
if def.load_time then
|
||||
load_time = def.load_time
|
||||
end
|
||||
|
||||
if def.celebration_time then
|
||||
celebration_time = def.celebration_time
|
||||
end
|
||||
|
||||
if def.immunity_time then
|
||||
immunity_time = def.immunity_time
|
||||
end
|
||||
|
||||
if def.immunity_slot then
|
||||
immunity_slot = def.immunity_slot
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
---------------GESTIONE ARENA-----------------
|
||||
----------------------------------------------
|
||||
|
||||
function arena_lib.create_arena(sender, arena_name, min_players, max_players)
|
||||
|
||||
arenasID = next_ID()
|
||||
|
||||
-- controllo che non ci siano duplicati
|
||||
if arenasID > 1 and arena_lib.get_arena_by_name(arena_name) ~= nil then
|
||||
minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Esiste già un'arena con quel nome!"))
|
||||
return end
|
||||
|
||||
-- creo l'arena e la rinomino, aggiornando anche lo storage
|
||||
arena_lib.arenas[arenasID] = new_arena(arena_default)
|
||||
arena_lib.arenas[arenasID].name = arena_name
|
||||
if min_players and max_players then
|
||||
arena_lib.arenas[arenasID].min_players = min_players
|
||||
arena_lib.arenas[arenasID].max_players = max_players
|
||||
end
|
||||
update_storage()
|
||||
minetest.chat_send_player(sender, prefix .. "Arena " .. arena_name .. " creata con successo")
|
||||
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.remove_arena(sender, arena_name)
|
||||
|
||||
local id, arena = arena_lib.get_arena_by_name(arena_name)
|
||||
|
||||
if not arena then minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Non c'è nessun'arena chiamata " .. arena_name .. "!"))
|
||||
return end
|
||||
|
||||
if arena.in_game then
|
||||
minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Una partita è in corso nell'arena " .. arena_name .. ": impossibile rimuoverla"))
|
||||
return end
|
||||
|
||||
--TODO: -chiedere conferma
|
||||
|
||||
-- rimozione cartello coi rispettivi metadati
|
||||
if arena.sign ~= nil then
|
||||
minetest.set_node(arena.sign, {name = "air"}) end
|
||||
|
||||
arena_lib.send_message_players_in_arena(id, prefix .."L'arena per la quale eri in coda è stata rimossa... :(")
|
||||
|
||||
-- rimozione arena e aggiornamento storage
|
||||
arena_lib.arenas[id] = nil
|
||||
update_storage()
|
||||
minetest.chat_send_player(sender, prefix .. "Arena " .. arena_name .. " rimossa con successo")
|
||||
|
||||
end
|
||||
|
||||
|
||||
|
||||
-- Gli spawn points si impostano prendendo la coordinata del giocatore che lancia il comando.
|
||||
-- Non ci possono essere più spawn points del numero massimo di giocatori e non possono essere impostati in aria
|
||||
-- Indicando lo spawner_ID, si andrà a sovrascrivere lo spawner con quell'ID se esiste
|
||||
function arena_lib.set_spawner(sender, arena_name, spawner_ID)
|
||||
|
||||
local id, arena = arena_lib.get_arena_by_name(arena_name)
|
||||
|
||||
if arena == nil then minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Quest'arena non esiste!"))
|
||||
return end
|
||||
|
||||
local spawn_points_count = arena_lib.get_arena_spawners_count(id)
|
||||
|
||||
if spawn_points_count == arena.max_players and spawner_ID == nil then
|
||||
minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Gli spawn point non possono superare i giocatori massimi! Vuoi cancellarne alcuni con /quakeadmin delspawn <arena>?"))
|
||||
return end
|
||||
|
||||
if spawner_ID ~= nil and spawner_ID > spawn_points_count then
|
||||
minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Nessuno spawner con quell'ID da sovrascrivere!"))
|
||||
return end
|
||||
|
||||
local pos = vector.floor(minetest.get_player_by_name(sender):get_pos()) --tolgo i decimali per storare un int
|
||||
local pos_Y_up = {x = pos.x, y = pos.y+1, z = pos.z} -- alzo Y di uno sennò tippa nel blocco
|
||||
local pos_feet = {x = pos.x, y = pos.y-1, z = pos.z}
|
||||
|
||||
if minetest.get_node(pos_feet).name == "air" then minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Non puoi impostare spawn point nell'aria!"))
|
||||
return end
|
||||
|
||||
for id, spawn in pairs(arena.spawn_points) do
|
||||
if minetest.serialize(pos_Y_up) == minetest.serialize(spawn) then minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] C'è già uno spawn in questo punto!"))
|
||||
return end
|
||||
end
|
||||
|
||||
if spawner_ID ~= nil then
|
||||
arena.spawn_points[spawner_ID] = pos_Y_up
|
||||
minetest.chat_send_player(sender, prefix .. "Spawn point " .. spawner_ID .. " sovrascritto con successo" )
|
||||
else
|
||||
arena.spawn_points[spawn_points_count +1] = pos_Y_up
|
||||
minetest.chat_send_player(sender, prefix .. "Spawn point " .. spawn_points_count +1 .. " impostato con successo" )
|
||||
end
|
||||
|
||||
update_storage()
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.enable_arena(sender, arena_ID)
|
||||
|
||||
local arena = arena_lib.arenas[arena_ID]
|
||||
|
||||
if arena_lib.get_arena_spawners_count(arena_ID) < arena.max_players then
|
||||
minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Spawner insufficienti, arena disabilitata!"))
|
||||
arena.enabled = false
|
||||
return end
|
||||
|
||||
arena.enabled = true
|
||||
arena_lib.update_sign(arena.sign, arena)
|
||||
update_storage()
|
||||
minetest.chat_send_player(sender, prefix .. "Arena abilitata con successo")
|
||||
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.disable_arena(sender, arena_ID)
|
||||
|
||||
local arena = arena_lib.arenas[arena_ID]
|
||||
|
||||
if not arena then
|
||||
minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Non esiste nessun'arena associata a questo ID!"))
|
||||
return end
|
||||
|
||||
if not arena.enabled then
|
||||
minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] L'arena è già disabilitata"))
|
||||
return end
|
||||
|
||||
if arena.in_loading or arena.in_game or arena.in_celebration then
|
||||
minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Non puoi disabilitare un'arena mentre una partita è in corso!"))
|
||||
return end
|
||||
|
||||
-- se c'è rimasto qualcuno, erano in coda
|
||||
for pl_name, stats in pairs(arena.players) do
|
||||
|
||||
players_in_queue[pl_name] = nil
|
||||
arena.players[pl_name] = nil
|
||||
minetest.chat_send_player(pl_name, minetest.colorize("#e6482e", "[!] L'arena per la quale eri in coda è stata disabilitata!"))
|
||||
|
||||
end
|
||||
|
||||
arena.enabled = false
|
||||
arena_lib.update_sign(arena.sign, arena)
|
||||
update_storage()
|
||||
minetest.chat_send_player(sender, prefix .. "L'arena " .. arena.name .. " è stata disabilitata con successo")
|
||||
end
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
--------------GESTIONE PARTITA-----------------
|
||||
----------------------------------------------
|
||||
|
||||
-- per tutti i giocatori quando finisce la coda
|
||||
function arena_lib.load_arena(arena_ID)
|
||||
|
||||
local count = 1
|
||||
local arena = arena_lib.arenas[arena_ID]
|
||||
|
||||
arena.in_loading = true
|
||||
arena_lib.update_sign(arena.sign, arena)
|
||||
|
||||
-- teletrasporto giocatori e sostituisco l'inventario
|
||||
for pl_name, stats in pairs(arena.players) do
|
||||
|
||||
local player = minetest.get_player_by_name(pl_name)
|
||||
|
||||
player:set_nametag_attributes({color = {a = 0, r = 255, g = 255, b = 255}})
|
||||
player:set_physics_override({ speed = 0 })
|
||||
|
||||
player:set_pos(arena.spawn_points[count])
|
||||
player:get_inventory():set_list("main",{})
|
||||
players_in_queue[pl_name] = nil
|
||||
players_in_game[pl_name] = arena_ID -- registro giocatori nella tabella apposita
|
||||
|
||||
count = count +1
|
||||
end
|
||||
|
||||
arena_lib.on_load(arena)
|
||||
|
||||
minetest.after(load_time, function()
|
||||
arena_lib.start_arena(arena)
|
||||
end)
|
||||
|
||||
end
|
||||
|
||||
|
||||
|
||||
-- per il player singolo a match iniziato
|
||||
function arena_lib.join_arena(p_name, arena_ID)
|
||||
|
||||
local player = minetest.get_player_by_name(p_name)
|
||||
|
||||
player:set_nametag_attributes({color = {a = 0, r = 255, g = 255, b = 255}})
|
||||
player:get_inventory():set_list("main",{})
|
||||
player:set_pos(arena_lib.get_random_spawner(arena_ID))
|
||||
players_in_game[p_name] = arena_ID
|
||||
|
||||
arena_lib.on_join(p_name, arena_ID)
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.start_arena(arena)
|
||||
|
||||
arena.in_loading = false
|
||||
arena.in_game = true
|
||||
arena_lib.update_sign(arena.sign, arena)
|
||||
|
||||
for pl_name, stats in pairs(arena.players) do
|
||||
|
||||
minetest.get_player_by_name(pl_name):set_physics_override({
|
||||
speed = 1,
|
||||
jump = 1,
|
||||
gravity = 1,
|
||||
})
|
||||
end
|
||||
|
||||
arena_lib.on_start(arena)
|
||||
end
|
||||
|
||||
|
||||
|
||||
--a partita finita
|
||||
function arena_lib.load_celebration(arena_ID, winner_name)
|
||||
|
||||
local arena = arena_lib.arenas[arena_ID]
|
||||
|
||||
arena.in_celebration = true
|
||||
arena_lib.update_sign(arena.sign, arena)
|
||||
|
||||
for pl_name, stats in pairs(arena.players) do
|
||||
|
||||
local inv = minetest.get_player_by_name(pl_name):get_inventory()
|
||||
|
||||
-- giocatori immortali
|
||||
if not inv:contains_item("main", arena_lib.mod_name .. ":immunity") then
|
||||
inv:set_stack("main", immunity_slot, arena_lib.mod_name .. ":immunity")
|
||||
end
|
||||
|
||||
minetest.get_player_by_name(pl_name):set_nametag_attributes({color = {a = 255, r = 255, g = 255, b = 255}})
|
||||
minetest.chat_send_player(pl_name, prefix .. winner_name .. " ha vinto la partita")
|
||||
end
|
||||
|
||||
arena_lib.on_celebration(arena_ID, winner_name)
|
||||
|
||||
-- momento celebrazione
|
||||
minetest.after(celebration_time, function()
|
||||
arena_lib.end_arena(arena)
|
||||
end)
|
||||
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.end_arena(arena)
|
||||
|
||||
arena.murderer = ""
|
||||
arena.cop = ""
|
||||
local players = {}
|
||||
|
||||
for pl_name, stats in pairs(arena.players) do
|
||||
|
||||
players[pl_name] = stats
|
||||
arena.players[pl_name] = nil
|
||||
players_in_game[pl_name] = nil
|
||||
arena.in_celebration = false
|
||||
arena.in_game = false
|
||||
|
||||
local player = minetest.get_player_by_name (pl_name)
|
||||
|
||||
player:get_inventory():set_list("main", {})
|
||||
player:set_pos(hub_spawn_point)
|
||||
end
|
||||
|
||||
arena_lib.update_sign(arena.sign, arena)
|
||||
arena_lib.on_end(arena, players)
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.add_to_queue(p_name, arena_ID)
|
||||
players_in_queue[p_name] = arena_ID
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.remove_from_queue(p_name)
|
||||
players_in_queue[p_name] = nil
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.on_load(arena)
|
||||
--[[override this function on your mod if you wanna add more!
|
||||
Just do: function arena_lib.on_load() yourstuff end]]
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.on_join(p_name, arena_ID)
|
||||
--[[override this function on your mod if you wanna add more!
|
||||
Just do: function arena_lib.on_join() yourstuff end]]
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.on_start(arena)
|
||||
--[[override this function on your mod if you wanna add more!
|
||||
Just do: function arena_lib.on_load() yourstuff end]]
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.on_celebration(arena_ID, winner_name)
|
||||
--[[override this function on your mod if you wanna add more!
|
||||
Just do: function arena_lib.on_celebration() yourstuff end]]
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.on_end(arena)
|
||||
--[[override this function on your mod if you wanna add more!
|
||||
Just do: function arena_lib.on_end() yourstuff end]]
|
||||
end
|
||||
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
--------------------UTILS---------------------
|
||||
----------------------------------------------
|
||||
|
||||
function arena_lib.is_player_in_arena(p_name)
|
||||
|
||||
if not players_in_game[p_name] then return false
|
||||
else return true end
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.is_player_in_queue(p_name)
|
||||
|
||||
if not players_in_queue[p_name] then return false
|
||||
else return true end
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.remove_player_from_arena(p_name)
|
||||
|
||||
local arena_ID
|
||||
if players_in_game[p_name] == nil then arena_ID = players_in_queue[p_name]
|
||||
else arena_ID = players_in_game[p_name]
|
||||
end
|
||||
|
||||
local arena = arena_lib.arenas[arena_ID]
|
||||
|
||||
if arena == nil then return end
|
||||
|
||||
arena.players[p_name] = nil
|
||||
players_in_game[p_name] = nil
|
||||
players_in_queue[p_name] = nil
|
||||
|
||||
arena_lib.update_sign(arena.sign, arena)
|
||||
arena_lib.send_message_players_in_arena(arena_ID, prefix .. p_name .. " ha abbandonato la partita")
|
||||
|
||||
if arena.in_queue then
|
||||
local timer = minetest.get_node_timer(arena.sign)
|
||||
|
||||
if arena_lib.get_arena_players_count(arena_ID) < arena.min_players then
|
||||
timer:stop()
|
||||
arena.in_queue = false
|
||||
arena_lib.send_message_players_in_arena(arena_ID, prefix .. "La coda è stata annullata per troppi pochi giocatori")
|
||||
end
|
||||
|
||||
elseif arena_lib.get_arena_players_count(arena_ID) == 1 then
|
||||
|
||||
arena_lib.send_message_players_in_arena(arena_ID, prefix .. "Hai vinto la partita per troppi pochi giocatori")
|
||||
for pl_name, stats in pairs(arena.players) do
|
||||
arena_lib.load_celebration(arena_ID, pl_name)
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.send_message_players_in_arena(arena_ID, msg)
|
||||
for pl_name, stats in pairs(arena_lib.arenas[arena_ID].players) do
|
||||
minetest.chat_send_player(pl_name, msg) end
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.immunity(player)
|
||||
|
||||
local immunity_item = ItemStack(arena_lib.mod_name ..":immunity")
|
||||
local inv = player:get_inventory()
|
||||
|
||||
inv:set_stack("main", immunity_slot, immunity_item)
|
||||
|
||||
minetest.after(immunity_time, function()
|
||||
if player == nil then return end -- they may disconnect
|
||||
if inv:contains_item("main", immunity_item) then
|
||||
inv:remove_item("main", immunity_item)
|
||||
end
|
||||
end)
|
||||
|
||||
end
|
||||
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
-----------------GETTERS----------------------
|
||||
----------------------------------------------
|
||||
|
||||
function arena_lib.get_hub_spawnpoint()
|
||||
return hub_spawn_point
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.get_prefix()
|
||||
return prefix
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.get_arena_by_name(arena_name)
|
||||
|
||||
for id, arena in pairs(arena_lib.arenas) do
|
||||
if arena.name == arena_name then
|
||||
return id, arena end
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.get_arenaID_by_player(p_name)
|
||||
return players_in_game[p_name]
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.get_queueID_by_player(p_name)
|
||||
return players_in_queue[p_name]
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.get_arena_players_count(arena_ID)
|
||||
|
||||
local count = 0
|
||||
local arena = arena_lib.arenas[arena_ID]
|
||||
|
||||
for pl_name, stats in pairs(arena.players) do
|
||||
count = count+1
|
||||
end
|
||||
|
||||
return count
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.get_arena_spawners_count(arena_ID)
|
||||
return table.maxn(arena_lib.arenas[arena_ID].spawn_points)
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.get_random_spawner(arena_ID)
|
||||
return arena_lib.arenas[arena_ID].spawn_points[math.random(1,arena_lib.get_arena_spawners_count(arena_ID))]
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.get_immunity_slot()
|
||||
return immunity_slot
|
||||
end
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
-----------------SETTERS----------------------
|
||||
----------------------------------------------
|
||||
|
||||
-- nothing to see here ¯\_(ツ)_/¯
|
||||
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
---------------FUNZIONI LOCALI----------------
|
||||
----------------------------------------------
|
||||
|
||||
function update_storage()
|
||||
storage:set_string("arenas", minetest.serialize(arena_lib.arenas))
|
||||
end
|
||||
|
||||
|
||||
|
||||
--[[ Dato che in Lua non è possibile istanziare le tabelle copiandole, bisogna istanziare ogni campo in una nuova tabella.
|
||||
Ricorsivo per le sottotabelle. Codice da => http://lua-users.org/wiki/CopyTable]]
|
||||
function new_arena(orig)
|
||||
local orig_type = type(orig)
|
||||
local copy
|
||||
if orig_type == 'table' then
|
||||
copy = {}
|
||||
for orig_key, orig_value in next, orig, nil do
|
||||
copy[new_arena(orig_key)] = new_arena(orig_value)
|
||||
end
|
||||
setmetatable(copy, new_arena(getmetatable(orig)))
|
||||
else -- number, string, boolean, etc
|
||||
copy = orig
|
||||
end
|
||||
return copy
|
||||
end
|
||||
|
||||
|
||||
|
||||
--[[ l'ID di base parte da 1 (n+1) per non generare errori, tipo "if arenaID == 0" al verificare se non esiste.
|
||||
In una sequenza 0, 1, 2, 3 se si rimuove "2" e si aggiunge un nuovo ID perciò si avrà 0, 1, 3, 4]]
|
||||
function next_ID()
|
||||
local n = 0
|
||||
for id, arena in pairs(arena_lib.arenas) do
|
||||
if id > n then n = id end
|
||||
end
|
||||
return n+1
|
||||
end
|
|
@ -0,0 +1,67 @@
|
|||
---
|
||||
--- Link these functions to your mod through some commands, ie. /yourmod info arena_name
|
||||
---
|
||||
|
||||
|
||||
|
||||
function arena_lib.print_arenas(sender)
|
||||
|
||||
local n = 0
|
||||
for id, arena in pairs(arena_lib.arenas) do
|
||||
n = n+1
|
||||
minetest.chat_send_player(sender, "ID: " .. id .. ", nome: " .. arena.name )
|
||||
end
|
||||
|
||||
minetest.chat_send_player(sender, "Arene totali: " .. n )
|
||||
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.print_arena_info(sender, arena_name)
|
||||
local arena_ID, arena = arena_lib.get_arena_by_name(arena_name)
|
||||
if arena == nil then minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Quest'arena non esiste!")) return end
|
||||
|
||||
local p_count = 0
|
||||
local names = ""
|
||||
for pl, stats in pairs(arena.players) do
|
||||
p_count = p_count +1
|
||||
names = names .. " " .. pl
|
||||
end
|
||||
|
||||
local spawners_count = 0
|
||||
local spawners_pos = ""
|
||||
for spawn_id, spawn_pos in pairs(arena.spawn_points) do
|
||||
spawners_count = spawners_count + 1
|
||||
spawners_pos = spawners_pos .. " " .. minetest.pos_to_string(spawn_pos)
|
||||
end
|
||||
|
||||
minetest.chat_send_player(sender, [[
|
||||
]] .. "Nome: " .. minetest.colorize("#eea160", arena_name ) .. [[
|
||||
]] .. "ID: " .. arena_ID .. [[
|
||||
]] .. "Abilitata: " .. tostring(arena.enabled) .. [[
|
||||
]] .. "Giocatori minimi: " .. arena.min_players .. [[
|
||||
]] .. "Giocatori massimi: " .. arena.max_players .. [[
|
||||
]] .. "Giocatori dentro: " .. p_count .. " ( ".. names .. " )" .. [[
|
||||
]] .. "Kill per la vittoria: " .. arena.kill_cap .. [[
|
||||
]] .. "In coda: " .. tostring(arena.in_queue) .. [[
|
||||
]] .. "In caricamento: " .. tostring(arena.in_loading) .. [[
|
||||
]] .. "In partita: " .. tostring(arena.in_game) .. [[
|
||||
]] .. "In celebrazione: " .. tostring(arena.in_celebration) .. [[
|
||||
]] .. "Spawn points: " .. spawners_count .. " ( " .. spawners_pos .. " )" )
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.print_arena_stats(sender, arena_name)
|
||||
|
||||
local arena_ID, arena = arena_lib.get_arena_by_name(arena_name)
|
||||
if arena == nil then minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Quest'arena non esiste!")) return end
|
||||
|
||||
if not arena.in_game and not arena.in_celebration then minetest.chat_send_player(name, minetest.colorize("#e6482e", "[!] Nessuna partita in corso!")) return end
|
||||
|
||||
for pl, stats in pairs(arena.players) do
|
||||
minetest.chat_send_player(sender, "Player: " .. pl .. ", kills: " .. stats.kills .. ", deaths: " .. stats.deaths .. ", killstreak: " .. stats.killstreak)
|
||||
end
|
||||
|
||||
end
|
|
@ -0,0 +1,58 @@
|
|||
minetest.register_tool(arena_lib.mod_name .. ":immunity", {
|
||||
|
||||
description = "Sei immune!",
|
||||
inventory_image = "arena_immunity.png",
|
||||
groups = {not_in_creative_inventory = 1, oddly_breakable_by_hand = "2"},
|
||||
|
||||
})
|
||||
|
||||
|
||||
|
||||
--[[sovrascrizione "on_punch" nodo base dei cartelli per farli entrare
|
||||
nell'arena se sono cartelli appositi e "on_timer" per teletrasportali in partita quando la queue finisce]]
|
||||
minetest.register_tool(arena_lib.mod_name .. ":create_sign", {
|
||||
|
||||
description = "Left click on a sign to create an entrance or to remove it",
|
||||
inventory_image = "arena_createsign.png",
|
||||
groups = {not_in_creative_inventory = 1, oddly_breakable_by_hand = "2"},
|
||||
|
||||
on_use = function(itemstack, user, pointed_thing)
|
||||
|
||||
local pos = minetest.get_pointed_thing_position(pointed_thing)
|
||||
if pos == nil then return end -- nel caso sia aria, sennò crasha
|
||||
|
||||
local node = minetest.get_node(pos)
|
||||
local def = minetest.registered_items[node.name]
|
||||
|
||||
--controllo se è un cartello
|
||||
if def and def.entity_info then
|
||||
def.number_of_lines = 5
|
||||
|
||||
local arena_ID = itemstack:get_meta():get_int("arenaID")
|
||||
local arena = arena_lib.arenas[arena_ID]
|
||||
|
||||
-- controllo se c'è già un cartello assegnato a quell'arena. Se è lo stesso lo rimuovo, sennò annullo
|
||||
if next(arena.sign) ~= nil then
|
||||
if minetest.serialize(pos) == minetest.serialize(arena.sign) then
|
||||
minetest.set_node(pos, {name = "air"})
|
||||
arena.sign = {}
|
||||
minetest.chat_send_player(user:get_player_name(), "Cartello dell'arena " .. arena.name .. " rimosso con successo")
|
||||
else
|
||||
minetest.chat_send_player(user:get_player_name(), minetest.colorize("#e6482e", "[!] Esiste già un cartello per quest'arena!"))
|
||||
end
|
||||
return end
|
||||
|
||||
-- cambio la scritta
|
||||
arena_lib.update_sign(pos, arena)
|
||||
|
||||
-- aggiungo il cartello ai cartelli dell'arena
|
||||
arena.sign = pos
|
||||
|
||||
-- salvo l'ID come metadato nel cartello
|
||||
minetest.get_meta(pos):set_int("arenaID", arena_ID)
|
||||
else
|
||||
minetest.chat_send_player(user:get_player_name(), minetest.colorize("#e6482e", "[!] L'oggetto non è un cartello!"))
|
||||
end
|
||||
end,
|
||||
|
||||
})
|
|
@ -0,0 +1,50 @@
|
|||
minetest.register_on_joinplayer(function(player)
|
||||
|
||||
player:set_pos(arena_lib.get_hub_spawnpoint())
|
||||
|
||||
end)
|
||||
|
||||
|
||||
minetest.register_on_leaveplayer(function(player)
|
||||
|
||||
local p_name = player:get_player_name()
|
||||
if arena_lib.get_arenaID_by_player(p_name) == nil and arena_lib.get_queueID_by_player(p_name) == nil then return end
|
||||
|
||||
minetest.chat_send_player("Zughy", "Vado sul remove player")
|
||||
|
||||
arena_lib.remove_player_from_arena(p_name)
|
||||
end)
|
||||
|
||||
|
||||
|
||||
minetest.register_on_dieplayer(function(player, reason)
|
||||
|
||||
local p_name = player:get_player_name()
|
||||
if not arena_lib.is_player_in_arena(p_name) then return end
|
||||
|
||||
local arena = arena_lib.arenas[arena_lib.get_arenaID_by_player(p_name)]
|
||||
local p_stats = arena.players[p_name]
|
||||
p_stats.deaths = p_stats.deaths +1
|
||||
p_stats.killstreak = 0
|
||||
|
||||
arena_lib.on_death(arena, p_name)
|
||||
|
||||
end)
|
||||
|
||||
|
||||
function arena_lib.on_death(arena, p_name)
|
||||
--DO STUFF, override me if you need to
|
||||
end
|
||||
|
||||
|
||||
|
||||
minetest.register_on_respawnplayer(function(player)
|
||||
|
||||
local arenaID = arena_lib.get_arenaID_by_player(player:get_player_name())
|
||||
if arenaID == nil then return end
|
||||
|
||||
player:set_pos(arena_lib.get_random_spawner(arenaID))
|
||||
arena_lib.immunity(player)
|
||||
return true
|
||||
|
||||
end)
|
|
@ -0,0 +1,170 @@
|
|||
--
|
||||
-- For the item to set signs, being a declaration of a new item, look at items.lua
|
||||
--
|
||||
|
||||
local queue_waiting_time = 5
|
||||
local prefix
|
||||
|
||||
minetest.after(0.01, function()
|
||||
prefix = arena_lib.get_prefix()
|
||||
end)
|
||||
|
||||
local function in_game_txt(arena) end
|
||||
|
||||
|
||||
|
||||
minetest.override_item("default:sign_wall", {
|
||||
|
||||
on_punch = function(pos, node, puncher, pointed_thing)
|
||||
|
||||
local arenaID = minetest.get_meta(pos):get_int("arenaID")
|
||||
if arenaID == 0 then return end
|
||||
|
||||
local sign_arena = arena_lib.arenas[arenaID]
|
||||
local p_name = puncher:get_player_name()
|
||||
|
||||
if not sign_arena then return end -- nel caso qualche cartello dovesse buggarsi, si può rompere e non fa crashare
|
||||
if not sign_arena.enabled then
|
||||
minetest.chat_send_player(p_name, minetest.colorize("#e6482e", "[!] L'arena non è attiva!"))
|
||||
return end
|
||||
|
||||
-- se è già in coda o viene fermato (cartello diverso) o si toglie dalla coda (cartello uguale)
|
||||
if arena_lib.is_player_in_queue(p_name) then
|
||||
|
||||
local queued_ID = arena_lib.get_queueID_by_player(p_name)
|
||||
|
||||
if queued_ID ~= arenaID then
|
||||
minetest.chat_send_player(p_name, prefix .. minetest.colorize("#e6482e", "Devi prima uscire dalla coda di " .. arena_lib.arenas[queued_ID].name .. "!"))
|
||||
else
|
||||
|
||||
sign_arena.players[p_name] = nil
|
||||
arena_lib.update_sign(pos, sign_arena)
|
||||
arena_lib.remove_from_queue(p_name)
|
||||
minetest.chat_send_player(p_name, prefix .. "Sei uscito dalla coda")
|
||||
arena_lib.send_message_players_in_arena(arenaID, prefix .. p_name .. " ha abbandonato la coda")
|
||||
|
||||
-- se non ci sono più abbastanza giocatori, annullo la coda
|
||||
if arena_lib.get_arena_players_count(arenaID) < sign_arena.min_players and sign_arena.in_queue then
|
||||
minetest.get_node_timer(pos):stop()
|
||||
arena_lib.send_message_players_in_arena(arenaID, prefix .. "La coda è stata annullata per troppi pochi giocatori")
|
||||
arena.in_queue = false
|
||||
end
|
||||
end
|
||||
return end
|
||||
|
||||
-- se l'arena è piena
|
||||
if arena_lib.get_arena_players_count(arenaID) == sign_arena.max_players then
|
||||
minetest.chat_send_player(p_name, minetest.colorize("#e6482e", "[!] L'arena è già piena!"))
|
||||
return end
|
||||
|
||||
-- se sta caricando
|
||||
if sign_arena.in_loading then
|
||||
minetest.chat_send_player(p_name, minetest.colorize("#e6482e", "[!] L'arena è in caricamento, riprova tra qualche secondo!"))
|
||||
return end
|
||||
|
||||
-- aggiungo il giocatore e aggiorno il cartello
|
||||
sign_arena.players[p_name] = {kills = 0, deaths = 0, killstreak = 0}
|
||||
arena_lib.update_sign(pos, sign_arena)
|
||||
|
||||
-- notifico i vari giocatori del nuovo player
|
||||
if sign_arena.in_game then
|
||||
arena_lib.join_arena(p_name, arenaID)
|
||||
arena_lib.send_message_players_in_arena(arenaID, prefix .. p_name .. " si è aggiunto alla partita")
|
||||
minetest.chat_send_player(p_name, prefix .. "Sei entrato nell'arena " .. sign_arena.name)
|
||||
return
|
||||
else
|
||||
arena_lib.add_to_queue(p_name, arenaID)
|
||||
arena_lib.send_message_players_in_arena(arenaID, prefix .. p_name .. " si è aggiunto alla coda")
|
||||
minetest.chat_send_player(p_name, prefix .. "Ti sei aggiunto alla coda per " .. sign_arena.name)
|
||||
end
|
||||
|
||||
local timer = minetest.get_node_timer(pos)
|
||||
|
||||
-- se ci sono abbastanza giocatori, parte il timer di attesa
|
||||
if arena_lib.get_arena_players_count(arenaID) == sign_arena.min_players and not sign_arena.in_queue and not sign_arena.in_game then
|
||||
arena_lib.send_message_players_in_arena(arenaID, prefix .. "La partita inizierà tra " .. queue_waiting_time .. " secondi!")
|
||||
sign_arena.in_queue = true
|
||||
timer:start(queue_waiting_time)
|
||||
end
|
||||
|
||||
-- se raggiungo i giocatori massimi e la partita non è iniziata, parte subito
|
||||
if arena_lib.get_arena_players_count(arenaID) == sign_arena.max_players and sign_arena.in_queue then
|
||||
timer:stop()
|
||||
timer:start(0.01)
|
||||
end
|
||||
|
||||
--TODO: timer ciclico che avvisa i giocatori quanto tempo manca ogni N secondi
|
||||
|
||||
end,
|
||||
|
||||
-- quello che succede una volta che il timer raggiunge lo 0
|
||||
on_timer = function(pos)
|
||||
|
||||
local arenaID = minetest.get_meta(pos):get_int("arenaID")
|
||||
local sign_arena = arena_lib.arenas[arenaID]
|
||||
|
||||
sign_arena.in_queue = false
|
||||
sign_arena.in_game = true
|
||||
arena_lib.update_sign(pos, sign_arena)
|
||||
|
||||
arena_lib.load_arena(arenaID)
|
||||
|
||||
return false
|
||||
end,
|
||||
|
||||
})
|
||||
|
||||
|
||||
|
||||
function arena_lib.set_sign(sender, arena_name)
|
||||
|
||||
local arena_ID, arena = arena_lib.get_arena_by_name(arena_name)
|
||||
|
||||
if arena == nil then minetest.chat_send_player(sender, minetest.colorize("#e6482e", "[!] Quest'arena non esiste!"))
|
||||
return end
|
||||
|
||||
-- assegno item creazione arene con ID arena nei metadati da restituire al premere sul cartello
|
||||
local stick = ItemStack(arena_lib.mod_name .. ":create_sign")
|
||||
local meta = stick:get_meta()
|
||||
meta:set_int("arenaID", arena_ID)
|
||||
|
||||
minetest.get_player_by_name(sender):set_wielded_item(stick)
|
||||
minetest.chat_send_player(sender, "Click sinistro su un cartello per settare l'arena")
|
||||
end
|
||||
|
||||
|
||||
|
||||
function arena_lib.update_sign(pos, arena)
|
||||
|
||||
-- non uso il getter perché dovrei richiamare 2 funzioni (ID e count)
|
||||
local p_count = 0
|
||||
for pl, stats in pairs(arena.players) do
|
||||
p_count = p_count +1
|
||||
end
|
||||
|
||||
signs_lib.update_sign(pos, {text = [[
|
||||
]] .. "\n" .. [[
|
||||
]] .. arena.name .. "\n" .. [[
|
||||
]] .. p_count .. "/".. arena.max_players .. "\n" .. [[
|
||||
]] .. in_game_txt(arena) .. "\n" .. [[
|
||||
|
||||
]]})
|
||||
end
|
||||
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
---------------FUNZIONI LOCALI----------------
|
||||
----------------------------------------------
|
||||
|
||||
function in_game_txt(arena)
|
||||
local txt
|
||||
|
||||
if not arena.enabled then txt = "LAVORI IN CORSO"
|
||||
elseif arena.in_celebration then txt = "Concludendo"
|
||||
elseif arena.in_game then txt = "In partita"
|
||||
elseif arena.in_loading then txt = "In caricamento"
|
||||
else txt = "In attesa" end
|
||||
|
||||
return txt
|
||||
end
|
|
@ -0,0 +1,306 @@
|
|||
ChatCmdBuilder = {}
|
||||
|
||||
function ChatCmdBuilder.new(name, func, def)
|
||||
def = def or {}
|
||||
local cmd = ChatCmdBuilder.build(func)
|
||||
cmd.def = def
|
||||
def.func = cmd.run
|
||||
minetest.register_chatcommand(name, def)
|
||||
return cmd
|
||||
end
|
||||
|
||||
local STATE_READY = 1
|
||||
local STATE_PARAM = 2
|
||||
local STATE_PARAM_TYPE = 3
|
||||
local bad_chars = {}
|
||||
bad_chars["("] = true
|
||||
bad_chars[")"] = true
|
||||
bad_chars["."] = true
|
||||
bad_chars["%"] = true
|
||||
bad_chars["+"] = true
|
||||
bad_chars["-"] = true
|
||||
bad_chars["*"] = true
|
||||
bad_chars["?"] = true
|
||||
bad_chars["["] = true
|
||||
bad_chars["^"] = true
|
||||
bad_chars["$"] = true
|
||||
local function escape(char)
|
||||
if bad_chars[char] then
|
||||
return "%" .. char
|
||||
else
|
||||
return char
|
||||
end
|
||||
end
|
||||
|
||||
local dprint = function() end
|
||||
|
||||
ChatCmdBuilder.types = {
|
||||
pos = "%(? *(%-?[%d.]+) *, *(%-?[%d.]+) *, *(%-?[%d.]+) *%)?",
|
||||
text = "(.+)",
|
||||
number = "(%-?[%d.]+)",
|
||||
int = "(%-?[%d]+)",
|
||||
word = "([^ ]+)",
|
||||
alpha = "([A-Za-z]+)",
|
||||
modname = "([a-z0-9_]+)",
|
||||
alphascore = "([A-Za-z_]+)",
|
||||
alphanumeric = "([A-Za-z0-9]+)",
|
||||
username = "([A-Za-z0-9-_]+)",
|
||||
}
|
||||
|
||||
function ChatCmdBuilder.build(func)
|
||||
local cmd = {
|
||||
_subs = {}
|
||||
}
|
||||
function cmd:sub(route, func, def)
|
||||
dprint("Parsing " .. route)
|
||||
|
||||
def = def or {}
|
||||
if string.trim then
|
||||
route = string.trim(route)
|
||||
end
|
||||
|
||||
local sub = {
|
||||
pattern = "^",
|
||||
params = {},
|
||||
func = func
|
||||
}
|
||||
|
||||
-- End of param reached: add it to the pattern
|
||||
local param = ""
|
||||
local param_type = ""
|
||||
local should_be_eos = false
|
||||
local function finishParam()
|
||||
if param ~= "" and param_type ~= "" then
|
||||
dprint(" - Found param " .. param .. " type " .. param_type)
|
||||
|
||||
local pattern = ChatCmdBuilder.types[param_type]
|
||||
if not pattern then
|
||||
error("Unrecognised param_type=" .. param_type)
|
||||
end
|
||||
|
||||
sub.pattern = sub.pattern .. pattern
|
||||
|
||||
table.insert(sub.params, param_type)
|
||||
|
||||
param = ""
|
||||
param_type = ""
|
||||
end
|
||||
end
|
||||
|
||||
-- Iterate through the route to find params
|
||||
local state = STATE_READY
|
||||
local catching_space = false
|
||||
local match_space = " " -- change to "%s" to also catch tabs and newlines
|
||||
local catch_space = match_space.."+"
|
||||
for i = 1, #route do
|
||||
local c = route:sub(i, i)
|
||||
if should_be_eos then
|
||||
error("Should be end of string. Nothing is allowed after a param of type text.")
|
||||
end
|
||||
|
||||
if state == STATE_READY then
|
||||
if c == ":" then
|
||||
dprint(" - Found :, entering param")
|
||||
state = STATE_PARAM
|
||||
param_type = "word"
|
||||
catching_space = false
|
||||
elseif c:match(match_space) then
|
||||
print(" - Found space")
|
||||
if not catching_space then
|
||||
catching_space = true
|
||||
sub.pattern = sub.pattern .. catch_space
|
||||
end
|
||||
else
|
||||
catching_space = false
|
||||
sub.pattern = sub.pattern .. escape(c)
|
||||
end
|
||||
elseif state == STATE_PARAM then
|
||||
if c == ":" then
|
||||
dprint(" - Found :, entering param type")
|
||||
state = STATE_PARAM_TYPE
|
||||
param_type = ""
|
||||
elseif c:match(match_space) then
|
||||
print(" - Found whitespace, leaving param")
|
||||
state = STATE_READY
|
||||
finishParam()
|
||||
catching_space = true
|
||||
sub.pattern = sub.pattern .. catch_space
|
||||
elseif c:match("%W") then
|
||||
dprint(" - Found nonalphanum, leaving param")
|
||||
state = STATE_READY
|
||||
finishParam()
|
||||
sub.pattern = sub.pattern .. escape(c)
|
||||
else
|
||||
param = param .. c
|
||||
end
|
||||
elseif state == STATE_PARAM_TYPE then
|
||||
if c:match(match_space) then
|
||||
print(" - Found space, leaving param type")
|
||||
state = STATE_READY
|
||||
finishParam()
|
||||
catching_space = true
|
||||
sub.pattern = sub.pattern .. catch_space
|
||||
elseif c:match("%W") then
|
||||
dprint(" - Found nonalphanum, leaving param type")
|
||||
state = STATE_READY
|
||||
finishParam()
|
||||
sub.pattern = sub.pattern .. escape(c)
|
||||
else
|
||||
param_type = param_type .. c
|
||||
end
|
||||
end
|
||||
end
|
||||
dprint(" - End of route")
|
||||
finishParam()
|
||||
sub.pattern = sub.pattern .. "$"
|
||||
dprint("Pattern: " .. sub.pattern)
|
||||
|
||||
table.insert(self._subs, sub)
|
||||
end
|
||||
|
||||
if func then
|
||||
func(cmd)
|
||||
end
|
||||
|
||||
cmd.run = function(name, param)
|
||||
for i = 1, #cmd._subs do
|
||||
local sub = cmd._subs[i]
|
||||
local res = { string.match(param, sub.pattern) }
|
||||
if #res > 0 then
|
||||
local pointer = 1
|
||||
local params = { name }
|
||||
for j = 1, #sub.params do
|
||||
local param = sub.params[j]
|
||||
if param == "pos" then
|
||||
local pos = {
|
||||
x = tonumber(res[pointer]),
|
||||
y = tonumber(res[pointer + 1]),
|
||||
z = tonumber(res[pointer + 2])
|
||||
}
|
||||
table.insert(params, pos)
|
||||
pointer = pointer + 3
|
||||
elseif param == "number" or param == "int" then
|
||||
table.insert(params, tonumber(res[pointer]))
|
||||
pointer = pointer + 1
|
||||
else
|
||||
table.insert(params, res[pointer])
|
||||
pointer = pointer + 1
|
||||
end
|
||||
end
|
||||
if table.unpack then
|
||||
-- lua 5.2 or later
|
||||
return sub.func(table.unpack(params))
|
||||
else
|
||||
-- lua 5.1 or earlier
|
||||
return sub.func(unpack(params))
|
||||
end
|
||||
end
|
||||
end
|
||||
return false, "Invalid command"
|
||||
end
|
||||
|
||||
return cmd
|
||||
end
|
||||
|
||||
local function run_tests()
|
||||
if not (ChatCmdBuilder.build(function(cmd)
|
||||
cmd:sub("bar :one and :two:word", function(name, one, two)
|
||||
if name == "singleplayer" and one == "abc" and two == "def" then
|
||||
return true
|
||||
end
|
||||
end)
|
||||
end)).run("singleplayer", "bar abc and def") then
|
||||
error("Test 1 failed")
|
||||
end
|
||||
|
||||
local move = ChatCmdBuilder.build(function(cmd)
|
||||
cmd:sub("move :target to :pos:pos", function(name, target, pos)
|
||||
if name == "singleplayer" and target == "player1" and
|
||||
pos.x == 0 and pos.y == 1 and pos.z == 2 then
|
||||
return true
|
||||
end
|
||||
end)
|
||||
end).run
|
||||
if not move("singleplayer", "move player1 to 0,1,2") then
|
||||
error("Test 2 failed")
|
||||
end
|
||||
if not move("singleplayer", "move player1 to (0,1,2)") then
|
||||
error("Test 3 failed")
|
||||
end
|
||||
if not move("singleplayer", "move player1 to 0, 1,2") then
|
||||
error("Test 4 failed")
|
||||
end
|
||||
if not move("singleplayer", "move player1 to 0 ,1, 2") then
|
||||
error("Test 5 failed")
|
||||
end
|
||||
if not move("singleplayer", "move player1 to 0, 1, 2") then
|
||||
error("Test 6 failed")
|
||||
end
|
||||
if not move("singleplayer", "move player1 to 0 ,1 ,2") then
|
||||
error("Test 7 failed")
|
||||
end
|
||||
if not move("singleplayer", "move player1 to ( 0 ,1 ,2)") then
|
||||
error("Test 8 failed")
|
||||
end
|
||||
if move("singleplayer", "move player1 to abc,def,sdosd") then
|
||||
error("Test 9 failed")
|
||||
end
|
||||
if move("singleplayer", "move player1 to abc def sdosd") then
|
||||
error("Test 10 failed")
|
||||
end
|
||||
|
||||
if not (ChatCmdBuilder.build(function(cmd)
|
||||
cmd:sub("does :one:int plus :two:int equal :three:int", function(name, one, two, three)
|
||||
if name == "singleplayer" and one + two == three then
|
||||
return true
|
||||
end
|
||||
end)
|
||||
end)).run("singleplayer", "does 1 plus 2 equal 3") then
|
||||
error("Test 11 failed")
|
||||
end
|
||||
|
||||
local checknegint = ChatCmdBuilder.build(function(cmd)
|
||||
cmd:sub("checknegint :x:int", function(name, x)
|
||||
return x
|
||||
end)
|
||||
end).run
|
||||
if checknegint("checker","checknegint -2") ~= -2 then
|
||||
error("Test 12 failed")
|
||||
end
|
||||
|
||||
local checknegnumber = ChatCmdBuilder.build(function(cmd)
|
||||
cmd:sub("checknegnumber :x:number", function(name, x)
|
||||
return x
|
||||
end)
|
||||
end).run
|
||||
if checknegnumber("checker","checknegnumber -3.3") ~= -3.3 then
|
||||
error("Test 13 failed")
|
||||
end
|
||||
|
||||
local checknegpos = ChatCmdBuilder.build(function(cmd)
|
||||
cmd:sub("checknegpos :pos:pos", function(name, pos)
|
||||
return pos
|
||||
end)
|
||||
end).run
|
||||
local negpos = checknegpos("checker","checknegpos (-13.3,-4.6,-1234.5)")
|
||||
if negpos.x ~= -13.3 or negpos.y ~= -4.6 or negpos.z ~= -1234.5 then
|
||||
error("Test 14 failed")
|
||||
end
|
||||
|
||||
local checktypes = ChatCmdBuilder.build(function(cmd)
|
||||
cmd:sub("checktypes :int:int :number:number :pos:pos :word:word :text:text", function(name, int, number, pos, word, text)
|
||||
return int, number, pos.x, pos.y, pos.z, word, text
|
||||
end)
|
||||
end).run
|
||||
local int, number, posx, posy, posz, word, text
|
||||
int, number, posx, posy, posz, word, text = checktypes("checker","checktypes -1 -2.4 (-3,-5.3,6.12) some text to finish off with")
|
||||
--dprint(int, number, posx, posy, posz, word, text)
|
||||
if int ~= -1 or number ~= -2.4 or posx ~= -3 or posy ~= -5.3 or posz ~= 6.12 or word ~= "some" or text ~= "text to finish off with" then
|
||||
error("Test 15 failed")
|
||||
end
|
||||
dprint("All tests passed")
|
||||
|
||||
end
|
||||
if not minetest then
|
||||
run_tests()
|
||||
end
|
|
@ -0,0 +1,61 @@
|
|||
-- THIS REGISTERS ALL IN-CHAT COMMANDS --
|
||||
|
||||
ChatCmdBuilder.new("murderadmin", function(cmd)
|
||||
|
||||
-- create arena
|
||||
cmd:sub("create :arena", function(name, arena_name)
|
||||
arena_lib.create_arena(name, arena_name)
|
||||
end)
|
||||
|
||||
cmd:sub("create :arena :minplayers:int :maxplayers:int", function(name, arena_name, min_players, max_players)
|
||||
arena_lib.create_arena(name, arena_name, min_players, max_players)
|
||||
end)
|
||||
|
||||
-- remove arena
|
||||
cmd:sub("remove :arena", function(name, arena_name)
|
||||
arena_lib.remove_arena(name, arena_name)
|
||||
end)
|
||||
|
||||
-- list of the arenas
|
||||
cmd:sub("list", function(name)
|
||||
arena_lib.print_arenas(name)
|
||||
end)
|
||||
|
||||
-- info on a specific arena
|
||||
cmd:sub("info :arena", function(name, arena_name)
|
||||
arena_lib.print_arena_info(name, arena_name)
|
||||
end)
|
||||
|
||||
-- info on game stats
|
||||
cmd:sub("score :arena", function(name, arena_name)
|
||||
arena_lib.print_arena_stats(name, arena_name)
|
||||
end)
|
||||
|
||||
-- this sets the spawns using the player position
|
||||
cmd:sub("setspawn :arena", function(name, arena)
|
||||
arena_lib.set_spawner(name, arena)
|
||||
end)
|
||||
|
||||
cmd:sub("setspawn :arena :spawnID:int", function(name, arena, spawn_ID)
|
||||
arena_lib.set_spawner(name, arena, spawn_ID)
|
||||
end)
|
||||
|
||||
|
||||
-- this sets the sign used to enter the arena
|
||||
cmd:sub("setsign :arena", function(name, arena)
|
||||
arena_lib.set_sign(name, arena)
|
||||
end)
|
||||
|
||||
-- enable and disable arenas
|
||||
cmd:sub("enable :arenaID:number", function(name, arenaID)
|
||||
arena_lib.enable_arena(name, arenaID)
|
||||
end)
|
||||
|
||||
cmd:sub("disable :arenaID:number", function(name, arenaID)
|
||||
arena_lib.disable_arena(name, arenaID)
|
||||
end)
|
||||
|
||||
end, {
|
||||
description = "description",
|
||||
privs = { murder_admin = true }
|
||||
})
|
|
@ -0,0 +1,5 @@
|
|||
default
|
||||
signs_lib
|
||||
carts?
|
||||
doors?
|
||||
flowers?
|
|
@ -0,0 +1,18 @@
|
|||
dofile(minetest.get_modpath("murder") .. "/items.lua")
|
||||
dofile(minetest.get_modpath("murder") .. "/arena_lib/api.lua")
|
||||
dofile(minetest.get_modpath("murder") .. "/chatcmdbuilder.lua")
|
||||
dofile(minetest.get_modpath("murder") .. "/commands.lua")
|
||||
dofile(minetest.get_modpath("murder") .. "/roles_manager.lua")
|
||||
dofile(minetest.get_modpath("murder") .. "/kill_manager.lua")
|
||||
|
||||
arena_lib.settings({
|
||||
prefix = "Murder > "
|
||||
})
|
||||
|
||||
minetest.register_privilege("murder_admin", {
|
||||
|
||||
description = "With this you can use /murderadmin"
|
||||
|
||||
})
|
||||
|
||||
register_items()
|
|
@ -0,0 +1,127 @@
|
|||
-- THIS REGISTER ALL THE ITEMS AND THEIR LOGIC --
|
||||
|
||||
function register_items()
|
||||
|
||||
-- The knife used by the murderer
|
||||
minetest.register_craftitem("murder:knife", {
|
||||
description = "With this you can kill other player, seems fun, doesn't it?",
|
||||
inventory_image = "knife.png",
|
||||
damage_groups = {fleshy = 3},
|
||||
groups = {murder_weapon = 1},
|
||||
stack_max = 1,
|
||||
on_use =
|
||||
function(_, player, pointed_thing)
|
||||
-- If the knife is used on a player kill him
|
||||
if pointed_thing.type == "object" and pointed_thing.ref:is_player() then
|
||||
local hit_pl = pointed_thing.ref
|
||||
hit_pl:set_hp(0)
|
||||
minetest.chat_send_player(player:get_player_name(), "You murdered " .. hit_pl:get_player_name())
|
||||
end
|
||||
end
|
||||
})
|
||||
|
||||
|
||||
-- The following chip used by the murderer
|
||||
minetest.register_craftitem("murder:following_chip", {
|
||||
description = "Left click on a player to attach it to him, you will see his movements for 12s",
|
||||
inventory_image = "following_chip.png",
|
||||
stack_max = 1,
|
||||
on_use =
|
||||
function(_, player, pointed_thing)
|
||||
-- If he uses this on a player
|
||||
if pointed_thing.type == "object" and pointed_thing.ref:is_player() then
|
||||
local hit_pl = pointed_thing.ref
|
||||
local inv = player:get_inventory()
|
||||
|
||||
-- Create a particle spawner attached to the victim's position:
|
||||
-- it will spawn 64 particles in 12 seconds that the murderer can follow
|
||||
minetest.add_particlespawner{
|
||||
amount = 64,
|
||||
time = 12,
|
||||
minpos = {x=0, y=1, z=0},
|
||||
maxpos = {x=0, y=1, z=0},
|
||||
minexptime = 12,
|
||||
maxexptime = 12,
|
||||
minsize = 3,
|
||||
maxsize = 3,
|
||||
texture = "follow_particle.png",
|
||||
glow = 10,
|
||||
attached = hit_pl,
|
||||
playername = player:get_player_name(),
|
||||
}
|
||||
|
||||
-- Removes the chip from the inventory
|
||||
minetest.after(0, function() inv:remove_item("main", "murder:following_chip") end)
|
||||
minetest.chat_send_player(player:get_player_name(), "You're now following " .. hit_pl:get_player_name())
|
||||
end
|
||||
end
|
||||
})
|
||||
|
||||
|
||||
-- The sprint serum used by the murderer
|
||||
minetest.register_craftitem("murder:sprint_serum", {
|
||||
description = "Boost your speed for 6s",
|
||||
inventory_image = "sprint_serum.png",
|
||||
stack_max = 1,
|
||||
|
||||
on_use =
|
||||
function (_, player)
|
||||
local inv = player:get_inventory()
|
||||
|
||||
-- It removes this item from the player inventory, then it sets and resets the player speed
|
||||
minetest.after(0,
|
||||
function()
|
||||
inv:remove_item("main", "murder:sprint_serum")
|
||||
end)
|
||||
player: set_physics_override({ speed = 2 })
|
||||
minetest.after(6, function() player: set_physics_override({ speed = 1 }) end)
|
||||
minetest.chat_send_player(player:get_player_name(), "You feel electrified!")
|
||||
end
|
||||
})
|
||||
|
||||
|
||||
-- The gun used by the cop
|
||||
minetest.register_craftitem("murder:gun", {
|
||||
description = "Kill the murderer with this, but beware you only have one bullet!",
|
||||
inventory_image = "gun.png",
|
||||
groups = {gun = 1},
|
||||
stack_max = 1,
|
||||
on_use =
|
||||
function(_, player)
|
||||
local pl_pos = player:get_pos()
|
||||
local pos_head = {x = pl_pos.x, y = pl_pos.y+1.5, z = pl_pos.z}
|
||||
local shoot_range = 50
|
||||
local shoot_dir = vector.multiply(player:get_look_dir(), shoot_range)
|
||||
-- Casts a ray from the player head position 'till the same position * shoot_range
|
||||
local ray = minetest.raycast(vector.add(pos_head, vector.divide(player:get_look_dir(), 4)), vector.add(pos_head, shoot_dir), true, false)
|
||||
local particle_shot = {
|
||||
pos = pos_head,
|
||||
velocity = vector.multiply(shoot_dir, 2),
|
||||
size = 1,
|
||||
texture = "shoot_particle.png",
|
||||
glow = 12
|
||||
}
|
||||
|
||||
minetest.add_particle(particle_shot)
|
||||
-- This checks for each object that the raycast hit if it is a player, if it is it kills him
|
||||
for hit in ray do
|
||||
if hit.type == "object" and hit.ref:is_player() and hit.ref:get_player_name() ~= player:get_player_name() then
|
||||
hit.ref:set_hp(0, "shot")
|
||||
break
|
||||
end
|
||||
end
|
||||
|
||||
-- Replace this itemstack with the empty gun
|
||||
return "murder:empty_gun"
|
||||
end
|
||||
})
|
||||
|
||||
|
||||
-- Gun without bullets
|
||||
minetest.register_craftitem("murder:empty_gun", {
|
||||
description = "This gun has no bullets.",
|
||||
inventory_image = "gun.png",
|
||||
stack_max = 1,
|
||||
})
|
||||
end
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
-- THIS HANDLES IN-GAME KILLS --
|
||||
|
||||
minetest.register_on_dieplayer(
|
||||
function(player)
|
||||
local p_name = player:get_player_name()
|
||||
local arenaID = arena_lib.get_arenaID_by_player(p_name)
|
||||
local arena = arena_lib.arenas[arenaID]
|
||||
|
||||
-- If the player is in an arena
|
||||
if arena_lib.is_player_in_arena(p_name) then
|
||||
|
||||
-- If someone kills the murderer the match finishes and victims win
|
||||
if arena.murderer == p_name then
|
||||
for pl_name in pairs(arena.players) do
|
||||
minetest.chat_send_player(pl_name, "The murderer has been killed by " .. arena.cop .. ", victims won the game!")
|
||||
end
|
||||
arena_lib.end_arena(arena)
|
||||
|
||||
-- If the murderer kills everyone the match finishes and he wins
|
||||
-- (the reason why it checks if there are only 2 players left instead of 1 is because when a player gets killed he doesn't automatically get kicked out from the arena)
|
||||
elseif arena_lib.get_arena_players_count(arenaID) == 2 then
|
||||
for pl_name in pairs(arena.players) do
|
||||
minetest.chat_send_player(pl_name, arena.murderer .. " the murderer won!")
|
||||
end
|
||||
arena_lib.end_arena(arena)
|
||||
|
||||
-- When somebody dies this sends a message to him
|
||||
else
|
||||
arena_lib.remove_player_from_arena(p_name)
|
||||
minetest.chat_send_player(p_name, "You've been killed!")
|
||||
end
|
||||
end
|
||||
end)
|
|
@ -0,0 +1,2 @@
|
|||
name = murder
|
||||
description = Murder or survive to the murderer
|
|
@ -0,0 +1,13 @@
|
|||
# Minetest Murder
|
||||
|
||||
Murder mod for Minetest
|
||||
|
||||
### Dependencies
|
||||
* (already inside) [arena_lib](https://gitlab.com/zughy-friends-minetest/arena_lib/) by Zughy and friends
|
||||
* (already inside) [ChatCMDBuilder](https://github.com/rubenwardy/ChatCmdBuilder/) by rubenwardy
|
||||
* Default
|
||||
* [signs_lib](https://gitlab.com/VanessaE/signs_lib) by Vanessa Dannenberg
|
||||
|
||||
|
||||
### Resources
|
||||
Textures by me
|
|
@ -0,0 +1,45 @@
|
|||
-- THIS RANDOMLY DECIDES WHICH PLAYER IS THE MURDERER --
|
||||
|
||||
function arena_lib.on_start(arena)
|
||||
local players_count = 0
|
||||
-- Counts how many players there are in the arena
|
||||
for _ in pairs(arena.players) do
|
||||
players_count = players_count + 1
|
||||
end
|
||||
|
||||
-- Chooses a random number between 1 and players_count
|
||||
-- os.clock is used as seed, because its value constantly changes
|
||||
local random_murderer = PcgRandom(os.clock()):next(1, players_count)
|
||||
local random_cop = random_murderer
|
||||
local randomizer = 2
|
||||
|
||||
-- This randomly generates the random cop until it is different from the murderer
|
||||
while random_cop == random_murderer do
|
||||
random_cop = PcgRandom(os.clock() * randomizer):next(1, players_count)
|
||||
randomizer = randomizer + 1
|
||||
end
|
||||
players_count = 0
|
||||
|
||||
for pl_name, _ in pairs(arena.players) do
|
||||
players_count = players_count + 1
|
||||
local player_inv = minetest.get_player_by_name(pl_name):get_inventory()
|
||||
|
||||
-- If this player is the murderer update his inventory
|
||||
if players_count == random_murderer then
|
||||
arena.murderer = pl_name
|
||||
minetest.chat_send_player(pl_name, "You are the murderer!")
|
||||
player_inv:add_item("main", "murder:knife")
|
||||
player_inv:add_item("main", "murder:following_chip")
|
||||
player_inv:add_item("main", "murder:sprint_serum")
|
||||
|
||||
-- If this player is the cop update his inventory
|
||||
elseif players_count == random_cop then
|
||||
arena.cop = pl_name
|
||||
minetest.chat_send_player(pl_name, "You are the cop!")
|
||||
player_inv:add_item("main", "murder:gun")
|
||||
|
||||
else
|
||||
minetest.chat_send_player(pl_name, "You are a victim!")
|
||||
end
|
||||
end
|
||||
end
|
After Width: | Height: | Size: 313 B |
After Width: | Height: | Size: 390 B |
After Width: | Height: | Size: 194 B |
After Width: | Height: | Size: 197 B |
After Width: | Height: | Size: 402 B |
After Width: | Height: | Size: 197 B |
After Width: | Height: | Size: 248 B |
After Width: | Height: | Size: 174 B |
After Width: | Height: | Size: 221 B |