nzp-team/documentation
0
0
Fork 0
mirror of https://github.com/nzp-team/documentation.git synced 2024-11-09 22:21:43 +00:00
Code Issues Projects Releases Packages Wiki Activity

Initial Commit

Browse source
This commit is contained in:
MotoLegacy 2024-06-19 16:20:50 -07:00
commit 73fcb83872
58 changed files with 2577 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
.github/workflows/deploy-to-neocities.yml vendored Normal file
View file

@ -0,0 +1,35 @@
name: Deploy to neocities
on: [push]
# https://github.com/marketplace/actions/deploy-to-neocities
# only run on changes to main. Use main or master depending on whatever your default branch is called.
on:
push:
branches:
- main
concurrency: # prevent concurrent deploys doing strange things
group: deploy-to-neocities
cancel-in-progress: true
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
# Set up any tools and build steps here
# This example uses a Node.js toolchain to build a site
- name: Install Pandoc
run: |
apt update && apt install -y pandoc
- name: Build Page
working-directory: ./
run: |
./generate_docs.sh
# When the dist_dir is ready, deploy it to neocities
- name: Deploy to neocities
uses: bcomnes/deploy-to-neocities@v2
with:
api_token: ${{ secrets.NEOCITIES_API_TOKEN }}
cleanup: false
dist_dir: build

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
build/

428
LICENSE_content.txt Normal file
View file

