fuxle/UT2004REST
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
REST API for Unreal Tournament 2004 - A UnrealScript Mutator
1 commit 1 branch 0 tags 36 KiB
  • UnrealScript 100%
Find a file
Exact
Moritz Hofmann 4355e3613d Initial commit
2026-04-20 20:21:14 +02:00
Docs Initial commit 2026-04-20 20:21:14 +02:00
Examples Initial commit 2026-04-20 20:21:14 +02:00
RestAdmin/Classes Initial commit 2026-04-20 20:21:14 +02:00
LICENSE Initial commit 2026-04-20 20:21:14 +02:00
README.md Initial commit 2026-04-20 20:21:14 +02:00

README.md

RestAdmin for UT2004 (Mutator + REST-ish API)

This is a UT2004 mutator that exposes a tiny HTTP + JSON admin API so you can remote-control a dedicated server (kick/ban/restart/switch level/player list/broadcast message + an optional console command endpoint).

It is meant for use cases where the stock WebAdmin/WebAPI isn’t a fit.

What you get

  • A TcpLink listener with one-request-per-connection HTTP handling
  • Token authentication (X-UT-Token header or ?token= query)
  • JSON responses
  • Endpoints that cover the “core” server-admin actions:
    • status, players, say, kick, kickban, restart, switch
    • optional: run server console commands (/v1/console)

Quick start (dev machine)

  1. Copy the RestAdmin/ folder into your UT2004 install folder (next to System/).
  2. Add EditPackages=RestAdmin to System/UT2004.ini.
  3. Compile: System/ucc make
  4. Start your server with the mutator:
    • UT2004.exe DM-Rankin?Game=XGame.xDeathMatch?Mutator=RestAdmin.RestAdminMutator -server
  5. Configure the token/port in System/RestAdmin.ini (sample included).

See:

  • Docs/INSTALL.md for dedicated server instructions and .ucl export notes.
  • Docs/API.md for endpoints and response formats.
  • Docs/SECURITY.md for hard security warnings.

Files / structure

  • RestAdmin/Classes/*.uc : UnrealScript source
  • Docs/*.md : documentation
  • Examples/* : curl examples and helper scripts

License

MIT (see LICENSE).