United the instructions into one large section

nullsystem · nullsystem · commit b2b2bc323d61 · 2025-03-02T02:21:50.000Z
diff --git a/README.md b/README.md
@@ -139,17 +139,27 @@ For setting up the Steam mod:
 https://developer.valvesoftware.com/wiki/Setup_mod_on_steam
 
 ## Server instructions
-### Steam Networking
+
+### Hosting from the client - Steam Networking
 Since the TF2-SDK/64-bit update, NT;RE has Steam Networking support, meaning hosting an online server is
 as easy as doing: `"Create Server" -> "Start"`. Just make sure "Use Steam networking" is set to "Enabled" and
 alter the relevant configurations.
 
-### Server Ops
-#### Dedicated Server on Linux
-These instructions have been written with a Debian 12 machine in mind, but they should work for other systems as well.
-1. Install SteamCMD following these instructions: [LINK](https://developer.valvesoftware.com/wiki/SteamCMD#Linux)
-2. Decide on a location you'd like to install the server to, for example, `/home/<username>/neoserver`, and create it.
-3. Run SteamCMD: `steamcmd`
+### Dedicated server hosting
+
+These instructions have been written for and tested on Debian 12 and Arch for Linux, and Windows Server 2016 and Windows 11 for Windows, but should work with a fairly up to date Linux and Windows systems as well.
+
+#### Downloading server files - SteamCMD
+
+> [!TIP]
+> Server operators should always use the SteamCMD setup, otherwise if doing quick tests or developing and have Steam installed, you can just install "Source SDK Base 2013 Dedicated Server" (appid 244310) from Steam and assuming you've already have NT;RE client setup can skip the SteamCMD steps. Any instructions referring to `<YOUR_LOCATION>/ntrebuild` will instead use: `<PATH_TO_STEAM>/common/Source SDK Base 2013 Dedicated Server`.
+
+> [!WARNING]
+> As of the TF2-SDK update, if trying to use the dedicated server downloaded from Steam but not through the detailed SteamCMD instructions, Linux will fail to find the files necessary to startup a working server. Just follow the SteamCMD server setup instructions for now.
+
+1. Install SteamCMD following these instructions: [LINK](https://developer.valvesoftware.com/wiki/SteamCMD#Downloading_SteamCMD)
+2. Choose a location you'd like to install the server to, for example on Linux: `/home/<username>/neoserver` or on Windows: `C:\NeotokyoServer\`, and create it. **This will be referred as `<YOUR_LOCATION>` in the later steps, and the forward-slash directory separation replaced with back-slash for Windows.** (Also in this case SteamCMD is also installed in this location)
+3. Run SteamCMD: `steamcmd`/`steamcmd.exe`
 4. Enter the following commands in SteamCMD (Note that you need to use an absolute path for the install dir):
     ```
     force_install_dir <YOUR_LOCATION>/ognt/
@@ -166,16 +176,23 @@ These instructions have been written with a Debian 12 machine in mind, but they
     (wait for it to install)
     quit
     ```
-6. The distribution of the dedicated servers currently misplaced some few files, here's the following files missing on Linux:
-    ```
-    srcds_linux64
-    srcds_run_64
-    bin/linux64/libsteam_api.so
-    ```
-    You may either fetch them from the Linux Source SDK 2013 Multiplayer client (appid 243750) or TF2's Dedicated Server (appid 232250).
+6. The distribution of the dedicated servers currently misplaced a few files:
+    * Linux:
+      ```
+      srcds_linux64
+      srcds_run_64 # NOTE - Only TF2's dedicated server have this script
+      bin/linux64/libsteam_api.so
+      ```
+    * Windows:
+      ```
+      srcds_win64.exe
+      ```
+
+    You may either fetch them from the Source SDK 2013 Multiplayer client (appid 243750) or TF2's Dedicated Server (appid 232250).
     Once they're fetched, place them in the `<YOUR_LOCATION>/ntrebuild` directory.
 
-7. Make a symlink for original NEOTOKYO so that NT;RE can find it's assets:
+#### Linux-only additional instructions
+7. **Linux only:** Make a symlink for original NEOTOKYO so that NT;RE can find it's assets:
 
     Run the following command as root:
     ```
@@ -184,19 +201,13 @@ These instructions have been written with a Debian 12 machine in mind, but they
     It should now be possible to access `/usr/share/neotokyo/NeotokyoSource`.
    
     This is the only command that needs root, so you can logout from root.
-8. Make a symlink so that Src2013 dedicated server can see SteamCMD's binaries:
+8. **Linux only:** Make a symlink so that Src2013 dedicated server can see SteamCMD's binaries:
 
     (NOTE: I'm NOT sure if this is how it is on other systems other than Debian 12, so please, check first if you have `~/.steam/sdk64` before running these! If you have Desktop Steam installed, then you should have this directory, but it doesn't seem to be the case with SteamCMD, which is why we need to do this.)
     ```
     ln -s ~/.steam/steam/steamcmd/linux64 ~/.steam/sdk64
     ```
-9. For firewall, open the following ports:
-    * 27015 TCP+UDP (you can keep the TCP port closed if you don't need RCON support)
-    * 27020 UDP
-    * 27005 UDP
-    * 26900 UDP
-10. `cd` into `<YOUR_LOCATION>/ntrebuild/bin/linux64`.
-11. Run these commands to make symlinks for needed files:
+10. **Linux only:** Change directory into `<YOUR_LOCATION>/ntrebuild/bin/linux64` then run these commands to make symlinks for needed files:
     ```
     ln -s datacache_srv.so datacache.so;
     ln -s dedicated_srv.so dedicated.so;
@@ -212,109 +223,59 @@ These instructions have been written with a Debian 12 machine in mind, but they
     ln -s vphysics_srv.so vphysics.so;
     ln -s vscript_srv.so vscript.so;
     ```
-12. `cd` up directories twice, so that you will be in `<YOUR_LOCATION>/ntrebuild`.
-13. Extract the latest release of NT;RE into `<YOUR_LOCATION>/ntrebuild`, so you will have a directory `<YOUR_LOCATION>/ntrebuild/neo` with a `gameinfo.txt` inside.
+11. `cd` up directories twice, so that you will be in `<YOUR_LOCATION>/ntrebuild`.
 
-Now you have a dedicated server setup for NT;RE. To run it, you will need to be in the `<YOUR_LOCATION>/ntrebuild` directory and run `srcds_run` with whatever arguments. You can adapt the following command to your own liking:
-```
-./srcds_run_64 +sv_lan 0 -insecure -console -game neo +ip <YOUR_IP> -maxplayers <1-32> +map <MAP_NAME>
-```
-#### Dedicated Server on Windows
-These instructions were tested on Windows Server 2016 and Windows 11 machines, they will probably work in all Windows versions.
-1. Install SteamCMD following these instructions: [LINK](https://developer.valvesoftware.com/wiki/SteamCMD#Windows)
-2. Choose a location for your server to be installed into, for example, `C:\NeotokyoServer\`, and create it. (In this case SteamCMD is also installed in this location)
-3. Run SteamCMD: `steamcmd.exe`
-4. Enter the following commands in SteamCMD:
-    ```
-    force_install_dir .\ognt\
-    login anonymous
-    app_update 313600 validate
-    (wait for it to install)
-    quit
-    ```
-5. Run SteamCMD again, and enter these commands:
-    ```
-    force_install_dir .\ntrebuild\
-    (this will be the main directory of your server)
-    login anonymous
-    app_update 244310 validate
-    (wait for it to install)
-    quit
-    ```
-6. The distribution of the dedicated servers currently misplaced some few files, here's the following files missing on Windows:
-    ```
-    srcds_win64.exe
-    ```
-    You may either fetch them from the Windows Source SDK 2013 Multiplayer client (appid 243750) or TF2's Dedicated Server (appid 232250).
-    Once they're fetched, place them in the `<YOUR_LOCATION>\ntrebuild` directory.
+#### Extracting NT;RE
+Extract the latest release of NT;RE into `<YOUR_LOCATION>/ntrebuild`, so you will have a directory `<YOUR_LOCATION>/ntrebuild/neo` with a `gameinfo.txt` inside.
 
-7. Extract the latest release of NT;RE into `<YOUR_LOCATION>\ntrebuild`, so you will have a directory `<YOUR_LOCATION>\ntrebuild\neo` with a `gameinfo.txt` inside.
-8. Allow all Inbound and Outbound TCP and UDP requests for the following ports via Windows Firewall. [See how](https://learn.microsoft.com/en-us/windows/security/operating-system-security/network-security/windows-firewall/configure#create-an-inbound-port-rule)
-    * 27015 TCP+UDP (you can keep the TCP port closed if you don't need RCON support)
-    * 27020 UDP
-    * 27005 UDP
-    * 26900 UDP
-9. Your server should be ready to go, launch it inside your main directory (`(...)\ntrebuild\`) with the following command: (You can alter any argument to your liking, except `-game` and `-neopath`) 
-```
-srcds_win64.exe -game neo -neopath "..\ognt\NeotokyoSource" +ip <YOUR_IP> -maxplayers <1-32> +map <MAP_NAME>
-```
+##### Developer-only: Mounting NT;RE
+If you're developing and just testing the server, it may be more useful to mount it to your `game/neo` from the git checkout.
 
-### Testers/Devs
+* Windows: `mklink /J neo "<path_to_source>/game/neo"`
+* Linux: Non-persistent bind mount: `mkdir neo && sudo mount --bind <path_to_source>/game/neo neo`
 
-> [!WARNING]
-> As of the TF2-SDK update, Linux will fail to find the files necessary to startup a working server. Just follow the normal dedicated server instruction for now.
+Or just use the directory directly when passing to the srcds command line arguments: `-game <path_to_source>/game/neo`.
+
+#### Exposing the server to the wider internet
+
+There are two ways on exposing your dedicated server to the wider internet: Port forwarding and Steam Networking.
 
-1. To run a server, install "Source SDK Base 2013 Dedicated Server" (appid 244310).
-2. For firewall, open the following ports:
+##### Firewall - Port forwarding
+* Open the following ports:
     * 27015 TCP+UDP (you can keep the TCP port closed if you don't need RCON support)
     * 27020 UDP
     * 27005 UDP
     * 26900 UDP
-3. The distribution of the dedicated servers currently misplaced some few files:
-    * Linux:
-        ```
-        srcds_linux64
-        srcds_run_64
-        bin/linux64/libsteam_api.so
-        ```
-    * Windows:
-        ```
-        srcds_win64.exe
-        ```
-    You may either fetch them from the Source SDK 2013 Multiplayer client (appid 243750) or TF2's Dedicated Server (appid 232250).
-    Once they're fetched, place them in the `<PATH_TO_STEAM>/common/Source SDK Base 2013 Dedicated Server` directory.
-4. After it installed, go to the install directory in CMD, should see:
-    * Windows: `srcds_win64.exe`
-    * Linux: `srcds_linux64`
-5. Optional: Link or copy over neo, otherwise `-game <path_to_source>/game/neo` can be used also:
-    * Windows: `mklink /J neo "<path_to_source>/game/neo"`
-    * Linux:
-        * Non-persistent bind mount: `mkdir neo && sudo mount --bind <path_to_source>/game/neo neo`
-        * Or just copy over or use the directory directly
-6. Linux-only: Symlink the names in `<PATH_TO_STEAM>/common/Source SDK Base 2013 Dedicated Server/bin/linux64` directory:
+* **Windows-only:** Allow all Inbound and Outbound TCP and UDP requests for the given ports via Windows Firewall. [See how](https://learn.microsoft.com/en-us/windows/security/operating-system-security/network-security/windows-firewall/configure#create-an-inbound-port-rule)
+
+##### Steam Networking
+
+Since the TF2-SDK update, NT;RE gained the ability to use "Steam Networking" which can be useful in situations where:
+
+* You cannot setup port forwarding or/and altering firewall settings
+* You don't want to expose the server's IP address and device directly
+
+Just add `+sv_use_steam_networking 1` to the `srcds` command line arguments to use Steam Networking for your dedicated server.
+
+#### Running the server
+You will need to be in the `<YOUR_LOCATION>/ntrebuild` directory and run `srcds_win64`/`srcds_run_64`/`srcds_linux64` with whatever arguments. You can adapt the following command to your own liking:
+
+* Windows:
     ```
-    ln -s datacache_srv.so datacache.so;
-    ln -s dedicated_srv.so dedicated.so;
-    ln -s engine_srv.so engine.so;
-    ln -s libtier0_srv.so libtier0.so;
-    ln -s libvstdlib_srv.so libvstdlib.so;
-    ln -s materialsystem_srv.so materialsystem.so;
-    ln -s replay_srv.so replay.so;
-    ln -s scenefilecache_srv.so scenefilecache.so;
-    ln -s shaderapiempty_srv.so shaderapiempty.so;
-    ln -s soundemittersystem_srv.so soundemittersystem.so;
-    ln -s studiorender_srv.so studiorender.so;
-    ln -s vphysics_srv.so vphysics.so;
-    ln -s vscript_srv.so vscript.so;
+    srcds_win64.exe -game neo -neopath "<YOUR_LOCATION>\ognt\NeotokyoSource" +sv_lan 0 -insecure +ip <YOUR_IP> -maxplayers <1-32> +map <MAP_NAME>
+    ```
+* Linux with `srcds_run_64` script:
+    ```
+    ./srcds_run_64 -game neo +sv_lan 0 -insecure -console +ip <YOUR_IP> -maxplayers <1-32> +map <MAP_NAME>
     ```
-6. Linux-only: Before running `srcds_linux64`, some few environment variables need to setup:
-    * `SteamEnv=1`
-    * `LD_LIBRARY_PATH=$(<STEAM-RUNTIME-DIR>/run.sh printenv LD_LIBRARY_PATH):/home/YOUR_USER/.steam/steam/steamapps/Source SDK Base 2013 Dedicated Server/bin`
-        * Where `<STEAM-RUNTIME-DIR>` can be found from: `$ find "$HOME" -type d -name 'steam-runtime' 2> /dev/null`
-        * **Note, this should be the 64-bit variant**
-7. Run: `<srcds_win64.exe|srcds_linux64> +sv_lan 0 -insecure -game neo +map <some map> +maxplayers 24 -autoupdate -console`
-    * Double check on the log that VAC is disabled before continuing
-7. In-game on Windows it'll showup in the server list, on Linux it probably won't and you'll have to use `connect` command directly (EX: `connect 192.168.1.###` for LAN server)
+* Linux with `srcds_linux64` directly:
+    1. Before running `srcds_linux64`, some few environment variables need to setup:
+        * `SteamEnv=1`
+        * `LD_LIBRARY_PATH="<YOUR_LOCATION>/ntrebuild/bin/linux64"` - So it can find the server libraries
+    2. Run: `srcds_linux64 -game neo +sv_lan 0 -insecure -console +map <some map> +maxplayers 24`
+        * In-game it probably won't showup in the server list and you'll have to use `connect` command directly (EX: `connect 192.168.1.###` for LAN server)
+
+If using `-insecure` and intend to playtest without VAC for debugging purposes, double check on the log that VAC is disabled before continuing.
 
 ### SourceMod server modification plugins
 [SourceMod](https://www.sourcemod.net/) plugins should generally work with NT;RE, however they have to be added to the `ShowMenu` whitelist to make the menu display properly. To do this:
diff --git a/src/game/shared/neo/neo_gamerules.h b/src/game/shared/neo/neo_gamerules.h
@@ -37,7 +37,7 @@ enum
 #define TEAM_STR_NSF "NSF"
 #define TEAM_STR_SPEC "Spectator"
 
-#define NEO_GAME_NAME "Neotokyo: Rebuild"
+#define NEO_GAME_NAME "Neotokyo; Rebuild"
 
 #ifdef CLIENT_DLL
 	#define CNEORules C_NEORules
