TeamDUKE v0.92 - Jan 12 2025
============================

This is an adaptation for NetDuke32 of an early multiplayer mod
from around the year 2001, TeamDUKE.

For some background and history, as well as detailed descriptions
of TeamDUKE's game modes, see about.txt.

What is needed for playing
--------------------------

A copy of Duke Nukem 3D: Atomic Edition v1.5 (at least its duke3d.grp file) and
a compatible version of NetDuke32 are both required.

Version 1.2.1 of NetDuke32 is known to support this mod, but a later version
may be required for announcement sound fixes.

The duke3d.grp file distributed with Duke Nukem 3D: 20th Anniversary World Tour
(November 2016 version) can also be used.

In certain situations, NetDuke32 might autodetect the duke3d.grp file
and let you use it. Known examples are having the game installed
via Steam or a Zoom Platform installer.

Another file that may optionally be used is duke.rts,
for recorded voice taunts.

How to launch
-------------

Start NetDuke32 as usual, while also telling it to load the mod's PK3 file.
An external launcher program might assist with this task,
as well as starting a multiplayer game.

How to setup a game
-------------------

Select map and game mode from the in-game menus. Generally speaking,
you should select a proper game mode, like CTF or Flag-Tag.
The "Use Config Rooms" modes might be removed in a future release,
but currently have at least one advantage. If used, certain maps
may let player 1 use a switch toggling explosive ammo boxes on/off.

You might want to toggle friendly fire on/off in team games, along with
respawning collectibles and other toggles accessible from NetDuke32.

If you select an incompatible combination of game mode and map,
you'll more-or-less find yourself in a matching "Use Config Rooms" mode:
"Use Config Rooms (Teams)" if an incompatible team mode is selected,
and "Use Config Rooms (FFA)" otherwise.

Note that under "Use Config Rooms", player 1 might find a switch saying
"Allow Mid-Game Team Swap". This is a legacy option that should generally
not have an impact for team games in NetDuke32, because NetDuke32 (v1.2.1)
lets each player select the team from the player settings.
This legacy option currently toggles team swaps via the "holster weapon" button
only while playing team games under the mode "Use Config Rooms (FFA)".
It does not support toggling friendly fire off per team, and is a leftover from
the days of TeamDUKE being an EDuke 2.0 mod, before Duke3D was open-sourced.

Pre-defined team chat macros
----------------------------

Introduced in v0.91, TeamDUKE supports a small pre-defined set of team
chat macros. Note that this feature is incompatible with the aforementioned
legacy toggle "Allow Mid-Game Team Swap" under "Use Config Rooms (FFA)".

In order to make use of the macros, hold the "holster weapon" key/button
and concurrently press on any of the 10 keys/buttons used for selecting
a specific weapon. By default, the "holster weapon" key is "Scroll Lock"
and the aforementioned weapon selection keys are 0-9.

Behavioral differences from the original stock game to watch out for
--------------------------------------------------------------------

1. Using the expander underwater will kill you, and might
also take care of other players around you!

2. "Ammo for Expander" pickup gives only 10 shots instead of 20.

3. The expander's crystal/housing, sparks and ammo pickups
are blue for the blue team.

4. The expander emits a trail upon use.
Note that due to engine limitations, the trail might not render
in part within certain areas having sloped floors or ceilings.

5. Night vision goggles were modified into Infra-Red goggles.

6. The tripbombs' laser beams are invisible to Duke's eyes,
albeit IR goggles should let him see them.

7. Under specific conditions, certain maps may let
player 1 toggle on explosive ammo boxes!

One additional note
-------------------

Maps that cover team modes like CTF aren't necessarily symmetric in terms of
layout. Even if they're quite close to it, there might still be differences in
placement of collectibles and other aspects of map layout. Yet, it doesn't mean
you can't give them a try, with or without swapping teams between sessions.
