Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.12 KB

README.md

File metadata and controls

35 lines (22 loc) · 1.12 KB

Nox lobby server

Go Reference

This project provides a Nox game lobby which exposes a simple HTTP API for both listing and registering Nox game servers.

XWIS games will also appear in the list returned by the API, so the lobby is backward-compatible. Due to technical limitations, however, games registered via HTTP won't be registered on XWIS.

The main use case for the lobby is to support OpenNox, but the API can also be used for bots that want to notify players about currently active Nox games.

Public lobby

To get a list of games on the public lobby:

curl 'http://nox.nwca.xyz:8088/api/v0/games/list'

A Go client library for HTTP API is also available (see docs).

Running locally

The simplest way to run the lobby server locally is via Docker:

docker run -d --restart always --name nox-lobby -p 8080:80 ghcr.io/noxworld-dev/lobby

To get a list of games via local lobby:

curl 'http://127.0.0.1:8080/api/v0/games/list'