Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyilcode/steamquerynet
Steam Server Query API written in netstandard2.0
https://github.com/cyilcode/steamquerynet
csharp net netcore netstandard20 steam steam-api steam-query
Last synced: about 1 month ago
JSON representation
Steam Server Query API written in netstandard2.0
- Host: GitHub
- URL: https://github.com/cyilcode/steamquerynet
- Owner: cyilcode
- License: mit
- Created: 2018-07-28T12:06:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-28T20:07:32.000Z (about 2 years ago)
- Last Synced: 2024-11-14T04:41:54.373Z (about 1 month ago)
- Topics: csharp, net, netcore, netstandard20, steam, steam-api, steam-query
- Language: C#
- Size: 47.9 KB
- Stars: 16
- Watchers: 3
- Forks: 14
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# SteamQueryNet
SteamQueryNet is a C# wrapper for [Steam Server Queries](https://developer.valvesoftware.com/wiki/Server_queries) UDP protocol. It is;
* Light
* Dependency free
* Written in .net standard 2.0 so that it works with both .NET framework 4.6+ and core.
# How to install ?
Check out [SteamQueryNet](https://www.nuget.org/packages/SteamQueryNet/) on nuget.
# How to use ?
SteamQueryNet comes with a single object that gives you access to all API's of the [Steam protocol](https://developer.valvesoftware.com/wiki/Server_queries) which are;
* Server information (server name, capacity etc).
* Concurrent players.
* Server rules (friendlyfire, roundttime etc). **Warning: currently does not work due to a protocol issue on steam server query API. Use could make use of ServerInfo.tags if the server admins are kind enough to put rules as tags in the field.**
## Creating an instance
To make use of the API's listed above, an instance of `ServerQuery` should be created.
```csharp
string serverIp = "127.0.0.1";
int serverPort = 27015;
IServerQuery serverQuery = new ServerQuery(serverIp, serverPort);
```
or you can use string resolvers like below:
```csharp
string myHostAndPort = "127.0.0.1:27015";
// or
myHostAndPort = "127.0.0.1,27015";
// or
myHostAndPort = "localhost:27015";
// or
myHostAndPort = "localhost,27015";
// or
myHostAndPort = "steam://connect/127.0.0.1:27015";
// or
myHostAndPort = "steam://connect/localhost:27015";
IServerQuery serverQuery = new ServerQuery(myHostAndPort);
```
Also, it is possible to create `ServerQuery` object without connecting like below:
```csharp
IServerQuery serverQuery = new ServerQuery();
serverQuery.Connect(host, port);
```
*Note*: `Connect` function overloads are similar to `ServerQuery` non-empty constructors.
## Providing Custom UDPClient
You can provide custom UDP clients by implementing `IUdpClient` in `SteamQueryNet.Interfaces` namespace.
See the example below:
```csharp
public class MyAmazingUdpClient : IUdpClient
{
public bool IsConnected { get; }
public void Close()
{
// client implementation
}
public void Connect(IPEndPoint remoteIpEndpoint)
{
// client implementation
}
public void Dispose()
{
// client implementation
}
public Task ReceiveAsync()
{
// client implementation
}
public Task SendAsync(byte[] datagram, int bytes)
{
// client implementation
}
}
// Usage
IPEndpoint remoteIpEndpoint = new IPEndPoint(IPAddress.Parse(remoteServerIp), remoteServerPort);
IUdpClient myUdpClient = new MyAmazingUdpClient();
IServerQuery serverQuery = new ServerQuery(myUdpClient, remoteIpEndpoint);
```
once its created functions below returns informations desired,
[ServerInfo](https://github.com/cyilcode/SteamQueryNet/blob/master/SteamQueryNet/SteamQueryNet/Models/ServerInfo.cs)
```csharp
ServerInfo serverInfo = serverQuery.GetServerInfo();
```
[Players](https://github.com/cyilcode/SteamQueryNet/blob/master/SteamQueryNet/SteamQueryNet/Models/Player.cs)
```csharp
List players = serverQuery.GetPlayers();
```
[Rules](https://github.com/cyilcode/SteamQueryNet/blob/master/SteamQueryNet/SteamQueryNet/Models/Rule.cs)
```csharp
List rules = serverQuery.GetRules();
```
While **it is not encouraged**, you can chain `Connect` function or Non-empty Constructors to get information in a single line.
```csharp
ServerInfo serverInfo = new ServerQuery()
.Connect(host, port)
.GetServerInfo();
```
# Todos
* Enable CI