-
Notifications
You must be signed in to change notification settings - Fork 496
Installation
As SteamKit is a .NET library, installing is as simple as adding the library as a reference to your project.
There are, however, some specific steps to take depending on your development environment.
If you're using Visual Studio, the preferred method of adding SteamKit to your project is to use the package manager and install the NuGet package.
If you don't have NuGet installed, start by installing it.
After that, there are two ways to install the NuGet package:
- The NuGet Package Dialog.
- The NuGet Package Console.
Regardless of the method, the package you want to install is named SteamKit2.
After installing the package, NuGet should work out the dependencies, download the required binaries, and add a reference to SteamKit to your project.
If you're not using Visual Studio, or otherwise can't use NuGet, you can download a SteamKit binary package from our releases page.
After that, simply extract the library files to a directory of your choosing, and add SteamKit2.dll as a reference to your project.
If you are compiling SteamKit, note that the project requires protobuf-net in order to build.
If you are using Visual Studio, NuGet should automatically resolve this dependency and download the required version of protobuf-net and add it as a reference to the SteamKit project. This step happens when building the project.
If for some reason this does not happen, please ensure that your NuGet is up to date and that you have enabled Package Restore.
If you are not using Visual Studio or NuGet, you must manually download and install protobuf-net and add it as a reference to the SteamKit project.
When deploying an application that uses SteamKit, be sure to include SteamKit2.dll and the required dependency, protobuf-net.dll, with your program.