Merge pull request #1 from JordanPlayz158/add/dedicated-server-page

Added Dedicated Server page
This commit is contained in:
cypress 2024-06-29 20:38:41 -07:00 committed by GitHub
commit 91de2abbe9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 29 additions and 1 deletions

View file

@ -0,0 +1,27 @@
% Dedicated Server - NZ:P Internal Documentation
# Dedicated Server
## Binary
You will want to obtain the upstream [FTEQW](https://www.fteqw.org/) server binary for your respective platform.
If you run pterodactyl there is an [egg](https://github.com/JordanPlayz158/games-standalone/blob/add/nazi-zombies-portable/nazi_zombies_portable/egg-nazi-zombies--portable.json) <!-- Replace with link to official repo once merged --> that handles the Binary, Assets, QuakeC, and CVars for you.
For everyone else, you will need to download the [Assets](https://github.com/nzp-team/assets/releases) and [QuakeC](https://github.com/nzp-team/quakec/releases) files when using upstream FTEQW. For assets, you will want to download `pc-nzp-assets.zip` and extract it to the same location as the binary, you should have the FTEQW binary and a directory called `nzp` beside it. For QuakeC you will want both `fte-nzp-qc.zip` and `standard-nzp-qc.zip` and you will want to extract them inside the `nzp` folder. The NZP folder should now contain some `.dat` files. After that, you can run the binary with the `-dedicated` argument and with the below [cvars](https://fte.triptohell.info/wiki/index.php/Console_Variables) outlined.
## Web
### Defining a Port
You would use the `sv_port_tcp` cvar to specify which port the **WS** server will run on.
### Protocol Name
`com_protocolname` = `NZP-REBOOT-WEB`
The dedicated server runs a websocket server, you will need to type explicitly `connect ws://ip:port` into your console on an HTTP (**not S**) page of the web client otherwise the browser will block the connection.
## Desktop/Native
### Defining a Port
You would use the `sv_port` cvar to specify which port the **UDP** server will run on.
### Protocol Name
`com_protocolname` = `NZP-REBOOT`
### Custom Tick Rates
`sv_mintic` is how frequently (in seconds) physics frames are calculated. The default value is 0.045, every 45 milliseconds, it calculates the physics. Be careful with raising this value too high as the more times per second the physics are calculated, the more packets are sent out and can be very bandwidth intensive, this becomes more apparent at higher rounds. With that being said though, 0.045 may be too high/slow and can lead to some physics issues such as zombies getting stuck on the ground/terrain, unable to climb stairs (observed on NDU), etc.

View file

@ -24,6 +24,7 @@ At this current moment, no marked-stable builds of Nazi Zombies: Portable are ma
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.
- [Dedicated Server](../internal/dedicated-server.md)
- [Weapon IDs](../internal/weapon-ids.md)
## Mapping & Modding Documentation