Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vikpe/qw-hub-api
API serving QuakeWorld info.
https://github.com/vikpe/qw-hub-api
api quake quakeworld servers
Last synced: 27 days ago
JSON representation
API serving QuakeWorld info.
- Host: GitHub
- URL: https://github.com/vikpe/qw-hub-api
- Owner: vikpe
- License: mit
- Created: 2022-05-27T14:02:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-25T10:20:16.000Z (10 months ago)
- Last Synced: 2024-04-15T01:43:54.669Z (7 months ago)
- Topics: api, quake, quakeworld, servers
- Language: HTML
- Homepage: https://hub.quakeworld.nu
- Size: 373 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# QW Hub API [](https://github.com/vikpe/qw-hub-api/actions/workflows/test.yml) [](https://codecov.io/gh/vikpe/qw-hub-api) [](https://goreportcard.com/report/github.com/vikpe/qw-hub-api)
> Web API serving QuakeWorld info
## Usage
1) Rename/edit `config.sample.json` to `config.json`.
2) Rename/edit `.env.example` to `.env`.
3) Build
4) `./qw-hub-api`
## Config
See [config.sample.json](./config.sample.json)
**Example**
```json
{
"port": 3000,
"servers": {
"active_server_interval": 4,
"server_interval": 30,
"master_interval": 14400,
"master_servers": [
"master.quakeworld.nu:27000",
"master.quakeservers.net:27000",
"qwmaster.fodquake.net:27000"
]
},
"qtv_demo_sources": [
{
"address": "de.quake.world:28000",
"demo_date_format": "ymd",
"timezone": "UTC"
},
{
"address": "troopers.fi:28000",
"demo_date_format": "ymd",
"timezone": "Europe/Helsinki"
},
{
"address": "quake.se:28000",
"demo_date_format": "Ymd",
"timezone": "Europe/Stockholm"
}
],
"streamers": {
"annihilazor": "anni",
"quakeworld": "[streambot]",
"suddendeathTV": "suddendeathTV",
"vikpe": "XantoM"
}
}
```
## API endpoints
| URL | description |
|------------------------------------|---------------------------------------------------------------------------|
| `/v2/servers` | All servers |
| `/v2/servers/mvdsv` | MVDSV servers |
| `/v2/servers/qwfwd` | QWFWD servers (proxies) |
| `/v2/servers/qtv` | QTV servers |
| | |
| `/v2/servers/
` | Server details |
| `/v2/servers//lastscores` | Server lastscores |
| `/v2/servers//laststats` | Server laststats |
| | |
| `/v2/masters/` | List of servers on master |
| | |
| `/v2/demos` | Demos from popular servers |
| `/v2/streams` | Twitch streams casting Quake |
| `/v2/events` | Events (from [Wiki](https://wiki.quakeworld.nu/)) |
| `/v2/news` | News (from [QuakeWorld.nu](https://www.quakeworld.nu/)) |
| `/v2/forum_posts` | Forum posts (from [QuakeWorld.nu Forum](https://www.quakeworld.nu/forum)) |
## Endpoint details
### MVDSV servers
> `/v2/servers/mvdsv`
| Param | Type | Example | Description |
|----------------|--------------------------|---------------------|-----------------------------------------------|
| **empty** | `include\|exclude\|only` | `empty=include` | Include empty servers (default `exclude`) |
| **hostname** | `string` | `hostname=quake.se` | Servers matching hostname `quake.se` |
| **has_player** | `string` | `has_player=xantom` | Servers where `xantom` is connected as player |
| **has_client** | `string` | `has_client=xantom` | Servers where `xantom` is connected |
| **limit** | `int` | `limit=10` | Limit to `10` servers |
### Demos
> `/v2/demos`
| Param | Type | Default | Example | Description |
|-----------------|---------------|---------|------------------------|---------------------------------------------------------|
| **q** | `string` | | `q=2on2 xantom dm3` | Demos where filename matches `2on2`, `xantom` and `dm3` |
| **mode** | `string` | | `mode=2on2` | Demos with mode `2on2` |
| **qtv_address** | `string` | | `qtv_address=quake.se` | Demos from `quake.se` qtv server |
| **limit** | `int [1-500]` | `100` | `limit=10` | Limit to `10` demos |
## Build
```shell
go build
```
## Development
Run locally.
```shell
./qw-hub-api
```
Now you try an endpoint, e.g. http://localhost:3000/v2/servers
## Credits
* eb
* Tuna
* XantoM
## Related projects
* [hub.quakeworld.nu](https://github.com/quakeworldnu/hub.quakeworld.nu)
* [streambot](https://github.com/vikpe/qw-streambot)
* [masterstat](https://github.com/vikpe/masterstat)
* [masterstat-cli](https://github.com/vikpe/masterstat-cli)
* [serverstat](https://github.com/vikpe/serverstat)
* [serverstat-cli](https://github.com/vikpe/serverstat-cli)