search

Florian2406 / Okolni-Source-Query

Source Engine Query Requests in C#
GNU Lesser General Public License v3.0
21 stars 3 forks source link

readme

Okolni-SourceEngine-Ouery

Contributors Forks Stargazers Issues LGPL License Nuget


View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Usage
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgements

About The Project

The project is a simple package made for C#/.NET Source Query Requests. Main features are the default requests that can also be found on the source query documentation in the Valve developer community wiki. For a list of implemented requests see the roadmap below.

Built With

Usage

First download the nuget package and import the namespace Okolni.Source.Query which is the main namespace. After that you can use the project as in the code example below. You create a query connection with an ip and a port and after connecting you can get started with your requests.

IQueryConnection conn = new QueryConnection();

conn.Host = "127.0.0.1"; // IP
conn.Port = 27015; // Port

conn.Connect(); // Create the initial connection

var info = conn.GetInfo(); // Get the Server info
var players = conn.GetPlayers(); // Get the Player info
var rules = conn.GetRules(); // Get the Rules

For an example view the demo project Demo

Roadmap

Implemented so far:

Missing at the moment:

Also see the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the LGPL-3.0 License. See LICENSE for more information.

Contact

Florian Adler - @florian2406

Project Link: https://github.com/Florian2406/Okolni-Source-Ouery

Acknowledgements