JavaScript/TypeScript version of bzfquery for Deno with no external dependencies. It can also be used as a library or from the command line.
Repository
Current version released
4 years ago
bzfquery.js
JavaScript (TypeScript) version of bzfquery. Requires Deno to run. It can also be used as a library.
Usage: deno run --allow-net bzfquery.ts host:port
Use in your code
import bzfquery from "https://deno.land/x/bzfquery.js/bzfquery.ts";
bzfquery("localhost", 5154).then((data) => console.log(JSON.stringify(data, null, 2)));
Use without downloading: deno run --allow-net https://deno.land/x/bzfquery.js/bzfquery.ts host:port
More documentation can be found here.
Types
Name | Type |
---|---|
TeamName |
"Rogue" or "Red" or "Green" or "Blue" or "Purple" or "Observer" or "Rabbit" or "Hunter" |
IBZFQuery
Property | Type | Extra Info |
---|---|---|
style |
"FFA" or "CTF" or "OFFA" or "Rabbit" |
|
options |
IGameOptions |
|
teams |
ITeam[] |
|
players |
IPlayer[] |
|
maxPlayerScore |
number |
|
maxTeamScore |
number |
|
maxPlayers |
number |
|
maxShots |
number |
|
timeLimit |
number |
Measured in deciseconds |
elapsedTime |
number |
Measured in deciseconds |
shake |
false or {wins: number, timeout: number} |
timeout is in deciseconds |
IGameOptions
Property | Type |
---|---|
flags |
boolean |
jumping |
boolean |
inertia |
boolean |
ricochet |
boolean |
shaking |
boolean |
antidote |
boolean |
handicap |
boolean |
noTeamKiils |
boolean |
ITeam
Property | Type | Extra Info |
---|---|---|
name |
TeamName |
|
players |
number |
|
maxPlayers |
number |
|
wins |
number |
(Optional) does not exist on Observer team |
losses |
TeamName |
(Optional) does not exist on Observer team |
IPlayer
Property | Type | Extra Info |
---|---|---|
team |
TeamName |
|
wins |
number |
|
losses |
number |
|
tks |
number |
|
callsign |
string |
|
motto |
string |
May be an empty string |