@ -0,0 +1,428 @@
Attribution-ShareAlike 4.0 International
=======================================================================
Creative Commons Corporation ("Creative Commons") is not a law firm and
does not provide legal services or legal advice. Distribution of
Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
information available on an "as-is" basis. Creative Commons gives no
warranties regarding its licenses, any material licensed under their
terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
fullest extent possible.
Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and
conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright
and certain other rights specified in the public license below. The
following considerations are for informational purposes only, are not
exhaustive, and do not form part of our licenses.
Considerations for licensors: Our public licenses are
intended for use by those authorized to give the public
permission to use material in ways otherwise restricted by
copyright and certain other rights. Our licenses are
irrevocable. Licensors should read and understand the terms
and conditions of the license they choose before applying it.
Licensors should also secure all rights necessary before
applying our licenses so that the public can reuse the
material as expected. Licensors should clearly mark any
material not subject to the license. This includes other CC-
licensed material, or material used under an exception or
limitation to copyright. More considerations for licensors:
wiki.creativecommons.org/Considerations_for_licensors
Considerations for the public: By using one of our public
licenses, a licensor grants the public permission to use the
licensed material under specified terms and conditions. If
the licensor's permission is not necessary for any reason--for
example, because of any applicable exception or limitation to
copyright--then that use is not regulated by the license. Our
licenses grant only permissions under copyright and certain
other rights that a licensor has authority to grant. Use of
the licensed material may still be restricted for other
reasons, including because others have copyright or other
rights in the material. A licensor may make special requests,
such as asking that all changes be marked or described.
Although not required by our licenses, you are encouraged to
respect those requests where reasonable. More considerations
for the public:
wiki.creativecommons.org/Considerations_for_licensees
=======================================================================
Creative Commons Attribution-ShareAlike 4.0 International Public
License
By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution-ShareAlike 4.0 International Public License ("Public
License"). To the extent this Public License may be interpreted as a
contract, You are granted the Licensed Rights in consideration of Your
acceptance of these terms and conditions, and the Licensor grants You
such rights in consideration of benefits the Licensor receives from
making the Licensed Material available under these terms and
conditions.
Section 1 -- Definitions.
a. Adapted Material means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material
and in which the Licensed Material is translated, altered,
arranged, transformed, or otherwise modified in a manner requiring
permission under the Copyright and Similar Rights held by the
Licensor. For purposes of this Public License, where the Licensed
Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.
c. BY-SA Compatible License means a license listed at
creativecommons.org/compatiblelicenses, approved by Creative
Commons as essentially the equivalent of this Public License.
d. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.
e. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.
f. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.
g. License Elements means the license attributes listed in the name
of a Creative Commons Public License. The License Elements of this
Public License are Attribution and ShareAlike.
h. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.
i. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.
j. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.
k. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.
l. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.
m. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.
Section 2 -- Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License,
the Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to
exercise the Licensed Rights in the Licensed Material to:
a. reproduce and Share the Licensed Material, in whole or
in part; and
b. produce, reproduce, and Share Adapted Material.
2. Exceptions and Limitations. For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public
License does not apply, and You do not need to comply with
its terms and conditions.
3. Term. The term of this Public License is specified in Section
6(a).
4. Media and formats; technical modifications allowed. The
Licensor authorizes You to exercise the Licensed Rights in
all media and formats whether now known or hereafter created,
and to make technical modifications necessary to do so. The
Licensor waives and/or agrees not to assert any right or
authority to forbid You from making technical modifications
necessary to exercise the Licensed Rights, including
technical modifications necessary to circumvent Effective
Technological Measures. For purposes of this Public License,
simply making modifications authorized by this Section 2(a)
(4) never produces Adapted Material.
5. Downstream recipients.
a. Offer from the Licensor -- Licensed Material. Every
recipient of the Licensed Material automatically
receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this
Public License.
b. Additional offer from the Licensor -- Adapted Material.
Every recipient of Adapted Material from You
automatically receives an offer from the Licensor to
exercise the Licensed Rights in the Adapted Material
under the conditions of the Adapter's License You apply.
c. No downstream restrictions. You may not offer or impose
any additional or different terms or conditions on, or
apply any Effective Technological Measures to, the
Licensed Material if doing so restricts exercise of the
Licensed Rights by any recipient of the Licensed
Material.
6. No endorsement. Nothing in this Public License constitutes or
may be construed as permission to assert or imply that You
are, or that Your use of the Licensed Material is, connected
with, or sponsored, endorsed, or granted official status by,
the Licensor or others designated to receive attribution as
provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not
licensed under this Public License, nor are publicity,
privacy, and/or other similar personality rights; however, to
the extent possible, the Licensor waives and/or agrees not to
assert any such rights held by the Licensor to the limited
extent necessary to allow You to exercise the Licensed
Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this
Public License.
3. To the extent possible, the Licensor waives any right to
collect royalties from You for the exercise of the Licensed
Rights, whether directly or through a collecting society
under any voluntary or waivable statutory or compulsory
licensing scheme. In all other cases the Licensor expressly
reserves any right to collect such royalties.
Section 3 -- License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the
following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified
form), You must:
a. retain the following if it is supplied by the Licensor
with the Licensed Material:
i. identification of the creator(s) of the Licensed
Material and any others designated to receive
attribution, in any reasonable manner requested by
the Licensor (including by pseudonym if
designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of
warranties;
v. a URI or hyperlink to the Licensed Material to the
extent reasonably practicable;
b. indicate if You modified the Licensed Material and
retain an indication of any previous modifications; and
c. indicate the Licensed Material is licensed under this
Public License, and include the text of, or the URI or
hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any
reasonable manner based on the medium, means, and context in
which You Share the Licensed Material. For example, it may be
reasonable to satisfy the conditions by providing a URI or
hyperlink to a resource that includes the required
information.
3. If requested by the Licensor, You must remove any of the
information required by Section 3(a)(1)(A) to the extent
reasonably practicable.
b. ShareAlike.
In addition to the conditions in Section 3(a), if You Share
Adapted Material You produce, the following conditions also apply.
1. The Adapter's License You apply must be a Creative Commons
license with the same License Elements, this version or
later, or a BY-SA Compatible License.
2. You must include the text of, or the URI or hyperlink to, the
Adapter's License You apply. You may satisfy this condition
in any reasonable manner based on the medium, means, and
context in which You Share Adapted Material.
3. You may not offer or impose any additional or different terms
or conditions on, or apply any Effective Technological
Measures to, Adapted Material that restrict exercise of the
rights granted under the Adapter's License You apply.
Section 4 -- Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database;
b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material,
including for purposes of Section 3(b); and
c. You must comply with the conditions in Section 3(a) if You Share
all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent
possible, most closely approximates an absolute disclaimer and
waiver of all liability.
Section 6 -- Term and Termination.
a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
this Public License, then Your rights under this Public License
terminate automatically.
b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided
it is cured within 30 days of Your discovery of the
violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any
right the Licensor may have to seek remedies for Your violations
of this Public License.
c. For the avoidance of doubt, the Licensor may also offer the
Licensed Material under separate terms or conditions or stop
distributing the Licensed Material at any time; however, doing so
will not terminate this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.
Section 7 -- Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different
terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and
independent of the terms and conditions of this Public License.
Section 8 -- Interpretation.
a. For the avoidance of doubt, this Public License does not, and
shall not be interpreted to, reduce, limit, restrict, or impose
conditions on any use of the Licensed Material that could lawfully
be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.
c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.
d. Nothing in this Public License constitutes or may be interpreted
as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
processes of any jurisdiction or authority.
=======================================================================
Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
will be considered the “Licensor.” The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
creativecommons.org/policies, Creative Commons does not authorize the
use of the trademark "Creative Commons" or any other trademark or logo
of Creative Commons without its prior written consent including,
without limitation, in connection with any unauthorized modifications
to any of its public licenses or any other arrangements,
understandings, or agreements concerning use of licensed material. For
the avoidance of doubt, this paragraph does not form part of the
public licenses.
Creative Commons may be contacted at creativecommons.org.

674
LICENSE_template.txt Normal file
View file

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://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.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 <https://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:
<program> Copyright (C) <year> <name of author>
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
<https://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
<https://www.gnu.org/licenses/why-not-lgpl.html>.

15
README.md Normal file
View file

@ -0,0 +1,15 @@
# Nazi Zombies: Portable Documentation
## About
This repository contains the "source code" for the [Nazi Zombies: Portable Documentation](https://docs.nzp.gay) page, hosted by Neocities.
The type of content, as described on the page itself, is geared towards Map Makers, Content Modders, etc. It is designed to be for "power users", more than general users.
## Building
[Pandoc](https://pandoc.org/) is a required dependency for building the Markdown source into HTML. Once installed, just run `generate_docs.sh`. HTML source will be generated in the newly created `build/` directory.
## Contributing
Contributions are welcome, provided they follow the existing pattern of material style and fit the general content type. It is important to consider that these documents are intended to be information first, and images only as supplemental content. `WebP` format images are used, with low quality settings and low base resolutions to keep these docs dense in information but small in disk footprint.
## Licensing
The content contained on the documentation page is licensed under [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), whereas the HTML template is GPLv3, as it is derived from the [TrenchBroom Manual](https://trenchbroom.github.io/manual/latest/).

6
generate_docs.sh Executable file
View file

@ -0,0 +1,6 @@
#!/bin/bash
rm -rf build/
mkdir -p build/{res,landing,mapping,internal}
cp -r markdown/res build/
mkdir -p build/ && cd markdown/
find . -iname "*.md" -type f -exec sh -c 'pandoc --standalone --toc --template ../template/template.html --from=markdown --to=html5 --lua-filter=../links-to-html.lua -o "../build/${0%.md}.html" "${0}"' {} \;

4
links-to-html.lua Normal file
View file

@ -0,0 +1,4 @@
function Link(el)
el.target = string.gsub(el.target, "%.md", ".html")
return el
end

108
markdown/internal/weapon-ids.md Normal file
View file

@ -0,0 +1,108 @@
% Weapon IDs - NZ:P Internal Documentation
# Weapon IDs
## Introduction
This documentation page serves as a list of Nazi Zombies: Portable's internal weapon identifiers, both numerical and string based. They are categorized based on weapon type first, then numerical ID. The format is as follows:
- Weapon Name - `internal_string` - `internal_number`
Note that Pack-A-Punch variants of weapons do not contain a string identifier at this time.
## Standard Weapons
### Bolt Action Rifles
- Kar98k - `kar98k` - `2`
- Scoped Kar98k - `kar98k_scoped` - `11`
- PTRS-41 - `ptrs-41` - `19`
- Springfield - `springfield` - `58`
### Rifles
- Gewehr - `gewehr` - `10`
- M1 Garand - `m1_garand` - `12`
- M1A1 Carbine - `m1a1_carbine` - `13`
- STG-44 - `stg-44` - `22`
### Submachine Guns
- Thompson - `thompson` - `3`
- MP40 - `mp40` - `15`
- PPSh-41 - `ppsh` - `18`
- Type 100 - `type_100` - `24`
### Shotguns
- Double-Barreled Shotgun - `double_barreled_shotgun` - `8`
- Sawed-Off Shotgun - `sawed_off_shotgun` - `21`
- M1897 Trench Gun - `trenchgun` - `23`
### Machine Guns
- BAR - `bar` - `5`
- FG42 - `fg42` - `9`
- MG42 - `mg42` - `16`
- Browning M1919 - `browning` - `7`
### Pistols
- Colt M1911 - `m1911` - `1`
- .357 Magnum - `357_magnum` - `4`
### Special Weapons
- Ballistic Knife - `ballistic_knife` - `6`
- M2 Flamethrower - `m2_flamethrower` - `14`
- Panzerschreck - `panzerschreck` - `17`
- Ray Gun - `ray_gun` - `20`
- Wunderwaffe DG-2 - `wunderwaffe` - `56`
## Pack-A-Punch Weapons
### Bolt Action Rifles
- Armageddon (Kar 98k) - `36`
- Headcracker (Scoped Kar 98k) - `49`
- The Penetrator (PTRS-41) - `51`
- Pulverizer (Springfield) - `59`
### Rifles
- G115 Compressor (Gewehr) - `30`
- M1000 (M1 Garand) - `31`
- Widdershins RC-1 (M1A1 Carbine) - `34`
- Spatz-447 + (STG-44) - `41`
### Submachine Guns
- Gibs-O-Matic (Thompson) - `38`
- 1001 Samurais (Type 100) - `39`
- The Afterburner (MP40) - `40`
- The Reaper (PPSh-41) - `48`
### Shotguns
- 24 Bore Long Range (Double-Barreled Shotgun) - `43`
- The Snuff Box (Sawed-Off Shotgun) - `42`
- Gut Shot (M1897 Trench Gun) - `47`
### Machine Guns
- 420 Impeller (FG42) - `44`
- Barracuda FU-A11 (MG42) - `45`
- B115 Accelerator (Browning M1919) - `46`
- The Widow Maker (BAR) - `52`
### Pistols
- Mustang & Sally (Colt M1911) - `28`
- .357 Plus 1 K1L-u (.357 Magnum) - `29`
### Special Weapons
- Porter's X2 Ray Gun (Ray Gun) - `33`
- F1W Nitrogen Cooled (M2 Flamethrower) - `35`
- Longinus (Panzerschreck) - `50`
- The Krauss Refibrillator (Ballistic Knife) - `53`
- Wunderwaffe DG-3 JZ (Wunderwaffe DG-2) - `57`

51
markdown/landing/index.md Normal file
View file

@ -0,0 +1,51 @@
% Landing - NZ:P Documentation
# Nazi Zombies: Portable Documentation
## About
Welcome to the official Documentation landing page for Nazi Zombies: Portable, a _Call of Duty: Zombies_ remake running on several modified forks of the _Quake_ (1996) engine, licensed under GPLv2, with project assets under CC-BY-SA 4.0. The following platforms are supported:
- Windows (2000 and above, x86 and x86_64)
- Linux (x86, x86_64, arm, arm64, armhf)
- PlayStation Portable (all models)
- PlayStation VITA
- Nintendo 3DS (all models)
- Nintendo Switch
This documentation is not designed to cover basic gameplay foundations such as the Power-Up system, what Perk-A-Cola machines are, etc., as those are bases covered by the official [_Call of Duty_ Wiki](https://callofduty.fandom.com/wiki/Call_of_Duty_Wiki). Nazi Zombies: Portable goes to great efforts to achieve parity with it's gameplay features in such a way that makes content on said wiki valid and applicable to this project as well.
All documentation and media hosted is licensed under CC-BY-SA 4.0, with no exclusions or exceptions.
## Downloading Nazi Zombies: Portable
At this current moment, no marked-stable builds of Nazi Zombies: Portable are made available. Instead, nightly builds on all platforms are released via GitHub releases, accessible [here](https://github.com/nzp-team/nzportable/releases/latest). This link will always take you to the latest release, identifiable via the build date in the release title.
## Core Documentation
Core documents contain information about Nazi Zombies: Portable's internal design. They are not specifically relevant to custom content creators, though overlap will be present for map features that interact with NZ:P's QuakeC.
- [Weapon IDs](../internal/weapon-ids.md)
## Mapping & Modding Documentation
These documents are relevant for level creators who wish to create content for Nazi Zombies: Portable. These documents assume you have basic knowledge of [mapping for Quake](https://www.youtube.com/playlist?list=PLgDKRPte5Y0AZ_K_PZbWbgBAEt5xf74aE), as well as [TrenchBroom](https://trenchbroom.github.io/) knowledge. Nazi Zombies: Portable also supports Valve HAMMER based mapping software via a separate FGD.
Documentation and by extension headers/categories are a work in progress.
### General
- [TrenchBroom Set-Up](../mapping/trenchbroom-setup.md)
- [Customizing Mystery Box Weapons](../mapping/mbox2-format.md)
- [Advanced Model Exporting](../mapping/model-exporting.md)
### Map Entities
- [Barricades](../mapping/barricades.md)
- [Explosive Barrels](../mapping/explosive-barrels.md)
- [Player Spawn Points](../mapping/player-spawns.md)
- [Wall Weapons](../mapping/wall-weapons.md)
- [Zombie Horde Points](../mapping/zombie-horde-points.md)
- [Random Perk-A-Cola Machines](../mapping/random-perks.md)
### Map Triggers
- [trigger_setfire](../mapping/trigger_setfire.md)
- [trigger_awardpoints](../mapping/trigger_awardpoints.md)
- [trigger_interact](../mapping/trigger_interact.md)
- [trigger_atroundend](../mapping/trigger_atroundend.md)

53
markdown/mapping/barricades.md Normal file
View file

@ -0,0 +1,53 @@
% Barricades - NZ:P Mapping Documentation
# Barricades
__NOTE: This guide uses the terms "level" and "map" interchangeably.__
## Introduction
![A Barricade in _Nacht der Untoten_](../res/images/barricade.webp)
Barricades in Nazi Zombies: Portable are points of entry for Zombies. They can consist of six "planks" maximum and are destroyed by AI before becoming an obstacle that can be hopped over until repaired by the player (if applicable). They are placed via the `item_barricade` entity.
## Pathing to Barricades
Zombies, when outside, follow a creator-determined path via `target` linking. They will walk directly towards their targets, with the end goal being to reach a barricade.
### Simple Paths
![A simple path from a Zombie directly to a barricade, illustrated via the red arrow](../res/images/barricade_path_simple.webp)
For paths where a Zombie spawn point is directly in the view of a barricade, and the barricade can be reached via a straight line, the level creator can make the barricade directly `target`ed by the spawn point.
### Complex Paths
![A complex path from a Zombie, to a `path_corner`, then to the barricade, forming a right angle.](../res/images/barricade_path_complex.webp)
For paths where the Zombie is expected to travel in a complicated route (e.g., around a bend), `path_corner` entities can be used the same way as _Quake_ to chain `target`s together and create a winding route.
## Cosmetic Feature Set
### Sounds and Model
![Setting custom sounds for a barricade](../res/images/barricade_custom_sound.webp)
Like other entities, a custom `model` and `skin` can be applied to barricades to change their visuals. The model provided must have a matching frame number as the existing barricade to be usable, and it is recommended to ensure the custom barricade model has the same amount of "planks" (six) to preserve the visual feedback for the player about a barricade's state.
Additionally, custom sounds for the `destroy` and `repair` state can be applied:
```
oldmodel : Rebuild Sound
aistatus : Destroy Sound
```
## Functional Feature Set
### Spawnflags
Barricades feature a single spawnflag, `No Boards/Not Repairable` (`1`), if your barricade serves as strictly a hop-able entry point that can not be repaired or concealed by the player.
### Starting and Maximum Board Count
Level creators have the ability to determine how many boards on a barricade are present on initial map load (`health` key), as well as how many of these boards are actually repairable (`health_delay` key). These are both limited to `6` boards maximum. To not conflict with levels created before the introduction of this feature (where the `health` key is not defined), creators must set starting number to `-1` in order to achieve the effect of a barricade being completely unrepaired on game start. This does not apply to maximum count, where `0` is valid.
These two values are not linked, meaning, having a starting board number greater than maximum is acceptable. This may be useful for level creators that want barricades to be a one-time use, as an example.

18
markdown/mapping/explosive-barrels.md Normal file
View file

@ -0,0 +1,18 @@
% Explosive Barrels - NZ:P Mapping Documentation
# Explosive Barrels
__NOTE: This guide uses the terms "level" and "map" interchangeably.__
## Introduction
![A group of Explosive Barrels in _Nacht der Untoten_](../res/images/explosive_barrel.webp)
Explosive Barrels are entities available in Nazi Zombies: Portable that act as passive defenses. Placed into a map via the `explosive_barrel` entity, they can be damaged by players to trigger an explosion, that can also be chain-reacted with other barrels in the area.
## Functionality
Upon contact, explosive barrels have health depleted like any other damage-able object. Once it's internal health is at or below zero, the barrel will explode. Where the barrels differ, however, is any damage dealt will begin an internal timer to automatically deplete it's health over time. This makes the barrel effectively serve as a ticking timebomb. The algorithm for automatic health depletion is `10 + (rint((random() * 10)))`. This calculation occurs once every one second. Barrels can still have their health depleted by the player while in this state.
## Feature Set
Barrels, when exploded, will fire `target`s. This feature is what is responsible for _Nacht der Untoten_'s secret song triggering after destroying all that are present in the level. Custom `models` and `skins` can also be provided like most other entities present in Nazi Zombies: Portable. Barrels can also be provided with a custom `health` value. If none are set, the default value of `300` is used.

BIN
markdown/mapping/image.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 56 KiB

99
markdown/mapping/mbox2-format.md Normal file
View file

@ -0,0 +1,99 @@
% Customizing Mystery Box Weapons - NZ:P Mapping Documentation
# Customizing Mystery Box Weapons
## Introduction
Nazi Zombies: Portable gives level creators the ability to customize what weapons exist in the Mystery Box. They have full-range of every non-Pack-A-Punch variant in the game. This is done via the `MBOX2` file format.
`MBOX2` files are created by the creator, placed in `nzp/maps/` with the name `mapname.mb2`, substituting `mapname` with the same file name as the level `.BSP`.
Here is an example file that simply disables the Ray Gun and Wunderwaffe DG-2 from appearing in the Mystery Box:
```
nzp_mbox2
deny:
ray_gun
wunderwaffe
```
## File Header
All `MBOX2` files must begin with the string "`nzp_mbox2`". This is done to ensure validity of the file. Nazi Zombies: Portable will not allow a level to load if it contains an `MBOX2` file that does not meet this requirement, and report the issue to the developer console.
## Allow vs. Deny
`MBOX2` has two modes: "`allow`" and "`deny`". Provided the `allow` command, all weapons listed will appear in the Mystery Box, and those not listed will automatically be excluded. Similarly when `deny` is used, all weapons will be included aside from the entries listed.
`MBOX2` only supports one command, it is recommended to use the command that has the shortest number of entries to decrease loading time for low powered platforms.
## Weapon Names
Eligible weapon names are provided via the [Weapon IDs](../internal/weapon-ids.md) documentation entry. If a weapon is listed that is not recognized by the game, the level will not be allowed to load, and the problematic weapon will be reported to the developer console.
## Backwards Compatibility
Nazi Zombies: Portable previously primarily utilized the `MBOX` 1.0 format, which was a string-binary list of hard-coded weapon order status. This format is still supported internally, meaning levels that previously utilized it will still function as intended. Additionally, while not recommended, it can still be utilized for new content. It uses the `.mbox` file extension.
### Format Example
The following is an example `MBOX` 1.0 file contents:
```
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
0
1
1
1
1
1
1
```
### Weapon Order
`MBOX` 1.0 files used a hard coded weapon order, that differs from the standard internal [Weapon IDs](../internal/weapon-ids.md) used by Nazi Zombies: Portable. The `MBOX` 1.0-exclusive listing follows:
- Colt M1911
- Kar98k
- Double-Barreled Shotgun
- MG42
- Ray Gun
- Thompson
- M2 Flamethrower
- PPSh-41
- Sawed-Off Shotgun
- Wunderwaffe DG-2
- M1A1 Carbine
- Gewehr
- FG42
- M1919 Browning
- Scoped Kar98k
- .357 Magnum
- STG-44
- Panzerschreck
- Ballistic Knife
- PTRS-41
- MP40
- M1897 Trench Gun
- BAR
- M1 Garand
- Type 100
- MP5K
- Springfield

31
markdown/mapping/model-exporting.md Normal file
View file

@ -0,0 +1,31 @@
% Advanced Model Exporting - NZ:P Mapping Documentation
# Advanced Model Exporting
__NOTE: This is not a guide for learning basic Blender or _Quake_ `.MDL` exporting concepts.__
## Introduction
Nazi Zombies: Portable uses the standard _Quake_ `.MDL` format for most of its props and other meshes. Specific to view models, however, it utilizes a special fork of the common [io_mesh_qfmdl](https://github.com/robrohan/blender_ie_quake_mdl) Blender export plugin, adapted to better support [Blender 2.9`X`](https://download.blender.org/release/Blender2.93/) and contain features to mitigate vertex swimming. That forked export plugin can be found [here](https://github.com/nzp-team/tools/tree/main/io_mesh_qfmdl_blubs).
![New `Properties` for `.MDL` files in the NZ:P Exporter fork](../res/images/blender_mdl_properties.webp)
## Features
### "First Frame" & "Last Frame"
![The new "First Frame" & "Last Frame" properties](../res/images/blender_mdl_frames.webp)
Contrary to the [vanilla](https://github.com/robrohan/blender_ie_quake_mdl) export plugin's usage of the playhead on the Blender timeline for frame selection, NZ:P's fork utilizes `Properties` menu entries for determining the start and ending frames to be baked into the resulting `.MDL`. This is particularly useful for wanting to export precise chunks of animation data.
### View Model "Bounding Box"
![The NZ:P Ray Gun source file vs. a custom bounding box export. Note the absent arm outside of the bounding box.](../res/images/blender_raygun_export_comparison.webp)
The `MDL Mins` and `MDL Maxs` properties define a minimum and maximum region for vertices to cross over. The intended benefit of this is to only warp/swim vertices to their max point of camera visibility in order to preserve fine details such as weapon iron sights. Enabling `Show MDL bounding box` will give you a visual representation of this box to use as reference.
![Custom bounding box with an active camera point of view](../res/images/blender_raygun_camera.webp)
It is important to consider that bounding boxes need determined based on expected view model field of view. It is recommended to set up a Blender camera with the intended field of view and set it as active to get a live preview of how well your bounding box accomodates every frame you are intending to export.
![The resulting export of the PPSh-41 at its intended field of view](../res/images/blender_ppsh_export.webp)

57
markdown/mapping/player-spawns.md Normal file
View file

@ -0,0 +1,57 @@
% Player Spawn Points - NZ:P Mapping Documentation
# Player Spawn Points
__NOTE: This guide uses the terms "level" and "map" interchangeably.__
## Introduction
Nazi Zombies: Portable expands on _Quake_'s foundation for Player Spawn entities (`info_player_*`) to allow for greater creator control over content, and to accomodate the four player co-operative nature of _Zombies_ gameplay. It does this by replacing the legacy `info_player_start` and similar entities with four distinct spawn point entities per player:
```
info_player_1_spawn - Player 1's Spawn, often assigned as "'Tank' Dempsey".
info_player_2_spawn - Player 2's Spawn, often assigned as "Nikolai Belinski".
info_player_3_spawn - Player 3's Spawn, often assigned as "Takeo Masaki".
info_player_4_spawn - Player 4's Spawn, often assigned as "Edward Richtofen".
```
## Ideal Spawn Point Conditions
![Example of reasonably placed Spawn Points, from _Nacht der Untoten_](../res/images/player_spawn_positions.webp)
It is important to consider the surroundings of any given potential spawn point location. Spawn locations must not be inside of any geometry, and it is recommended to not place them inside of any other entities your level may contain. Spawn points must also be reasonably spaced from one another, not cramped together in a small space -- this ensures any AFK players are not blocking others from interacting with their environment when gameplay begins.
![_Call of Duty: Zombies_'s preferred Spawn Order](../res/images/player_spawn_order_reference.webp)
_Call of Duty: Zombies_ often follows a strict order with spawn point locations, player one representing the "center" with players two, three, and four surrounding them. __This is not a required attribute__ to be met when designing levels and placing spawn points.
## Features
### Customizing Starting Weapon Loadouts
Nazi Zombies: Portable allows level creators to customize all four player's starting weapons and their ammunition amount individually. This is done via three distinct entitiy fields:
```
weapon : Starting Weapon
currentmag : Starting Magazine
currentammo : Starting Reserve Ammunition
```
If nothing is provided for `weapon`, the default loadout is applied (A Colt M1911, with 8 rounds in the magazine and 32 in the reserve).
![An example of a map maker assigning Player 1's starting weapon](../res/images/player_spawn_starting_weapon.webp)
### Specifying Character Names
![A depiction of a Character's name appearing on the HUD](../res/images/player_spawn_name_hud.webp)
Using the `name` key, level creators can specify the name for the Spawn Point's designated Character. There is a 16 character limit associated with this. Upon spawning, the client will have their Character's name displayed on the HUD to the right of their Score before fading away.
### Targeting
Upon a client spawning, standard Quake `target`s are fired by the spawn point. This, as an example, can be used to only activate specific AI spawn points on a section of the level, in the same vein as *Verrückt*. It is important to note that this is also activated upon *respawn*, so it may be wise to attach the spawn point to a `trigger_relay` set to activate only once, if you do not want your `target`s activated beyond game start/client join.
## Backwards Compatibility with Legacy Maps
Levels created before the implementation of features showcased here are still fully supported by Nazi Zombies: Portable. This includes maps that use _Quake_'s standard `info_player_start` entity and ones that used NZ:P's previous-and-primitive co-operative `info_player_tank`, `info_player_doctor`, etc. entities.
If a level only features less than four spawn point entities, NZ:P will algorithmically generate the other necessary points. It will use Player 1 as a starting origin, and attempt to generate other spawns in the same preferred order as _Call of Duty_ (see [Ideal Spawn Point Conditions](#ideal-spawn-point-conditions)). It makes 12 total attempts to do so with three different distances between Player 1's spawn. If all of these fail, the additional spawn points will appear in the same location as Player 1.

37
markdown/mapping/random-perks.md Normal file
View file

@ -0,0 +1,37 @@
% Random Perk-A-Cola Machines - NZ:P Mapping Documentation
# Random Perk-A-Cola Machines
__NOTE: This guide uses the terms "level" and "map" interchangeably.__
## Introduction
Nazi Zombies: Portable features the ability, via built-in entities, to _'randomize'_ the positions or types of Perk-A-Cola machines that can appear in a user's level. This is done via the `perk_random` entity. The behavior of this entity is contextual, which will be gone over on this page.
## Features
### Choosing A Perk-A-Cola Selection
![A `perk_random` Entity in the wild.](../res/images/perk_random.webp)
Control over `perk_random` is done entirely via its `spawnflags`. Each `spawnflag` corresponds to an individual Perk-A-Cola machine:
| Spawnflag Value | Perk-A-Cola Equivalent |
|---|---|
| `1` | Quick Revive |
| `2` | Jugger-Nog |
| `4` | Speed Cola |
| `8` | Double Tap Root Beer |
| `16` | PhD Flopper |
| `32` | Stamin-Up |
| `64` | Deadshot Daiquiri |
| `128` | Mule Kick |
If no `spawnflags` are selected, the Entity will [`objerror`](https://web.archive.org/web/20240212193953/https://quakewiki.org/wiki/objerror).
### Using Extended Perk-A-Cola Abilities
![If Deadshot Daiquiri is selected by `perk_random`, the existing Machine will teleport from behind the wall in the desired location.](../res/images/perk_random_repositioning.webp)
By default, `perk_random` behaves by Spawning the desired Perk-A-Cola entity out-right, using the default ("legacy") values provided for Map Backwards Compatibility. This can be problematic, however, if you would like to utilize the additional feature set provided by placing individual `perk_*` entities.
This can be achieved via `perk_random` by individually placing (preferably out-of-bounds) the Perk-A-Cola machines you desire to be placed by randomization. If the selected Perk-A-Cola is discovered, instead of spawning a new machine out-right, `perk_random` will opt to instead move the Perk-A-Cola machine in it's place.

40
markdown/mapping/trenchbroom-setup.md Normal file
View file

@ -0,0 +1,40 @@
% TrenchBroom Set-Up - NZ:P Mapping Documentation
# TrenchBroom Set-Up
## Introduction
This is a quick-start guide on installing the custom TrenchBroom profile for Nazi Zombies: Portable in order to use its mapping toolset with the program, as well as a brief instructional on installing _Vluzcan's Half-Life Tools_, the `.BSP` compiler to use. Nazi Zombies: Portable relies on _Half-Life_ BSP type `30` as opposed to _Quake_ type `29`.
This is not a guide on learning to use TrenchBroom or _Quake_ mapping. Please refer to the [Landing page](../landing/index.md#mapping-documentation) for resource links to these.
## TrenchBroom Profile
### Downloading
![Downloading the profile in two steps](../res/images/trenchbroom_profile_download.webp)
Nazi Zombies: Portable hosts the TrenchBroom profile on [GitHub](https://github.com/nzp-team/trenchbroom-profile). Navigate to the repository, press the green _Code_ button, followed by pressing _Download ZIP_. The profile will then be downloaded.
### Installation
![TrenchBroom Preferences window, highlighting the `games` directory button](../res/images/trenchbroom_preferences.webp)
Once the `.ZIP` archive is downloaded, start TrenchBroom and locate `Preferences`. This will bring you to a panel that displays a list of all currently installed profiles, you will likely only be presented with the default ones available. Click the folder icon (📁) that appears on the bottom of the left window pane to open the `<TrenchBroom>/games` directory in your file manager.
![Trenchbroom's `games` directory, with the NZ:P profile installed](../res/images/trenchbroom_games_dir.webp)
Inside of this directory, create a new one of your choice (`nzp` is likely preferred), and extract the TrenchBroom profile `.ZIP` contents inside of it. You should be left with a similar result to the screenshot showcased above -- an `nzp` directory where the contents contain `Icon.png`, `tb-nzp.fg`, and `GameConfig.cfg`. Installation should now be complete, verify that `NZP` is now present in TrenchBroom `Preferences` to confirm correct installation.
## Compiler Set-Up
### Downloading
The `.BSP` compiler, _Vluzcan's Half-Life Tools_, can be downloaded for x86 and x86_64 variants of Linux and Windows as well as in-support macOS versions via Nazi Zombies: Portable's [GitHub](https://github.com/nzp-team/vhlt/releases/latest) fork. This link, similar to the nightly deployment builds, will always be up to date and are automatically deployed on-commit.
### Installation
![NZ:P's TrenchBroom Compilation Tools dialogue paths](../res/images/trenchbroom_compiler_paths.webp)
Extract and/or copy your VHLT binaries to an easily identifiable location. Navigate to TrenchBroom's `Preferences` menu and select __NZP__ from the list. You will be prompted with four file select dialogues under _Compilation Tools_. Use these dialogues to select the binaries you copied to a directory previously (e.g., link `csg` with `hlcsg.exe`).
Once this is done, the compiler paths can be used in setting up build profiles inside of TrenchBroom, using `${csg}`, `${bsp}`, `${vis}`, and `${rad}`. Reminder that this guide was not made to instruct how to set up basic build profiles for TrenchBroom. Please refer to the [Landing page](../landing/index.md#mapping-documentation) for further resources if necessary.

14
markdown/mapping/trigger_atroundend.md Normal file
View file

@ -0,0 +1,14 @@
% trigger_atroundend - NZ:P Mapping Documentation
# trigger_atroundend
## Introduction
`trigger_atroundend` is a *PointClass* trigger that is automatically activated when a specified Round/Wave is ending.
## Features
### Fields
| Field Name | Field ID | Default Value | Description |
|---|---|---|---|
| Round to Activate on | `health` | `0` | Round/Wave required for completion before being Fired.

24
markdown/mapping/trigger_awardpoints.md Normal file
View file

@ -0,0 +1,24 @@
% trigger_awardpoints - NZ:P Mapping Documentation
# trigger_awardpoints
## Introduction
`trigger_awardpoints` is a brush-based one-time use trigger used to give a Client a set amount of points. It's most common application is enabling "Spare Change" underneath Perk-A-Cola machines if a Client prones in front of the entity. These cannot be triggered if the Client is in Last Stand.
## Features
### Fields
| Field Name | Field ID | Default Value | Description |
|---|---|---|---|
| Score to Add | `points` | `25` | Amount of score/points gained on trigger.
| Sound to Play on Trigger | `noise` | `sounds/misc/ching.wav` | Sound played when triggered.
### Spawnflags
| Spawnflag Name | Spawnflag ID | Default Value | Description |
|---|---|---|---|
| Requires Client to Stand | `1` | `false` | Prevents trigger from firing unless the Client is Standing.
| Requires Client to Crouch | `2` | `false` | Prevents trigger from firing unless the Client is Crouching.
| Requires Client to Prone | `4` | `false` | Prevents trigger from firing unless the Client is Prone.
| Affected by Double Points Power-Up | `8` | `false` | Toggle affectedness by the Double Points score multiplier.

6
markdown/mapping/trigger_interact.md Normal file
View file

@ -0,0 +1,6 @@
% trigger_interact - NZ:P Mapping Documentation
# trigger_interact
## Introduction
`trigger_interact` is a brush-based trigger used to fire targets when a Client in its collision box presses their Interact button. There is no Use String provided, making it optimal for "secrets".

21
markdown/mapping/trigger_setfire.md Normal file
View file

@ -0,0 +1,21 @@
% trigger_setfire - NZ:P Mapping Documentation
# trigger_setfire
## Introduction
`trigger_setfire` is a brush-based trigger used to set Clients and/or Enemy AI on fire, if supported by that client or AI type. When the entity collides with the entity, they will be set alight, and continue to be on fire as long as they are in the trigger plus a duration specified in the entity field.
## Features
### Fields
| Field Name | Field ID | Default Value | Description |
|---|---|---|---|
| Effect Duration | `fire_timeout` | `2` | Duration (in seconds) the entity will be on fire after leaving the trigger bounds.
### Spawnflags
| Spawnflag Name | Spawnflag ID | Default Value | Description |
|---|---|---|---|
| Applies to Clients | `1` | `false` | Sets whether or not the `trigger_setfire` trigger impacts Clients (Players) in addition to Enemy AI.
| No Damage to AI/Enemies | `2` | `false` | Prohibits damage to Enemy AI when enabled, but can still impact Clients.

53
markdown/mapping/wall-weapons.md Normal file
View file

@ -0,0 +1,53 @@
% Wall Weapons - NZ:P Mapping Documentation
# Wall Weapons
__NOTE: This guide uses the terms "level" and "map" interchangeably.__
## Introduction
Nazi Zombies: Portable features purchaseable weapons off-the-wall in the same vein as _Call of Duty_. This is done via two different entities -- a `buy_weapon` brush-trigger that is your purchaseable weapon prompt, and an optional `weapon_wall` visual entity that serves as the chalk drawing design on the wall.
## Purchaseable Weapons (`buy_weapon`)
![Example of a `buy_weapon` entity properly set up.](../res/images/wall_wep_trigger_flags.webp)
`buy_weapon` triggers have three important fields. The weapon you wish to be purchaseable (`weapon`), the cost of the weapon (`cost`), and the cost of ammunition after initial weapon purchase (`cost2`).
### _Call of Duty_'s Defined Weapon Costs
_Call of Duty: World at War_ and _Call of Duty: Black Ops_ use consistent prices for their off-the-wall weapons in game. These prices, sorted from lowest to highest, are as follows (any weapon not listed here is a weapon not available off-the-wall in an official capacity):
- Bowie Knife: `3000` points
- Scoped Kar98k†: `1500` points
- M1897 Trench Gun: `1500` points
- FG42: `1500` points
- BAR††: `1400` points
- Thompson: `1200` points
- Sawed-Off Shotgun: `1200` points
- Double-Barreled Shotgun: `1200` points
- STG-44: `1200` points
- Bouncing Betty: `1000` points
- MP40: `1000` points
- Type 100: `1000` points
- MP5K: `1000` points
- Gewehr 43: `600` points
- M1A1 Carbine: `600` points
- M1 Garand: `600` points
- Stielhandgrenate: `250` points (ammo only)
- Springfield: `200` points
- Kar98k: `200` points
All weapons available off the wall have an ammunition cost that is 50% of the full weapon cost.
†Via the _Nacht der Untoten_ cabinet secret.
††The BAR has a variant with an unusable (cut feature) bipod in _Verrückt_ that cost 2500 points. This has been disregarded due to it's nature.
### Universal Ammo/Weapon Crate
Using field `99` for the `weapon` key, level creators can opt for a less traditional weapon buy station as opposed to an off-the-wall grab. These stations replenish ammo for the weapon currently held by the client, as a fixed amount. This could be useful for ammunution replenishment for a weapon only available via the _Mystery Box_, as an example.
## Weapon Chalk
![An example of a properly established `buy_weapon` and `weapon_wall` link](../res/images/wall_wep_chalk_link.webp)
`weapon_wall` entities strictly serve as an optional visual aid for purchaseable triggers. They can be `target`ed by `buy_weapon`, and doing so will cause them to trigger their weapon summon to occupy the chalk's space. It is worth noting that `weapon_wall` has a separate `weapon` field, so using an incorrect field will cause the wrong chalk and world model to appear.

14
markdown/mapping/zombie-horde-points.md Normal file
View file

@ -0,0 +1,14 @@
% Zombie Horde Points - NZ:P Mapping Documentation
# Zombie Horde Points
## Introduction
Given situations where all players in a server are in Last Stand or are otherwise unreachable, Zombies in Nazi Zombies: Portable will "horde" at the nearest possible location available. This is done via the `zombie_horde_point` entity.
## Usage
Zombies will automatically locate the closest `zombie_horde_point` entity in the level and run towards it. All a level creator is required to do is place one or more of them around their level. It is recommended to place these in locations that are not obtrusive to the player -- meaning they are not blocking accessibility to important areas in the level, and are not in places that are generally common for the player to enter Last Stand in.
## Backwards Compatibility
In the event a level lacks any `zombie_horde_point` entities, Nazi Zombies: Portable will locate them to the initial Player 1 spawn point (see [Player Spawn Points](player-spawns.md) for more information) to "horde" instead.

33
markdown/res/_reset.css Normal file
View file

@ -0,0 +1,33 @@
/* ##### Reset ########## */
html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
margin: 0;
padding: 0;
border: 0;
font-size: 100%;
font: unset;
vertical-align: baseline;
box-sizing: border-box;
}
body {
line-height: 1;
}
ol, ul {
list-style: none;
}
blockquote, q {
quotes: none;
}
blockquote::before, blockquote::after, q::before, q::after {
content: '';
content: none;
}
table {
border-collapse: collapse;
border-spacing: 0;
}

89
markdown/res/_responsive.css Normal file
View file

@ -0,0 +1,89 @@
/* ##### Responsive ########## */
@media only screen and (max-width: 930px) {
/* Code, Figure and Table */
pre, figure, table {
max-width: max-content;
margin-left: auto;
margin-right: auto;
}
/* List */
dl dd {
margin-left: var(--spacing-x15000);
}
ol, ul {
margin-left: var(--spacing-x15000);
}
/* Figure */
figure {
display: block;
}
/* Image */
p img {
display: block;
float: inherit;
margin: 0 auto var(--spacing-x10000);
}
/* Table of Contents & Content */
body #toc, body #content {
margin-left: 50px;
}
/* Table of Contents */
body #toc_toggler {
display: flex;
}
body #toc {
display: none;
min-width: calc(100vw - 50px);
max-width: calc(100vw - 50px);
right: 0;
}
body.toc_toggled #toc {
display: block;
}
/* Content Version */
body #content_version #content_version_details img {
display: none;
}
body #content_version #content_version_details div, body #content_version #content_version_links {
align-items: center;
}
body #content_version {
flex-direction: column;
}
body #content_version #content_version_links {
margin-top: var(--spacing-x05000);
margin-left: inherit;
}
/* Table of Contents and Content */
body #toc_toggler, body #toc, body #content {
padding: var(--spacing-x10000);
}
/* Back to Top */
body #content a[href="#"] {
display: none;
}
}

223
markdown/res/_specific.css Normal file
View file

@ -0,0 +1,223 @@
/* ##### Specific ########## */
/* All */
* {
outline: none;
}
/* Code */
pre {
max-width: max-content;
padding: var(--spacing-x10000);
margin-left: var(--spacing-x10000);
margin-right: var(--spacing-x10000);
line-height: var(--typography-line-height-tight);
overflow-x: auto;
overflow-y: hidden;
border: var(--border);
border-radius: var(--border-radius-25);
background-color: var(--color-gray-97);
}
code {
font-family: var(--typography-font-family-code);
font-size: var(--typography-font-size-x07500);
word-break: break-word;
}
/* Typography */
h1, h2, h3, h4 {
font-weight: var(--typography-font-weight-bold);
}
h1 {
font-size: var(--typography-font-size-x20000);
}
h2 {
font-size: var(--typography-font-size-x15000);
}
h3, h4 {
font-size: var(--typography-font-size-x12500);
}
p {
text-align: justify;
}
b, strong {
font-weight: var(--typography-font-weight-bold);
}
i, em {
font-style: italic;
}
/* List */
dl dt {
font-weight: var(--typography-font-weight-bold);
}
dl dd {
margin-left: var(--spacing-x20000);
}
ol, ul {
margin-left: var(--spacing-x20000);
}
ol {
list-style-type: decimal;
}
ul {
list-style-type: disc;
}
ul > li > ul:not(:first-child) {
margin-top: var(--spacing-x05000);
margin-bottom: var(--spacing-x05000);
}
ul > li > ul > li {
list-style-type: circle;
}
ul > li > ul > li > ul > li {
list-style-type: square;
}
/* Link */
a:link, a:visited {
text-decoration: none;
color: var(--color-azureradiance);
}
a:hover, a:focus {
text-decoration: underline;
}
/* Figure */
figure {
display: inline-block;
margin-left: var(--spacing-x10000);
margin-right: var(--spacing-x10000);
border-radius: var(--border-radius-25);
background-color: var(--color-gray-97);
}
figure figcaption {
padding: var(--spacing-x05000) 0;
font-size: var(--typography-font-size-x07500);
font-weight: var(--typography-font-weight-bold);
text-align: center;
color: var(--color-gray-20);
}
/* Image */
figure img {
display: block;
max-width: 100%;
margin: 0;
border-radius: var(--border-radius-25);
background-color: var(--color-gray-97);
}
p img {
float: left;
max-width: 100%;
margin: 0 var(--spacing-x10000) var(--spacing-x10000) 0;
}
/* Table */
table {
display: block;
margin-left: var(--spacing-x10000);
margin-right: var(--spacing-x10000);
white-space: nowrap;
overflow-x: auto;
}
table colgroup col {
width: unset !important;
}
table tr th, table tr td {
padding: var(--spacing-x05000);
vertical-align: middle;
border: var(--border);
}
table thead tr th {
font-weight: var(--typography-font-weight-bold);
text-align: left;
}
table tbody tr.odd {
background-color: var(--color-gray-97);
}
/* Shortcut */
.shortcut {
display: inline-block;
min-width: var(--sizing-x15000);
margin: 0 var(--spacing-x00625);
padding: var(--spacing-x00625) var(--spacing-x02500);
font-size: var(--typography-font-size-x07500);
font-family: var(--typography-font-family-base);
font-weight: var(--typography-font-weight-bold);
text-align: center;
border: var(--border);
border-radius: var(--border-radius-25);
background-color: var(--color-gray-97);
}
/* Line break */
br {
display: none;
}
/* Space */
h1, h2, h3, h4, img, ul, ol, dl, p, pre, table, figure {
margin-bottom: var(--spacing-x10000);
}
/* Back to Top & Table of Contents anchors */
.toc_toggler_button {
cursor: pointer;
border: none;
}
a[href="#"], .toc_toggler_button {
display: flex;
align-items: center;
justify-content: center;
width: var(--sizing-x20000);
height: var(--sizing-x20000);
font-size: var(--typography-font-size-x12500);
text-decoration: none;
border-radius: 50%;
background-color: var(--color-gray-100);
color: var(--color-gray-20);
}
a[href="#"]:hover, a[href="#"]:focus, .toc_toggler_button:hover, .toc_toggler_button:focus {
background-color: var(--color-gray-97);
}
a[href="#"] span, .toc_toggler_button span {
line-height: var(--typography-line-height-reset);
}

54
markdown/res/_specific.darkmode.css Normal file
View file

@ -0,0 +1,54 @@
/* ##### Specific: Dark Mode ########## */
@media (prefers-color-scheme: dark) {
/* Code */
pre {
background-color: var(--color-gray-15);
}
/* Link */
a:link, a:visited {
color: var(--color-maximumyellowred);
}
/* Figure */
figure {
background-color: var(--color-gray-15);
}
figure figcaption {
color: var(--color-gray-90);
}
/* Image */
figure img {
background-color: var(--color-gray-15);
}
/* Table */
table tbody tr.odd {
background-color: var(--color-gray-15);
}
/* Shortcut */
.shortcut {
background-color: var(--color-gray-15);
}
/* Back to Top & Table of Contents anchors */
a[href="#"], .toc_toggler_button {
background-color: var(--color-gray-15);
color: var(--color-gray-90);
}
a[href="#"]:hover, a[href="#"]:focus, .toc_toggler_button:hover, .toc_toggler_button:focus {
background-color: var(--color-gray-20);
}
}

59
markdown/res/_variables.css Normal file
View file

@ -0,0 +1,59 @@
/* ##### Variables ########## */
:root {
/* Typography */
--typography-font-family-base: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji';
--typography-font-family-code: 'Lucida Console', Monaco, monospace;
--typography-font-size-x07500: calc(var(--typography-font-size-x10000) * 0.75);
--typography-font-size-x08750: calc(var(--typography-font-size-x10000) * 0.875);
--typography-font-size-x10000: 16px;
--typography-font-size-x12500: calc(var(--typography-font-size-x10000) * 1.25);
--typography-font-size-x15000: calc(var(--typography-font-size-x10000) * 1.5);
--typography-font-size-x20000: calc(var(--typography-font-size-x10000) * 2);
--typography-font-weight-regular: 400;
--typography-font-weight-bold: 700;
--typography-line-height-reset: 1;
--typography-line-height-tight: 1.2;
--typography-line-height-normal: 1.5;
/* Colors */
--color-gray-20: hsl(0, 0%, 20%);
--color-gray-40: hsl(0, 0%, 40%);
--color-gray-60: hsl(0, 0%, 60%);
--color-gray-80: hsl(0, 0%, 80%);
--color-gray-97: hsl(0, 0%, 97%);
--color-gray-100: hsl(0, 0%, 100%);
--color-azureradiance: hsl(210, 100%, 50%);
/* Borders */
--border: var(--sizing-x00625) solid var(--color-gray-80);
--border-radius-25: var(--sizing-x02500);
/* Sizing */
--sizing-x00625: calc(var(--sizing-x10000) * 0.0625);
--sizing-x02500: calc(var(--sizing-x10000) * 0.25);
--sizing-x05000: calc(var(--sizing-x10000) * 0.5);
--sizing-x10000: 16px;
--sizing-x12500: calc(var(--sizing-x10000) * 1.25);
--sizing-x15000: calc(var(--sizing-x10000) * 1.5);
--sizing-x20000: calc(var(--sizing-x10000) * 2);
--sizing-x30000: calc(var(--sizing-x10000) * 3);
/* Spacing */
--spacing-x00625: calc(var(--spacing-x10000) * 0.0625);
--spacing-x02500: calc(var(--spacing-x10000) * 0.25);
--spacing-x05000: calc(var(--spacing-x10000) * 0.5);
--spacing-x10000: 16px;
--spacing-x15000: calc(var(--spacing-x10000) * 1.5);
--spacing-x20000: calc(var(--spacing-x10000) * 2);
/* Custom sizes */
--toc-width: 340px;
--content-max-width: 1024px;
}

16
markdown/res/_variables.darkmode.css Normal file
View file

@ -0,0 +1,16 @@
/* ##### Variables: Dark Mode ########## */
@media (prefers-color-scheme: dark) {
:root {
/* Colors */
--color-gray-10: hsl(0, 0%, 10%);
--color-gray-15: hsl(0, 0%, 15%);
--color-gray-90: hsl(0, 0%, 90%);
--color-maximumyellowred: hsl(40, 90%, 60%);
/* Borders */
--border: var(--sizing-x00625) solid var(--color-gray-40);
}
}

136
markdown/res/default.css Normal file
View file

@ -0,0 +1,136 @@
/* ##### Default ########## */
/* Body */
body {
font-family: var(--typography-font-family-base);
font-size: var(--typography-font-size-x10000);
font-weight: var(--typography-font-weight-regular);
line-height: var(--typography-line-height-normal);
background-color: var(--color-gray-100);
color: var(--color-gray-20);
}
body.toc_toggled {
overflow: hidden;
}
/* Table of Contents and Content */
body #toc_toggler, body #toc, body #content {
padding: var(--spacing-x20000);
}
/* Table of Contents */
body #toc_toggler, body #toc {
background-color: var(--color-gray-97);
}
body #toc_toggler {
display: none;
flex-direction: column;
align-items: center;
min-width: 50px;
max-width: 50px;
position: fixed;
top: 0;
bottom: 0;
}
body #toc_toggler img {
width: var(--sizing-x12500);
height: var(--sizing-x12500);
}
body #toc_toggler > a[href="#"] {
margin-top: auto;
}
body #toc {
min-width: var(--toc-width);
max-width: var(--toc-width);
position: fixed;
top: 0;
left: 0;
bottom: 0;
overflow-y: auto;
}
body #toc #toc_inner > ul {
margin-top: var(--spacing-x05000);
margin-bottom: 0;
margin-left: 0;
list-style-type: none;
}
body #toc #toc_inner > ul > li > a {
font-weight: var(--typography-font-weight-bold);
}
/* Content Version */
body #content_version {
display: flex;
align-items: center;
margin-bottom: var(--spacing-x10000);
padding-bottom: var(--spacing-x05000);
font-size: var(--typography-font-size-x08750);
color: var(--color-gray-60);
border-bottom: var(--border);
}
body #content_version #content_version_details {
display: flex;
align-items: center;
}
body #content_version #content_version_details img {
max-width: var(--sizing-x30000);
margin: 0;
margin-right: var(--spacing-x05000);
}
body #content_version #content_version_details div {
display: flex;
flex-direction: column;
}
body #content_version #content_version_details div #content_version_heading {
font-size: var(--typography-font-size-x10000);
font-weight: var(--typography-font-weight-bold);
color: var(--color-gray-40);
}
body #content_version #content_version_links {
display: flex;
flex-direction: column;
align-items: flex-end;
margin-left: auto;
}
/* Content */
body #content {
max-width: var(--content-max-width);
margin: 0 auto;
padding-left: calc(var(--toc-width) + var(--sizing-x20000));
}
body #content > :last-child {
margin-bottom: 0;
}
body #content h1, body #content h2, body #content h3, body #content h4 {
display: inline-block;
width: 100%;
margin-top: var(--spacing-x05000);
}
/* Back to Top */
body #content a[href="#"] {
position: fixed;
right: var(--spacing-x20000);
bottom: var(--spacing-x20000);
}

