FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

zakkar/Steamworks.NET · GitHub

 
 

Latest commit

 

History

133 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Steamworks.NET

Steamworks.NET is a C# Wrapper for Valve's Steamworks API, it can be used either with Unity or your C# based Application. This project relies on dynamic libraries created by CSteamworks. (Prebuilt and included for ease of use)

Steamworks.NET was designed to be as close as possible to the original C++ API, as such the documentation provided from Valve largely covers usage of Steamworks.NET. Niceties and C# Idioms can be easily implemented on top of Steamworks.NET.

Steamworks.NET currently supports Windows, OSX, and Linux in both 32 and 64bit varieties. Currently building against Steamworks SDK 1.29a.

Usage

To use Steamworks.NET you must be a Steamworks developer. Steamworks.NET requires Unity Pro for the plugin functionality.

  • Clone or download a Zip Archive: Stable (3.0.0) -- Master (Cutting-edge)
  • Extract and copy Steamworks.NET's Plugins/ and Editor/ folders into your Assets/ folder.
  • Open Plugins/Steamworks.NET/redist/steam_appid.txt and replace 480 with your own AppId.
  • Launch your Unity project. It should copy steam_appid.txt (and steam_api.dll if your on windows) into the root of your project.
  • Close Unity and relaunch the project so that it loads the newly copied steam_appid.txt & steam_api.dll.
Samples

Check out these sample projects to get started:

Not using Unity?

If you are not using Unity then you have two available routes that you could take.

  • A: Copy Plugins/Steamworks.NET into your C# project. In Visual Studio open your project properties, change to the Build tab and define STEAMWORKS_WIN or STEAMWORKS_LIN_OSX globally via Conditional compilation symbols.
  • This is only recommended if your binary is not portable across platforms already. If you ship on multiple platforms you must have multiple build targets for each platforms. Please prefer the second route.
  • B: The peferable route is to build the standalone assemblies, with the project file located in Standalone/. Alternatively you can download the prebuilt binaries (2.0.0).
  • Further instructions are provided by the README.md in the Standalone/ folder.

Using Steam Encrypted App Ticket?

If you wish to use the functions from sdkencryptedappticket.dll then you will need to manually place the dll/so/dylib in the following location:

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

sdkencryptedappticket.dll can be found in the Steamworks SDK.

Limitations

  • Steamworks.NET does not currently support ISteamAppTicket or ISteamGameCoordinator.
  • The following Interfaces are largely untested (but should be completely functional):
ISteamAppsList
ISteamMatchmaking
ISteamMusic
ISteamNetworking
ISteamUGC
ISteamUnifiedMessages
ISteamGameServer
  • The following are Unity specific issues and are out of our control, ALL Steamworks wrappers for Unity experience these issues.
  • When used from within the Unity Editor, Steam will think you are in game constantly. This is normal and does not effect usage.
  • The Overlay only works when launched from Steam directly. (A small number of Steamworks features (such as the Steam Controller) rely on the overlay being present. Prefer using a Local Content Server for testing.)

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors


Back | FazBrowse Home | New Git URL