Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guide on installing maps #4

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions markdown/landing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ All documentation and media hosted is licensed under [CC-BY-SA 4.0](https://crea

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.


## [Downloading & Installing Maps in Nazi Zombies: Portable](../mapping/downloading-and-installing-maps.md)

## Core Documentation

Core documents contain information about Nazi Zombies: Portable's internal design. They may not be specifically relevant to custom content creators, though overlap will be present for map features that interact with NZ:P's QuakeC or for specialty features.
Expand Down
83 changes: 83 additions & 0 deletions markdown/mapping/downloading-and-installing-maps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
% Downloading & Installing Maps on Web, PC & Consoles - Downloading & Installing Maps in Nazi Zombies: Portable


# Downloading Maps

[Download a map from this page](https://github.com/nzp-team/nzportable/discussions/categories/map-releases){target="_blank"}



# Installing Maps on PC & Consoles

### Extracting
Extract the map to a folder.


- **Make sure its in this layout.**
```
├── derriese (custom map extracted folder)
│   ├── gfx
│   │   ├── env
│   │   │   └── CloudyNightSky.png
│   │   ├── lscreen
│   │   │   └── derriese.png
│   └── maps
│   ├── derriese.bsp
│   ├── derriese.txt
│   └── derriese.way
```

#### Installing
Simply copy the contents of this extracted folder the game's `nzp` folder.


# Installing Maps on Web


- [Install 7-zip if you are using Windows](https://www.7-zip.org/){target="_blank"} **(REQUIRED)**



### Extracting

Extract the map to a folder.


- **Make sure its in this layout.**
```
├── derriese (custom map extracted folder)
│   ├── gfx
│   │   ├── env
│   │   │   └── CloudyNightSky.png
│   │   ├── lscreen
│   │   │   └── derriese.png
│   └── maps
│   ├── derriese.bsp
│   ├── derriese.txt
│   └── derriese.way
```


### Zipping

Then select the map folder along with any other folders inside the extracted folder and compress it to `.zip`


for example:

![](../res/images/how-to-compress.webp)

Then we need to rename this new `.zip` to `.pk3`

### Installation

Drag and Drop the .pk3 file into the game.

Then reload the page afterwards, and the map will show up in user maps

### Video Demonstration

![gif showing how to install the map](../res/images/how-to-install-mapgif.gif)



Binary file added markdown/res/images/how-to-compress.webp
Binary file not shown.
Binary file added markdown/res/images/how-to-install-mapgif.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.