You are viewing a potentially older version of this package. View all versions.
PROTOCOL-PROTOCOL_Server-0.4.3 icon

PROTOCOL Server

PROTOCOL for Northstar dedicated servers: !link verification, server verified match results and quest drops.

Date uploaded a day ago
Version 0.4.3
Download link PROTOCOL-PROTOCOL_Server-0.4.3.zip
Downloads 9
Dependency string PROTOCOL-PROTOCOL_Server-0.4.3

README

PROTOCOL_Server 0.4.3

PROTOCOL for Northstar dedicated servers: !link verification, server verified match results and quest drops.

The PROTOCOL plugins that run on a Northstar dedicated server, not in a pilot's game.

Inside

Mod Plugin Built from What it does
Protocol.Beacon BEACON 0.3.0 PROTOCOL BEACON for Northstar dedicated servers: !link verification, match results and quest drops.

Every mod in this package carries version 0.4.3.

Talks to https://api.protocol.tf/api/v1. The address is a setting in Mod Settings and can be changed there.

Install

Unpack into <server>/R2Northstar/packages/PROTOCOL-PROTOCOL_Server-0.4.3/ (Northstar.CustomServers must be enabled, it is by default) and set protocol_server_key to the key from the PROTOCOL admin area, for example in autoexec_ns_server.cfg. The key is never printed.


BEACON (Protocol.Beacon)

Server side, for a Northstar dedicated server. A player types !link 123456 in chat with a code from the PROTOCOL website; the server sends that player's uid and name, as it saw them authenticate, to POST /server/link and answers privately with the callsign or the problem. The message itself is blocked, so nobody else sees the code. At postmatch every player's uid, name, team, kills, deaths and score goes to POST /server/matches. Since 0.3.0 the result also carries durationSeconds, the time since the match first went live: a casual room decides that a match is not rated only when it held the server from before that start, so a room opened in the last minutes of a public match cannot take the rating away.

Also since 0.3.0 the server is for PROTOCOL pilots (protocol_beacon_members_only, 1 by default). On connect BEACON asks GET /server/admit about the uid the server saw authenticate. A player who is not a verified PROTOCOL pilot (an UPLINK claim is not enough) reads in a private chat line how to get an account or how to verify, and has 90 seconds for !link; after that the server disconnects them with a short reason. The words come from the API. If PROTOCOL does not answer, the player stays: a server out of touch with PROTOCOL keeps playing.

Since 0.2.0 BEACON also opens quest drops. A few seconds into a map it loads the map's drops (GET /server/drops, positions only, never a code). Once a second it measures every player with an account id against them, on the server. When a player stands inside a drop's radius it asks PROTOCOL to release a code for that uid (POST /server/drops/release). PROTOCOL makes one only for a verified pilot, once per drop and pilot, and BEACON hands it to that player alone: a private chat line, which stays readable for the rest of the match, and a short message in the middle of their screen. The code never goes to the server log. An unlinked player is told once to !link first.

!where in chat answers privately with the map and your position in whole units, for placing drops on the admin page.

Install

On the server: copy mods/Protocol.Beacon into the server's R2Northstar\mods\ (Northstar.CustomServers must be enabled, it is by default). Set the key, for example in autoexec_ns_server.cfg:

protocol_server_key "<key from pnpm server:add>"
protocol_beacon_api "https://your-protocol-host/api/v1"

Add -allowlocalhttp to the server's command line if the API is on the same machine or network.

ConVars

ConVar Default What
protocol_beacon_enabled 1 Links and results
protocol_beacon_api http://localhost:3041/api/v1 API base address
protocol_beacon_drops 1 Quest drops on this server, from the next map
protocol_server_key empty Sent only in the x-protocol-server-key header, never printed

Limits

  • Score is the mode's first scoreboard column, the way the postgame summary reads it.
  • Bots and players without a numeric uid are left out. At most 32 players.
  • winnerTeam is null for a draw and for free for all, where team numbers mean nothing to the API; teams above 8 are sent as 0.
  • One report per map, at the moment postmatch starts.
  • Quest drops stay closed with an empty key and with ns_auth_allow_insecure 1, because a uid proves nothing then. At most 50 drops per map. Dead players and bots are not measured.
  • A player is asked about once per drop and map. After no answer, a step outside the radius or an unlinked account BEACON asks again 30 s later.