Skip to content

Commit 8e70611

Browse files
committed
update readme
1 parent b236b28 commit 8e70611

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
11
# SourceQuery-Powershell
22

3-
[SourceQuery](https://developer.valvesoftware.com/wiki/Server_queries) and [Rcon](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) interface for [Source](https://developer.valvesoftware.com/wiki/Source) and [Goldsource](https://developer.valvesoftware.com/wiki/Goldsource) games.
4-
3+
Powershell implementation of [SourceQuery](https://developer.valvesoftware.com/wiki/Server_queries) and [Rcon](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) for [Source](https://developer.valvesoftware.com/wiki/Source) and [Goldsource](https://developer.valvesoftware.com/wiki/Goldsource) games.
54

65
## Minumum Requirements
76

8-
- `Powershell` V5 or later or `Powershell Core` (aka `pwsh`)
9-
10-
## Debugging
11-
12-
Use the `-Verbose` switch to turn on verbose output.
7+
- [`Powershell` V5](https://www.microsoft.com/en-us/download/details.aspx?id=50395) or later or [`Powershell Core`](https://github.com/powershell/powershell) (aka `pwsh`)
138

149
## Verified games
1510

@@ -18,13 +13,12 @@ Engine | Games
1813
`Source` (`srcds`) | `left4dead2`, `csgo`
1914
`Goldsource` (`hlds`) | `cstrike`, `czero`, `valve`. Should work for all `hlds` games.
2015

21-
The library will probably work on a lot more games than those in the list.
16+
The libraries will probably work on a lot more games than those in the list.
2217

23-
## Additional Notes
18+
## Notes
2419

2520
The libraries are *stateless* - that is, `SourceQuery`, `SourceRcon`, and `GoldsourceRcon` are pure functions, storing no authentication or challenge states. This is to be expected for Source Queries, but not for Rcon. A possible future area of improvement would be to make `SourceRcon` and `GoldsourceRcon` construct and return a stateful Rcon object, that would improve client performance especially when multiple rcon commands need to be executed in sequence.
2621

27-
2822
## SourceQuery Examples
2923

3024
### Source Engine
@@ -77,4 +71,8 @@ SourceRcon -Address $ip -Port $port -Password $rcon_password -Command 'status'
7771
```powershell
7872
Import-Module GoldsourceRcon
7973
GoldsourceRcon -Address $ip -Port $port -Password $rcon_password -Command 'status'
80-
```
74+
```
75+
76+
## Debugging
77+
78+
Use the `-Verbose` switch to turn on verbose output.

0 commit comments

Comments
 (0)