woofmeow/straywild-discovery-server
1
0
Fork 0
Code Issues Projects Releases Packages Wiki Activity Actions

Rebrand discovery service as straywild

Browse source
This commit is contained in:
Alexander Sellite 2026-08-25 17:14:33 -04:00
parent e20d8e0553
commit de454ff48a
18 changed files with 95 additions and 95 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/API.md
View file

@ -1,7 +1,7 @@
# Discovery API v1
The API stores public room advertisements as short-lived leases and coordinates direct UDP hole
punching. It does not proxy or relay gameplay traffic. NETfishing continues to connect to the
punching. It does not proxy or relay gameplay traffic. straywild continues to connect to the
returned host and UDP port through ENet.
All request and response bodies use `application/json`. Production clients must use HTTPS.
@ -9,8 +9,8 @@ All request and response bodies use `application/json`. Production clients must
## `GET /health`
Returns service status, package version, configured build revision, and the number of active,
unexpired room leases. Deployments should set `NETFISHING_DISCOVERY_BUILD_REVISION` to the exact
Git commit they are running. The package version follows the coordinated NETfishing release tag.
unexpired room leases. Deployments should set `straywild_DISCOVERY_BUILD_REVISION` to the exact
Git commit they are running. The package version follows the coordinated straywild release tag.
## `GET /v1/rooms`
@ -33,7 +33,7 @@ trusting an address supplied by the game client.
"current_players": 0,
"max_players": 8,
"game_version": "0.18.1-alpha",
"protocol_version": 10
"protocol_version": 11
}
```
@ -47,7 +47,7 @@ excluded from public listings until the service observes that endpoint.
The service applies configured global and per-observed-address active-room limits. Exceeding one
returns `429 room_limit`; expired leases stop counting automatically.
The discovery release accepts room advertisements only from the matching NETfishing game release.
The discovery release accepts room advertisements only from the matching straywild game release.
A mismatched `game_version` returns `409 game_version_mismatch` with `required_game_version`; the
room is not created or updated.
@ -94,7 +94,7 @@ that inbox was polled recently. There is no offline delivery.
All four requests include the normal `game_version` and `protocol_version`. Capability values are
64 lowercase hexadecimal characters and must be exchanged by the games during an authenticated,
live NETfishing session.
live straywild session.
## Error shape