Installation

The unproblematic instructions to get you upwardly and running with Steamworks.Cyberspace!

To use Steamworks.Cyberspace you must already be a Steamworks developer.

Unity Instructions

  • Option A: .unitypackage
    1. Download the .unitypackage from the Releases page on GitHub.
    2. Import everything into your project.
  • Option B: Unity Bundle Manager
    1. Open up the Parcel Manager
    2. Click the "+" (plus) button located in the upper left of the window
    3. Select the "Add package from git URL…" option
    4. Enter the following URL: https://github.com/rlabrecque/Steamworks.Cyberspace.git?path=/com.rlabrecque.steamworks.net to go the latest version from the principal co-operative on github. It'southward recommended to specify a version number at the stop such as: https://github.com/rlabrecque/Steamworks.NET.git?path=/com.rlabrecque.steamworks.cyberspace#twenty.0.0 to become a pinned specific version. The latest version number tin can be found on the Releases page on GitHub.
    5. Click the "Add" button and wait several seconds for the organization to download and install the Steamworks.NET package from GitHub.
    6. Recommended only Optional: Manually download the SteamManager MonoBehavior which contains a starting signal for using the Steamworks API in your project.
  • Selection C: Manual installation
    1. Download the latest version from the GitHub master co-operative (direct link).
    2. Re-create the com.rlabrecque.steamworks.net/ folder into your projection'south Assets/ folder via explorer or finder, exercise not try to drag and drop it into Unity's Project window.
    3. Recommended but Optional: Manually download the SteamManager MonoBehaviour which contains a starting point for using the Steamworks API in your project.
  • Once imported the included editor scripts will copy steam_appid.txt into the root of your project.
  • Open the steam_appid.txt which now resides in the root of your Unity projection and replace 480 with your own AppId. Ensure you save this file as ASCII or UTF-eight without a BOM.
  • Close Unity and relaunch the project and then that it loads the freshly updated steam_appid.txt.
  • Head over to Getting Started to start using Steamworks.NET!

Steamworks.NET is a free project but if it helps you make coin please consider donating and so that I tin continue to support it in the years to come!

Support via Paypal

Too never ever required but greatly appreciated is a mention in your credits! It's complimentary, easy, and tin help a lot! (Examples)

Non-Unity Instructions

If y'all are non using Unity so you accept two bachelor paths that yous can have.

  • Option A: The recommended road is to build the standalone assemblies with the project file located in Standalone/ or download the prebuilt binaries which are available on the Releases page.
    1. Open the Visual Studio solution (.sln) file, build both targets one for Windows and one for OSX & Linux. (Optional if you downloaded a prebuilt version)
    2. Reference the built associates (Steamworks.Cyberspace.dll) in your projection.
    3. Starting time coding! Call SteamAPI.Init() before initializing your renderer.
  • Pick B: Otherwise, re-create Plugins/Steamworks.Net directly into your C# projection. In Visual Studio open your project properties, change to the Build tab and ascertain STEAMWORKS_WIN or STEAMWORKS_LIN_OSX globally via Conditional compilation symbols.
    • This is only recommended if your binary is non portable beyond platforms already. If you ship on multiple platforms you must have multiple build targets for each platforms. Please prefer the start route.
  • When you build your application the following files must exist copied into the output dir:
    • All Platforms:
      • steam_appid.txt - Required for testing your application exterior of steam. Practice not ship this to customers!
      • Steamworks.NET.dll - Make sure information technology's the right version for the platform that you plan on shipping for! - When building for OSX or Linux the incorrect Steamworks.NET.dll will exist copied over past default, information technology is recommended that you create a mail build script to copy the correct version.
    • Windows:
      • steam_api.dll
    • Linux:
      • libsteam_api.and then

Head over to Getting Started to start using Steamworks.Cyberspace

Steamworks.Net is a complimentary project but if information technology helps you make money delight consider altruistic so that I can go on to back up information technology in the years to come! Also never ever required but greatly appreciated is a mention in your credits. (Examples)

Support via Paypal

Upgrade Instructions

Unity upgrade notice: If yous're upgrading from Steamworks.NET 15.0.1 or earlier to 20.0.0 or later, or switching betwixt one of the 3 different installation types you MUST remove the previous install of Steamworks.Net before continuing equally the projection construction has inverse to support the Unity Package Director.

If yous are upgrading with the Unity Package Manager, just re-import the package, and optionally bring in the latest changes from SteamManager into your projection. If you're using the #version tag, you may demand to uninstall your electric current release before reimporting a newer version.

If you lot're not using the Unity Bundle Managing director, follow the Uninstallation steps beneath, then re-follow the installation steps above.

Uninstallation

Steamworks.NET does not come up with an easy one click uninstaller, merely it stores no additional information and tin can exist cleanly removed but by removing the files that were initially imported, or removing Steamworks.NET from the Unity Bundle Manager. This can be quickly done simply by deleting the com.rlabrecque.steamworks.net directory, the SteamManager.cs script, and then the steam_appid.txt in the root of your project.

Using Steam Encrypted App Ticket?

The functions exposed via sdkencryptedappticket.h are supported in Steamworks.NET but you will need to manually place the sdkencryptedappticket.dll/and so/dylib binaries in one of the following locations depending on the platform:

  • Windows: Next to steam_api.dll
  • OSX: In /Contents/Frameworks/MonoEmbedRuntime/osx/
  • Linux: Next to libsteam_api.so

sdkencryptedappticket.dll tin be plant in the Steamworks SDK.