aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSamLam140330 <lamlam0328@gmail.com>2022-03-01 05:22:38 +0800
committerGitHub <noreply@github.com>2022-02-28 22:22:38 +0100
commit282197ba5e3edbf4297644b4c38de0e021fcccc1 (patch)
tree04fecce02389628a2df62db818c373facef8caa1 /docs
parent8cfb721429c4753b8df1a2c7f952ef5fd57b0dcb (diff)
downloadNorthstarWiki-282197ba5e3edbf4297644b4c38de0e021fcccc1.tar.gz
NorthstarWiki-282197ba5e3edbf4297644b4c38de0e021fcccc1.zip
Update Hosting a server with Northstar (#56)
* Update README.md Startup Arguments * Update README.md Startup Arguments again * Add Optimization Commands * Update prerequisites.md * Remove net_encryptpackets * Update best-practices.md * Update prerequisites.md * Update firewall paragraph
Diffstat (limited to 'docs')
-rw-r--r--docs/hosting-a-server-with-northstar/dedicated-server/README.md22
-rw-r--r--docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md10
-rw-r--r--docs/hosting-a-server-with-northstar/prerequisites.md13
3 files changed, 36 insertions, 9 deletions
diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/README.md b/docs/hosting-a-server-with-northstar/dedicated-server/README.md
index 1fad654..62032ee 100644
--- a/docs/hosting-a-server-with-northstar/dedicated-server/README.md
+++ b/docs/hosting-a-server-with-northstar/dedicated-server/README.md
@@ -15,7 +15,7 @@ When using a dedicated server, arguments are read from `ns_startup_args_dedi.txt
* `R2Northstar\mods\Northstar.CustomServers\mod.json`\
contains [ConVars](./#convars) default values
* `R2Northstar\mods\Northstar.CustomServers\mod\cfg\autoexec_ns_server.cfg`\
- contains [ConVars](./#convars) and overrides `R2Northstar\mods\Northstar.CustomServers\mod.json`
+ contains [ConVars](./#convars) and overrides
### Dedicated Server Caveats
@@ -29,24 +29,28 @@ See [troubleshoot](troubleshoot.md)
## Startup Arguments
-Startup arguments can be added in the `ns_startup_args_dedi.txt` file.
+Startup arguments can be added in the `ns_startup_args_dedi.txt` file.\
+Example: `+setplaylist private_match +mp_gamemode ps`
-| Arguments | Accepted Values | Description |
-| -------------------------- | ---------------------------------------------- | --------------------------------------------------- |
-| `+setplaylist` | `private_match` | Currently needed to make servers work |
-| `+setplaylistvaroverrides` | see [PlaylistOverrides](./#playlist-overrides) | Edits the behaviour of the server |
-| `-port` | int beteween `1-65535` | Determines which UDP port the server will listen to |
-| `+mp_gamemode` | see [Gamemodes](./#gamemodes) | Forces the gamemode of the server |
+| Arguments | Accepted Values | Description |
+| -------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `+setplaylist` | see [Gamemodes](./#gamemodes) (Should be the same as `mp_gamemode` unless you want a private match) | Set the server type (If it is not `private_match`, make sure you have also included `+map` and NOT `mp_lobby` or else you can't search your server in the game) |
+| `+setplaylistvaroverrides` | see [PlaylistOverrides](./#playlist-overrides) | Edits the behaviour of the server |
+| `-port` | int beteween `1-65535` | Determines which UDP port the server will listen to |
+| `+mp_gamemode` | see [Gamemodes](./#gamemodes) | Forces the gamemode of the server |
+| `+map` | see [Maps](./#maps) (`mp_lobby` is the default if not included) | Forces the map of the server at the first start |
| Flags | Description |
| --------------------- | ------------------------------------------------------------------------------ |
| `-maxplayersplaylist` | Allows [PlaylistOverrides](./#playlist-overrides) to override max player count |
+| `-enablechathooks` | Allows send the commands using in-game chat |
### Playlist overrides
Playlist overrides determines the behaviour of the server. PlaylistOverrides can be added using the `+setplaylistvaroverrides` argument in the `ns_startup_args_dedi.txt` file.
-The list of playlist overrides needs to be quoted and separated by spaces (example : `+setplaylistvaroverrides "run_epilogue 0 featured_mode_amped_tacticals 1"`)
+The list of playlist overrides needs to be quoted and separated by spaces.\
+Example: `+setplaylistvaroverrides "run_epilogue 0 featured_mode_amped_tacticals 1"`
| PlaylistOverrides | Accepted Values | Default Value | Description |
| -------------------------------------------- | --------------- | ------------- | ---------------------------------------------------------------------------------------------- |
diff --git a/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md
index 6128d5c..ace2b6d 100644
--- a/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md
+++ b/docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md
@@ -25,3 +25,13 @@ The current minimum requirements are as follows:
- 15 Mbps network upload, but 10 is workable, 25 if you want to avoid players getting disconnected when going back to the lobby after a match
**Note:** It is recommended to surpass the listed requirements. Currently the number of available servers covers the daily playerbase more than enough. If you're planning to host public servers for the community it is therefore recommended to either fill a niche (like a gamemode that is so popular that all existing servers are full) or provide a better service than existing hosts (less lag, more stable, etc.).
+
+## Optimization Commands (Optional)
+
+| Command | Description |
+| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| `net_compresspackets 1` | Enable compress packets |
+| `net_compresspackets_minsize 64` | Decrease usage from ~12-16 mbps to ~6-8 mbps on 20 player PVP server and ~9-12mbps to ~5-7 mbps on 12 player gun game server |
+| `sv_maxrate 127000` | Sets the maximum bandwidth rate allowed (both incoming/outcoming) per second (in bytes) |
+
+**Note:** The effect is dependent on your network, system, etc. Therefore, you should really add the command one by one and test it to see if there is any benefit for your server.
diff --git a/docs/hosting-a-server-with-northstar/prerequisites.md b/docs/hosting-a-server-with-northstar/prerequisites.md
index 4448352..3c780fb 100644
--- a/docs/hosting-a-server-with-northstar/prerequisites.md
+++ b/docs/hosting-a-server-with-northstar/prerequisites.md
@@ -38,6 +38,19 @@ Access your router via it's web interface and port forward
to your PC that you're running Northstar on.
+## Firewall
+
+You need to allow the `NorthstarLauncher.exe` in the firewall so that it can connect to the internet. By default, when you launch the server, it should pop up the Windows security alert and let you decide if the application able to connect to the network.
+
+If you accidentally click the deny button, then follow the step to allow it.
+
+* Open windows firewall
+* Select "Allow an app or feature through Windows Defender Firewall
+* Click allow other applications
+* Click browse
+* Locate the NorthstarLauncher.exe and select it
+* Click add
+
## Final checks
To check whether you set everything up correctly, start the game via Northstar and go into a private match. Another Northstar user should now be able to see your server on the server browser and join it.\