|
| 1 | +title: Guide - Install NT;RE (Client) |
| 2 | + |
| 3 | +# Guide - Install NT;RE (Client) |
| 4 | + |
| 5 | +## Operating System Requirement |
| 6 | + |
| 7 | +Only Windows and Linux is supported. Generally aimed to work with |
| 8 | +Windows 10+ and any Linux distros that works with the SteamRT |
| 9 | +3.0 "sniper" runtime. [This document](https://gitlab.steamos.cloud/steamrt/steam-runtime-tools/-/blob/main/docs/distro-assumptions.md) |
| 10 | +gives a comprehensive rundown on SteamRT's assumptions on Linux. |
| 11 | +On Linux, NT;RE is supported natively. Running it through Proton |
| 12 | +is not supported by NT;RE. |
| 13 | + |
| 14 | +## Original NEOTOKYO Assets |
| 15 | + |
| 16 | +NT;RE relies on (original) NEOTOKYO's assets to function. On Steam, just |
| 17 | +download and install [NEOTOKYO](steam://rungameid/244630) regardless of Windows |
| 18 | +or on Linux. Later when NT;RE starts up, it will try to find those files |
| 19 | +automatically if possible and mounts them. |
| 20 | + |
| 21 | +## Source SDK 2013 Multiplayer |
| 22 | + |
| 23 | +Install [Source SDK Base 2013 (MP) Multiplayer](steam://rungameid/243750) (AppID: 243750) |
| 24 | + |
| 25 | +## Downloading NT;RE |
| 26 | + |
| 27 | +Go into [Releases page](https://github.com/NeotokyoRebuild/neo/releases) |
| 28 | +of the NT;RE GitHub repository and pick the highest versioned release |
| 29 | +(EX: v7.1). |
| 30 | +There's also a release that's generally will be on top called "Latest Build" |
| 31 | +however this is just builds straight from the master branch which typically |
| 32 | +won't be used for playtests. |
| 33 | + |
| 34 | +Click on the "Assets" dropdown and should see a list of files available to |
| 35 | +download. There's only two files needed for play NT;RE: |
| 36 | + |
| 37 | +* `neo-YYYYMMDD-GITHASH-resources.zip` |
| 38 | + * EX: `neo-20240803-273dbf3-resources.zip` |
| 39 | +* `neo-YYYYMMDD-GITHASH-libraries-[Windows/Linux]-Release.zip` |
| 40 | + * EX: `neo-20240803-273dbf3-libraries-Windows-Release.zip` |
| 41 | + |
| 42 | +The rest can be ignored as `debuginfo` is for developers to debug crash dumps |
| 43 | +and `dedicated` is for servers. |
| 44 | + |
| 45 | +## Installing NT;RE |
| 46 | + |
| 47 | +Locate the `sourcemods` directory. Assuming the default installation paths |
| 48 | +(adjust if needed if Steam is installed elsewhere): |
| 49 | + |
| 50 | +* Windows: `C:\Program Files (x86)\Steam\steamapps\sourcemods` |
| 51 | +* Linux: `$HOME/.steam/steam/steamapps/sourcemods` |
| 52 | + |
| 53 | +Extract `...-resources.zip` first, there should be a directory called `neo` |
| 54 | +in the `sourcemods` directory now along with NT;RE's specific assets. |
| 55 | + |
| 56 | +Then `...-libraries-[Windows/Linux]-Release.zip` from the location of the |
| 57 | +`sourcemods` directory. This should extract the binaries in `neo/bin`. |
| 58 | + |
| 59 | +## Loading NT;RE |
| 60 | + |
| 61 | +Open (or restart) Steam then "Neotokyo: Rebuild" should popup as an installed |
| 62 | +game. From here, just startup the game and it could go fine generally for |
| 63 | +standard setups. However if you have issues... |
| 64 | + |
| 65 | +## Troubleshooting |
| 66 | + |
| 67 | +### Cannot mount original NEOTOKYO assets |
| 68 | + |
| 69 | +#### Windows |
| 70 | + |
| 71 | +This could happen if you have NEOTOKYO/Steam installed at a non-default |
| 72 | +location. Open up "Properties..." then launch options and set to your |
| 73 | +custom install path: |
| 74 | + |
| 75 | +``` |
| 76 | +-neopath C:\PATH\TO\YOUR\NEOTOKYO\NeotokyoSource\ |
| 77 | +``` |
| 78 | + |
| 79 | +#### Linux |
| 80 | + |
| 81 | +`-neopath` doesn't work properly on Linux, just make sure the original |
| 82 | +assets is in one of the following paths (from the order of path priority): |
| 83 | + |
| 84 | +1. ~/.steam/steam/steamapps/common/NEOTOKYO/NeotokyoSource/ |
| 85 | +2. ~/.local/share/neotokyo/NeotokyoSource/ |
| 86 | +3. /usr/share/neotokyo/NeotokyoSource/ |
| 87 | + |
| 88 | +### Linux - Force SteamRT 3.0 |
| 89 | + |
| 90 | +This is not required, however if you want to make NT;RE run under the |
| 91 | +SteamRT 3.0 runtime: |
| 92 | + |
| 93 | +Ensure ["Steam Linux Runtime 3.0 (sniper)"](steam://rungameid/1628350) is installed, then |
| 94 | +set the launch options: |
| 95 | + |
| 96 | +``` |
| 97 | +steam-runtime-launch-options -- %command% |
| 98 | +``` |
| 99 | + |
| 100 | +When NT;RE is launched, a Window with options should popup. On the top |
| 101 | +"Container runtime" option change from "None" to "sniper 0.YYYYMMDD.VERSION" |
| 102 | +then click "Run". This will popup everytime NT;RE is started through Steam. |
| 103 | + |
0 commit comments