diff --git a/INSTALL.md b/INSTALL.md index aa671d62c..65195d12d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -6,15 +6,17 @@ 3. Install the Visual Studio 2022 re-distributable. You can find it in the `hlu/redist` directory. -4. Install the [.NET SDK which includes the runtime](docs/dotnet-tools.md#installing-the-net-sdk). Make sure to install the latest version as the runtime is updated regularly. +4. Install the [.NET 6 SDK which includes the runtime](docs/dotnet-tools.md#installing-the-net-sdk). Make sure to install the latest version as the runtime is updated regularly. -5. Run the [ContentInstaller](docs/tools/content-installer.md) tool in a command line window: +5. Switch Half-Life to the `steam_legacy` branch. The Unified SDK has not been updated to the anniversary version and requires the old version. This is only required during installation; after installation you can switch back to the anniversary version. + +6. Run the [ContentInstaller](docs/tools/content-installer.md) tool in a command line window: ```bat cd "path/to/Half-Life/directory" dotnet "hlu/tools/ContentInstaller.dll" --mod-directory hlu ``` -6. Restart Steam so the game is added to the list of games. +7. Restart Steam so the game is added to the list of games. # Running the game diff --git a/README.md b/README.md index 05439ca21..78da34b23 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ The goal of the Unified SDK is to allow modders to make mods based on these game A mod installation is also provided to allow players to play these games with all bug fixes applied. It includes files that are required when making a mod based on this SDK. +The Unified SDK works on the `steam_legacy` and anniversary versions of the game but requires the game to be switched to the `steam_legacy` version during installation. See the installation guide for more information. + > Warning >
> Due to how some SDK features are implemented demos will not work properly. Use an external program like OBS to record the game.
diff --git a/docs/dotnet-tools.md b/docs/dotnet-tools.md index 7a87835e2..a680b6477 100644 --- a/docs/dotnet-tools.md +++ b/docs/dotnet-tools.md @@ -6,7 +6,7 @@ The Unified SDK uses tools written in .NET. These tools are intended to work on ### Installing the .NET SDK -.NET tools require the .NET SDK. +.NET tools require the .NET 6 SDK. You can download the SDK here: https://dotnet.microsoft.com/en-us/download