23
markdown/res/default.darkmode.css Normal file
View file

@ -0,0 +1,23 @@
/* ##### Default: Dark Mode ########## */
@media (prefers-color-scheme: dark) {
/* Body */
body {
background-color: var(--color-gray-10);
color: var(--color-gray-90);
}
/* Content Version */
body #content_version #content_version_details div #content_version_heading {
color: var(--color-gray-80);
}
/* Table of Contents */
body #toc_toggler, body #toc {
background-color: var(--color-gray-15);
box-shadow: 16px 0 24px -12px var(--color-gray-5);
}
}

BIN
markdown/res/images/barricade.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 16 KiB

BIN
markdown/res/images/barricade_custom_sound.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 10 KiB

BIN
markdown/res/images/barricade_path_complex.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 44 KiB

BIN
markdown/res/images/barricade_path_simple.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 24 KiB

BIN
markdown/res/images/blender_mdl_bbox.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 10 KiB

BIN
markdown/res/images/blender_mdl_frames.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.6 KiB

BIN
markdown/res/images/blender_mdl_properties.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 7.9 KiB

BIN
markdown/res/images/blender_ppsh_demo.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 7 KiB

BIN
markdown/res/images/blender_ppsh_export.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 110 KiB

BIN
markdown/res/images/blender_raygun_camera.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 6.8 KiB

