spiretf/webrcon
1
0
Fork 0
mirror of https://codeberg.org/spire/webrcon.git synced 2026-06-04 01:34:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update readme

Browse source
This commit is contained in:
Robin Appelman 2015-11-21 14:39:50 +01:00
commit 82b6deb2f3
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -40,3 +40,12 @@ const rcon = new Rcon('127.0.0.1', 'secret_rcon_password');
```
### API
- `status(): Promise<Object>` get server status including players
- `getSVar(string: name): Promise<String>` get the value of a server var
- `setSVar(string: name, string: value): Promise` set the value of a server var
- `changeLevel(string: level): Promise` change the level
- `sendString(string: command): Promise<string>` send a raw rcon command