Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BattlefieldDuck authored Jan 21, 2024
1 parent 456ad5c commit 05fd375
Showing 1 changed file with 14 additions and 31 deletions.
45 changes: 14 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,46 +6,31 @@

The OpenGSQ .NET library provides a convenient way to query servers from applications written in the C# language.

## Documentation

Detailed documentation is available at [https://dotnet.opengsq.com](https://dotnet.opengsq.com).

## Supported Protocols
```cs
using OpenGSQ.Protocols;

var ase = new ASE("79.137.97.3", 22126);
var battlefield = new Battlefield("94.250.199.214", 47200, 10000);
var doom3 = new Doom3("178.162.135.83", 27735);
var eos = new EOS("5.62.115.46", 7783, 5000, clientId, clientSecret, deploymentId);
var fivem = new FiveM("144.217.10.12", 30120);
var gameSpy1 = new GameSpy1("139.162.235.20", 7778);
var gameSpy2 = new GameSpy2("108.61.236.22", 23000);
var gameSpy3 = new GameSpy3("95.172.92.116", 29900);
var gameSpy4 = new GameSpy4("play.avengetech.me", 19132);
var killingFloor = new KillingFloor("104.234.65.235", 7708);
var minecraft = new Minecraft("valistar.site", 25565);
var quake1 = new Quake1("35.185.44.174", 27500);
var quake2 = new Quake2("46.165.236.118", 27910);
var quake3 = new Quake3("108.61.18.110", 27960);
var raknet = new RakNet("mc.advancius.net", 19132);
var samp = new Samp("51.254.178.238", 7777);
var satisfactory = new Satisfactory("79.136.0.124", 15777);
var scum = new Scum("15.235.181.19", 7042);
var source = new Source("45.62.160.71", 27015);
var teamSpeak3 = new TeamSpeak3("145.239.200.2", 10011, 9987);
var unreal2 = new Unreal2("109.230.224.189", 6970);
var vcmp = new Vcmp("51.178.65.136", 8114);
var won = new WON("212.227.190.150", 27020);
```
A list of supported protocols can be found at [https://dotnet.opengsq.com/api/OpenGSQ.Protocols.html](https://dotnet.opengsq.com/api/OpenGSQ.Protocols.html).

## Prerequisities

The library requires a minimum of .NET Standard 2.0.

You can find a list of all supported frameworks at [Supported Frameworks](https://www.nuget.org/packages/OpenGSQ/#supportedframeworks-body-tab).

## Installation

Find the package through NuGet Package Manager or install it with following command.
You can find the package through the NuGet Package Manager or install it using the following command:

```
dotnet add package OpenGSQ
```

## Usage

Source Query Protocol
Here is an example of how to use the Source Query Protocol with OpenGSQ

```cs
using System;
Expand All @@ -69,6 +54,4 @@ class Program

## Tests and Results

See [OpenGSQTests/Protocols](/OpenGSQTests/Protocols) for the tests.

See [OpenGSQTests/Results](/OpenGSQTests/Results) for tests outputs.
You can find information about tests and results at [https://dotnet.opengsq.com/tests](https://dotnet.opengsq.com/tests/ASETests/ASETests.html).

0 comments on commit 05fd375

Please sign in to comment.