BIN
markdown/res/images/blender_raygun_export_comparison.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
markdown/res/images/explosive_barrel.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
markdown/res/images/icon.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 2.9 KiB

BIN
markdown/res/images/perk_random.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
markdown/res/images/perk_random_repositioning.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 22 KiB

BIN
markdown/res/images/player_spawn_name_hud.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.8 KiB

BIN
markdown/res/images/player_spawn_order_reference.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 3.2 KiB

BIN
markdown/res/images/player_spawn_positions.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 91 KiB

BIN
markdown/res/images/player_spawn_starting_weapon.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 13 KiB

BIN
markdown/res/images/trenchbroom_compiler_paths.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
markdown/res/images/trenchbroom_games_dir.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 6.6 KiB

BIN
markdown/res/images/trenchbroom_preferences.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 19 KiB

BIN
markdown/res/images/trenchbroom_profile_download.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 17 KiB

BIN
markdown/res/images/wall_wep_chalk_link.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 310 KiB

BIN
markdown/res/images/wall_wep_trigger_flags.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 3.4 KiB

83
markdown/res/shortcuts_helper.js Normal file
View file

@ -0,0 +1,83 @@
// handles the string in a #key() macro
const key_str = (key) => {
if (keys[key]) {
return "<span class=\"shortcut\">" + keys[key] + "</span>";
} else {
console.error("unknown key ", key);
return undefined;
}
}
// Pandoc smart typography converts three periods to …, but this breaks
// our menu item lookups.
const fix_ellipsis = (path) => path.replace("…", "...");
const shortcut_str = (shortcut) => {
let result = "";
if (shortcut) {
if (shortcut.key == "") {
result = undefined;
} else {
for (i = 0; i < shortcut.modifiers.length; ++i) {
result += key_str(shortcut.modifiers[i]);
}
result += key_str(shortcut.key);
}
} else {
console.error("unknown shortcut ", shortcut);
result += "&laquo;unknown shortcut&raquo;";
}
return result;
}
const menu_path_str = (path) => path.join(" &raquo; ");
// handles the string in a #menu() macro
const menu_item_str = (key) => {
key = fix_ellipsis(key);
let result = "<b>";
const item = menu[key];
if (item) {
result += menu_path_str(item.path);
const shortcut = shortcut_str(item.shortcut);
if (shortcut) {
result += " (" + shortcut + ")";
}
} else {
console.error("unknown menu item ", key);
result += "unknown menu item \"" + key + "\"";
}
result += "</b>";
return result;
}
// handles the string in an #action() macro
const action_str = (key) => {
key = fix_ellipsis(key);
let result = "<b>";
const item = actions[key];
if (item) {
result += shortcut_str(item);
} else {
console.error("unknown action ", key);
result += "unknown action \"" + key + "\"";
}
result += "</b>";
return result;
}
// #key() macros expand into calls to this
const print_key = (key) => document.write(key_str(key));
// #menu() macros expand into calls to this
const print_menu_item = (key) => document.write(menu_item_str(key));
// #action() macros expand into calls to this
const print_action = (key) => document.write(action_str(key));

