{"id":20272942,"url":"https://github.com/cyilcode/steamquerynet","last_synced_at":"2025-04-11T04:42:45.510Z","repository":{"id":34176428,"uuid":"142674248","full_name":"cyilcode/SteamQueryNet","owner":"cyilcode","description":"Steam Server Query API written in netstandard2.0","archived":false,"fork":false,"pushed_at":"2022-11-28T20:07:32.000Z","size":49,"stargazers_count":17,"open_issues_count":9,"forks_count":14,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-11T04:42:40.210Z","etag":null,"topics":["csharp","net","netcore","netstandard20","steam","steam-api","steam-query"],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cyilcode.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-28T12:06:58.000Z","updated_at":"2025-01-23T02:40:04.000Z","dependencies_parsed_at":"2022-06-28T16:52:14.443Z","dependency_job_id":null,"html_url":"https://github.com/cyilcode/SteamQueryNet","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyilcode%2FSteamQueryNet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyilcode%2FSteamQueryNet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyilcode%2FSteamQueryNet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyilcode%2FSteamQueryNet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyilcode","download_url":"https://codeload.github.com/cyilcode/SteamQueryNet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248345281,"owners_count":21088242,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","net","netcore","netstandard20","steam","steam-api","steam-query"],"created_at":"2024-11-14T12:47:33.130Z","updated_at":"2025-04-11T04:42:45.488Z","avatar_url":"https://github.com/cyilcode.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SteamQueryNet\n\nSteamQueryNet is a C# wrapper for [Steam Server Queries](https://developer.valvesoftware.com/wiki/Server_queries) UDP protocol. It is;\n\n* Light\n* Dependency free\n* Written in .net standard 2.0 so that it works with both .NET framework 4.6+ and core.\n\n# How to install ?\n\nCheck out [SteamQueryNet](https://www.nuget.org/packages/SteamQueryNet/) on nuget.\n\n# How to use ?\n\nSteamQueryNet 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;\n\n* Server information (server name, capacity etc).\n* Concurrent players.\n* 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.**\n\n## Creating an instance\nTo make use of the API's listed above, an instance of `ServerQuery` should be created.\n\n```csharp\nstring serverIp = \"127.0.0.1\";\nint serverPort = 27015;\nIServerQuery serverQuery = new ServerQuery(serverIp, serverPort);\n```\n\nor you can use string resolvers like below:\n\n```csharp\n    string myHostAndPort = \"127.0.0.1:27015\";\n    // or\n    myHostAndPort = \"127.0.0.1,27015\";\n    // or\n    myHostAndPort = \"localhost:27015\";\n    // or\n    myHostAndPort = \"localhost,27015\";\n    // or\n    myHostAndPort = \"steam://connect/127.0.0.1:27015\";\n    // or\n    myHostAndPort = \"steam://connect/localhost:27015\";\n\n    IServerQuery serverQuery = new ServerQuery(myHostAndPort);\n```\n\nAlso, it is possible to create `ServerQuery` object without connecting like below:\n\n```csharp\nIServerQuery serverQuery = new ServerQuery();\nserverQuery.Connect(host, port);\n```\n\n*Note*: `Connect` function overloads are similar to `ServerQuery` non-empty constructors.\n\n## Providing Custom UDPClient\n\nYou can provide custom UDP clients by implementing `IUdpClient` in `SteamQueryNet.Interfaces` namespace.\n\nSee the example below:\n```csharp\npublic class MyAmazingUdpClient : IUdpClient\n    {\n        public bool IsConnected { get; }\n\n        public void Close()\n        {\n            // client implementation\n        }\n\n        public void Connect(IPEndPoint remoteIpEndpoint)\n        {\n            // client implementation\n        }\n\n        public void Dispose()\n        {\n            // client implementation\n        }\n\n        public Task\u003cUdpReceiveResult\u003e ReceiveAsync()\n        {\n            // client implementation\n        }\n\n        public Task\u003cint\u003e SendAsync(byte[] datagram, int bytes)\n        {\n            // client implementation\n        }\n    }\n\n    // Usage\n    IPEndpoint remoteIpEndpoint = new IPEndPoint(IPAddress.Parse(remoteServerIp), remoteServerPort);\n\n    IUdpClient myUdpClient = new MyAmazingUdpClient();\n    IServerQuery serverQuery = new ServerQuery(myUdpClient, remoteIpEndpoint);\n```\n\nonce its created functions below returns informations desired,\n\n[ServerInfo](https://github.com/cyilcode/SteamQueryNet/blob/master/SteamQueryNet/SteamQueryNet/Models/ServerInfo.cs)\n```csharp\nServerInfo serverInfo = serverQuery.GetServerInfo();\n```\n\n[Players](https://github.com/cyilcode/SteamQueryNet/blob/master/SteamQueryNet/SteamQueryNet/Models/Player.cs)\n```csharp\nList\u003cPlayer\u003e players = serverQuery.GetPlayers();\n```\n\n[Rules](https://github.com/cyilcode/SteamQueryNet/blob/master/SteamQueryNet/SteamQueryNet/Models/Rule.cs)\n```csharp\nList\u003cRule\u003e rules = serverQuery.GetRules();\n```\n\nWhile **it is not encouraged**, you can chain `Connect` function or Non-empty Constructors to get information in a single line.\n\n```csharp\nServerInfo serverInfo = new ServerQuery()\n.Connect(host, port)\n.GetServerInfo();\n```\n\n# Todos\n* Enable CI\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyilcode%2Fsteamquerynet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyilcode%2Fsteamquerynet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyilcode%2Fsteamquerynet/lists"}