Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aeonlucid/steamworkssharp
Yet another C# steamworks library.
https://github.com/aeonlucid/steamworkssharp
csharp steam steamworks
Last synced: about 9 hours ago
JSON representation
Yet another C# steamworks library.
- Host: GitHub
- URL: https://github.com/aeonlucid/steamworkssharp
- Owner: AeonLucid
- License: other
- Created: 2018-04-27T15:29:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-25T13:04:10.000Z (over 4 years ago)
- Last Synced: 2024-05-29T05:12:47.487Z (8 months ago)
- Topics: csharp, steam, steamworks
- Language: C#
- Size: 780 KB
- Stars: 5
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SteamworksSharp
===================
Yet another C# steamworks interop library.
## Versions
| Project | NuGet | AppVeyor |
|-|-|-|
| SteamworksSharp | [](https://ci.appveyor.com/project/AeonLucid/SteamworksSharp) | [](https://www.nuget.org/packages/SteamworksSharp) |
| SteamworksSharp.Native.Linux_x86 | [](https://ci.appveyor.com/project/AeonLucid/SteamworksSharp) | [](https://www.nuget.org/packages/SteamworksSharp.Native.Linux_x86) |
| SteamworksSharp.Native.Linux_x64 | [](https://ci.appveyor.com/project/AeonLucid/SteamworksSharp) | [](https://www.nuget.org/packages/SteamworksSharp.Native.Linux_x64) |
| SteamworksSharp.Native.Windows_x86 | [](https://ci.appveyor.com/project/AeonLucid/SteamworksSharp) | [](https://www.nuget.org/packages/SteamworksSharp.Native.Windows_x86) |
| SteamworksSharp.Native.Windows_x64 | [](https://ci.appveyor.com/project/AeonLucid/SteamworksSharp) | [](https://www.nuget.org/packages/SteamworksSharp.Native.Windows_x64) |
| SteamworksSharp.Native.Osx_x86 | [](https://ci.appveyor.com/project/AeonLucid/SteamworksSharp) | [](https://www.nuget.org/packages/SteamworksSharp.Native.Osx_x86) |
## How do I use this?
Check the example project [here](https://github.com/AeonLucid/SteamworksSharp/tree/master/SteamworksSharp.Example) or follow the steps below.
### Installation
First, install the base package `SteamworksSharp` and `SteamworksSharp.Native`.
If you are developing for a `x86` platform (most likely not), install;
- `SteamworksSharp.Native.Windows_x86`
- `SteamworksSharp.Native.Linux_x86`
- `SteamworksSharp.Native.Osx_x86`
If you are developing for a `x64` platform, install;
- `SteamworksSharp.Native.Windows_x64`
- `SteamworksSharp.Native.Linux_x64`
The native packages provide the necessary steam binaries to use the library.
### Using the library
First, you have to initialize `SteamNative`.
```csharp
SteamNative.Initialize();
```
This will load the native steam binaries from the installed NuGet packages from the installation step. It will either succeed or throw an exception telling you that the required binary could not be found.
Now you have to initialize `SteamApi`.
```csharp
var result = SteamApi.Initialize(480); // Replace 480 with your appid.
```
If the `result` is `false`, you can not use the library. Either the native library for your platform could not be found, steam is not running or the `steam_appid.txt` content is wrong.
> If you are sure that you have done everything correctly, open the `steam_appid.txt` in a hex editor. Make sure it does not contain a [byte order mark (BOM)](https://en.wikipedia.org/wiki/Byte_order_mark), which looks like `EF BB BF`. If it does, remove it and you are good to go.
You can also check if steam is open using;
```csharp
var result = SteamApi.IsSteamRunning();
```
## Why?
Why not?
## License
Do whatever you want a.k.a. MIT. (Except for the steam binaries)