72
template/template.html Normal file
View file

@ -0,0 +1,72 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta content="Nazi Zombies: Portable Documentation" property="og:title" />
<meta content="Official Mapping and Core documentation for the Quake project Nazi Zombies: Portable" property="og:description" />
<meta content="https://docs.nzp.gay/" property="og:url" />
<meta content="https://docs.nzp.gay/res/images/icon.webp" property="og:image" />
<meta content="#6e0d00" data-react-helmet="true" name="theme-color" />
<meta name="generator" content="pandoc">
$for(author-meta)$
<meta name="author" content="$author-meta$">$endfor$
<title>$pagetitle$</title>
<link rel="icon" href="../res/images/icon.webp">
<link rel="stylesheet" href="../res/_reset.css">
<link rel="stylesheet" href="../res/_variables.css">
<link rel="stylesheet" href="../res/_variables.darkmode.css">
<link rel="stylesheet" href="../res/_specific.css">
<link rel="stylesheet" href="../res/_specific.darkmode.css">
<link rel="stylesheet" href="../res/default.css">
<link rel="stylesheet" href="../res/default.darkmode.css">
<link rel="stylesheet" href="../res/_responsive.css">
<!--<script src="shortcuts.js"></script>-->
<script src="res/shortcuts_helper.js"></script>
<script>(() => {
window.addEventListener('DOMContentLoaded', () => {
const tocToggledClass = 'toc_toggled';
document.body.querySelector('div#toc_toggler .toc_toggler_button').addEventListener('click', (event) => {
event.preventDefault();
document.body.classList.toggle(tocToggledClass);
});
document.body.querySelectorAll('a').forEach((element) => {
element.addEventListener('click', (event) => {
document.body.classList.remove(tocToggledClass);
});
});
});
})()</script>
</head>
<body>
$if(toc)$<div id="toc_toggler">
<img src="../res/images/icon.webp" alt="NZ:P Icon">
<button class="toc_toggler_button" title="Open Table of Contents"><span>&#9776;</span></button>
<a href="#" title="Back to top"><span>&#8657;</span></a>
</div>
<nav id="toc">
<div id="toc_inner">
$toc$
</div>
</nav>$endif$
<main id="content">
<aside id="content_version">
<div id="content_version_details">
<img src="../res/images/icon.webp" alt="NZ:P Icon">
<div>
<span id="content_version_heading">$pagetitle$</span>
<span><strong><i>Call of Duty: Zombies</i> Recreation</strong></span>
</div>
</div>
<div id="content_version_links">
<span><strong><a href="../landing/index.html" rel="noopener noreferrer">Landing</a></strong> - <a href="https://github.com/nzp-team" target="_blank" rel="noopener noreferrer">GitHub Organization</a></span>
<span><a href="https://github.com/nzp-team/nzportable/releases/latest" target="_blank" rel="noopener noreferrer">Download the latest available version</a> - <a href="https://nzp.gay/" target="_blank" rel="noopener noreferrer">Play in your Browser (WebGL)</a></span>
</div>
</aside>
<a href="#" title="Back to top"><span>&#8657;</span></a>
$body$
</main>
</body>
</html>