Tunnelcast for Unreal Tournament 2004
=====================================

Tunnelcast relays your server's chat, joins and match events to Discord and to the
Tunnelcast portal.

Installing: follow the step-by-step guide at https://www.tunnelcast.app/guides/installation


What's in this package
----------------------

  Tunnelcast.u, Tunnelcast.ucl   The Tunnelcast server mod
  JsonLib.u, EventBus.u          Supporting libraries
  Tunnelcast.ini                 Configuration template (add your server token)

This package contains only Tunnelcast's own code. It does not contain any files from
Unreal Tournament 2004: you need your own legitimately licensed copy of the game.


Relay notice
------------

Tunnelcast tells every player that chat on your server is relayed. About 30 seconds
after they join, only that player sees:

  [Tunnelcast] Chat here is relayed to Discord, networked servers, and the web portal. It is public.

The text is fixed. It can't be changed or turned off. A player your server hasn't told
yet always sees it.

You choose how often a returning player sees it again in the Tunnelcast Portal, on
your server's Relay Settings tab, under Relay Notice: on every map change, or after
1 hour up to 30 days (24 hours by default). A connected server uses the new choice straight away.
Step by step: https://www.tunnelcast.app/guides/relay-notice

A player counts as the same player when both their CD key and their name match, so a
new name or a shared CD key gets the notice again. To remember who has seen it, the mod
keeps a short list in Tunnelcast.ini (SeenPlayers). Each entry is a one-way key made
from the CD key and the name, plus the time the notice was shown. No names or IP
addresses are stored, and entries are removed once that interval has passed.

You are responsible for informing your players that their chat is relayed. The notice
helps, but it doesn't replace that. See the Terms of Service:
https://www.tunnelcast.app/terms


Licences
--------

JsonLib and EventBus are open source under the MIT licence:
  https://github.com/Tunnelcast/jsonlib-ut2004
  https://github.com/Tunnelcast/eventbus-ut2004

Using Tunnelcast is subject to the Terms of Service at https://www.tunnelcast.app/terms


Tunnelcast is not affiliated with or endorsed by Epic Games. Unreal Tournament 2004 is a
trademark of its owner.
