Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bzflagcommunity/bzfquery.js
JavaScript/TypeScript version of bzfquery for Deno with no external dependencies. It can also be used as a library or from the command line.
https://github.com/bzflagcommunity/bzfquery.js
bzflag bzflag-server cli deno javascript library networking no-dependencies self-contained tool typescript
Last synced: 1 day ago
JSON representation
JavaScript/TypeScript version of bzfquery for Deno with no external dependencies. It can also be used as a library or from the command line.
- Host: GitHub
- URL: https://github.com/bzflagcommunity/bzfquery.js
- Owner: BZFlagCommunity
- License: mit
- Created: 2020-02-17T22:39:59.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-13T22:33:49.000Z (almost 4 years ago)
- Last Synced: 2024-11-17T14:13:00.321Z (2 days ago)
- Topics: bzflag, bzflag-server, cli, deno, javascript, library, networking, no-dependencies, self-contained, tool, typescript
- Language: TypeScript
- Homepage: https://deno.land/x/bzfquery
- Size: 102 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bzfquery.js
[](https://deno.land/x/bzfquery)
[](LICENSE)
[](https://github.com/denoland/deno/releases/tag/v1.5.4)
JavaScript (TypeScript) version of bzfquery with no external dependencies. Requires [Deno](https://deno.land) to run. It can also be used as a library or from the command line.
Usage: `deno run --allow-net bzfquery.ts host[:port]`
Use in your code
```typescript
import bzfquery from "https://deno.land/x/bzfquery/bzfquery.ts";
console.log(JSON.stringify(await bzfquery("bzflag.thenoah.dev", 5154), null, 2));
```
Use without downloading project:
```sh
deno install --allow-net https://deno.land/x/bzfquery/bzfquery.ts
bzfquery host[:port]
```
Stable documentation can be found [here](https://doc.deno.land/https/deno.land/x/bzfquery/bzfquery.ts), and latest unstable docs [here](https://doc.deno.land/https/raw.githubusercontent.com/BZFlagCommunity/bzfquery.js/master/bzfquery.ts).
# Types
| Name | Type |
| ---------- | ---- |
| `GameStyle` | `"FFA"` or `"CTF"` or `"OFFA"` or `"Rabbit"` |
| `TeamName` | `"Rogue"` or `"Red"` or `"Green"` or `"Blue"` or `"Purple"` or `"Observer"` or `"Rabbit"` or `"Hunter"` |
## IBZFQuery
| Property | Type | Extra Info |
| ---------------- | ---- | ---------- |
| `style` | `GameStyle` |
| `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` |