luop90 / arena-respawn Goto Github PK

Arena: Respawn is a custom gamemode for Team Fortress 2. Like Arena mode, the primary objective is to kill the other team before they kill yours. Unlike Arena mode, players can be respawned mid-round if a teammate captures the central control point.

This simple rule change has proven to be an interesting addition to the Arena gamemode, as mentioned in the Official Team Fortress 2 blog. If you'd like to try it out before installing, hop into a server near you and give it a spin.

1. A dedicated server running Team Fortress 2. (Installation guide)
2. MetaMod/SourceMod. (Installation guide)

Once SourceMod is installed, you're good to go. SourceMod is the only MetaMod requirement to run Arena: Respawn.

This plugin will function on all official Arena maps and most community-made Arena maps. It contains the vanilla gamemode itself and nothing extra, although you can add some extra stuff if you want later. Download the plugin here (wgettable link) and drop it in your addons/sourcemod/plugins folder.

That's it! Arena: Respawn will automatically replace Arena mode. If you're interested in extra configuration or other cool stuff, read on.

Arena: Respawn comes with a bunch of configuration variables that you can set in your server's server.cfg. They're automatically set to sensible defaults, so you don't have to set these unless you want something other than the gamemode's default behavior.

A simple variable that returns 1 if the plugin has been loaded, regardless of whether or not it is active. Meant for server scripting.

Default value: 1

Turns Arena: Respawn on or off. It's recommended to unload the plugin manually instead of using this variable.

Default value: 1.0
Recommended tournament value: 1.25

Approximate amount of time (in seconds) that it takes for a point to be captured. This value is multiplied by the number of control points present on a map squared.

Default value: 3.0
Recommended tournament value: 1.0

How long to flash Uber on a newly respawned player.

Default value: 14
Recommended tournament value: -1

Number of active players required to enable First Blood (5 second critboost on the first kill in the round). Set to 0 to always enable First Blood or -1 to always disable it.

Default value: 8.0
Recommended tournament value: -1

For the Last Man Standing, a death on the opposing team will result in a critboost for this many seconds. Set to 8 seconds by default to match a Kritz charge.

Default value: 0
Recommended tournament value: 0

If set to 1, replaces the Last Man Standing critboost with a minicrit boost.

The console command ars_tournament_start will put the server into Tournament Mode. Activating Tournament Mode will put players into a SOAPDM-like deathmatch mode from which they can choose their classes, set their team names, ban classes, and ready up to begin the tournament.

To set Arena: Respawn back to public play mode, use the command ars_tournament_stop. To reset a tournament, use ars_tournament_start again. Do not use mp_tournament_restart; this will fail to put the server back into Pre-Tournament mode.

• !ready - Sets the team state to Ready.
• !unready - Sets the team state to Not Ready.
• !class <class> - Switches the player to the given class. Arena mode blocks class changes, so it is difficult to change class in the pre-round deathmatch mode.
• !banclass <class> - Bans the given class from play for the duration of the map. This is a requirement for Arena: Respawn tournaments.
• !teamname <name> - Sets the team's name to <name>. Team names can be up to 15 characters long.

• cfg/sourcemod/respawn.pretournament.cfg- Deathmatch mode settings. Deathmatch should have no map end conditions.
• cfg/sourcemod/respawn.tournament.cfg - Tournament settings. Set win conditions in this configuration file only.
• cfg/sourcemod/respawn.public.cfg - Public server settings. Executed upon exiting tournament mode with ars_tournament_stop.

Tournament Mode is essentially one giant hack to restore tournament-like functionality into Arena mode. If and when TF2 officially supports tournament setup time in Arena mode, Arena: Respawn will happily switch over to the in-game tournament logic.

Tournament Mode functions well overall, but occasionally a round win will trigger during pre-round Deathmatch time. These win screens are harmless and the humiliation period is cut short to get both teams back into Deathmatch mode as quickly as possible. (Note: It is possible to overcome this limitation with SourceMod extensions, but this would add another dependency to solve what is effectively a cosmetic issue.)

Arena: Respawn will automatically stop functioning if a non-Arena map is loaded or if tf_gamemode_arena is not set to 1.

Not all Arena maps are entirely plug-and-play. Some custom maps have made design decisions based on the rules of standard Arena that just don't work in Arena: Respawn, such as the train arriving late in Ferrous, the spawn doors shutting in Hardhat, or the point exploding and killing everyone in Blackwood Valley.

Fortunately, the excellent Stripper: Source tool allows you to apply on-the-fly custom map fixes as the map loads. Install Stripper: Source and copy the appropriate files into your addons/stripper/maps directory.

Note: I have deliberately avoided working these special, per-map cases into the plugin (and will not accept merge requests that do so) for the following reasons:

• While all per-map problems can be eventually be solved by SourceMod, this often involves tearing out elements of the map to do so. The Stripper: Source configuration files leave the map alone and modify its functionality instead of playing butcher to the hard work of a mapper.
• Stripper syntax is closely related to entity keyvalue data, which most mappers are familiar with. This allows a mapper to write their own Arena: Respawn modifications without having to learn an extra tool in the process.
• Large amounts of special case code are not just bad practice, but downright nightmarish to maintain.

Arena: Respawn is also designed to function on King of the Hill maps, but additional Stripper configuration is required to do so.

If you would like to run a King of the Hill map, copy or symlink koth.cfg to a filename corresponding with the map you wish to use. For example, on a *nix system, ln -s koth.cfg koth_king.cfg would create a symlink at koth_king.cfg, loading the special KOTH Stripper rules the next time koth_king is played.

Aside from this slightly manual configuration, everything else about the KOTH conversion is handled inside the plugin, including a full conversion of each spawn area to an Arena-style spawn.

You'll need smlib and the source files provided under addons/sourcemod/scripting. After installing SourceMod, change directory to addons/sourcemod/scripting and run compile.sh arena_respawn.sp or compile.exe arena_respawn.sp. This produces arena_respawn.smx in the addons/sourcemod/scripting/compiled directory.

If you create a modified version of Arena: Respawn to run on a public server, you must release the source of your modified code under the terms of the AGPL. This way, Arena: Respawn remains an open gamemode that all server owners can benefit from, instead of a select few keeping potentially new and interesting changes to themselves.

Arena: Respawn has always been intended to be a plugin open for the entire TF2 community to experiment with, so play nice and keep it that way.