A jailbreak plugin I spent the last few weeks making because I was interested in writing one myself, and existing plugins didn't have the features that I was looking for or function how I'd like them to function.
The currently in-service jailbreak plugins are good, but I feel they are lacking a lot of map integration. As a jailbreak map maker I know some of the types of things that would be nice for a plugin to have that would integrate with the map, sort of features that people want but don't have. Jailbreak Redux was archived in May on github, meaning many of these features people may be wanting will likely not be added to redux. I didn't want to just fork it since this plugin was a learning process for me, so here we are. (The name Jailbreak From Scratch was chosen because it sounds catchy and a friend recommended it, it is not meant to imply this was done without any credit, inspiration, or help).
This plugin is inspired by
Jailbreak Redux by Scag. I played on servers utilizing it for many years, and thus lots of features are very similar because I think it does most things right, and that should be preserved. Not trying to reinvent the gamemode here, so better to not fix what isn't broken. Being my first plugin, I read it frequently to learn how certain things were done, so there is some architectural overlap between the two plugins.
Features- All the regular jailbreak goodies. A warden system, freedays, last request, ammo removal, etc. Everything you need for the vanilla jailbreak experience.
- Better overall map integration. Maps can define information using entities, that previously would be server config only, such as spawns during last request days.
- Map-Specific last requests, which can be defined by map makers using logic relays.
- Built in weapon blocker, with more control over when weapons can be given back
- Built in mic checking. Enabled by default, will priority autobalance and prevent warden for players who don't have microphones (cvar for it if this feature isn't to your liking).
- Built in weapon searcher. Enabled by default, allows guards to search prisoners for ammo
- Plenty of configurable CVars to customize the plugin to your liking. I tried to include as many as I could think of.
- Granular admin command permissioning. There are quite a few commands available to admins, and the permissions required for every single one can be set with cvars.
- Round-based teamban plugin addon. A plugin which is more in line with my philosophy of how jailbreak should be played, in which teambans are issued and handled on a per-round basis instead of a minute by minute basis.
- Gang Plugin addon. Allows players to segregate into gangs and have secret discussions, earn points, and purchase round based buffs.
- VScript Support. Useful for maps that need to integrate with the plugin in some ways, such as maps that manage ammo uniquely in ways not detected by the plugin.
What's missing?
While many of the features work similar to Jailbreak Redux, there are a few that are different or that I chose not to include.
- Custom LR support. I did not add this yet because it's of my opinion that jailbreak does not need to be very LR focused, and from my experience playing the game many custom server LRs go unplayed. If this feature is requested enough it can be added.
- Rebel status. I didn't get around to adding this, because I didn't find it necessary to play the game. Can also be added if frequently requested.
- High quality developer support. Currently only some primitive teamban natives and a few other miscellaneous calls are exposed.
Installation/Configuring/Developer info
I wrote a
wiki on the github page which contains all you need to know about installing configuring, or developing with the plugin.
If you are a developer, before you get your hopes up - there currently is not a lot of integration baked in. The only exposed natives are related to teambans. I could not think of a very good reason why another plugin would need to be able to modify the core information about this plugin, thus no other natives are exposed. They can be added if requested.
For mappers, there is a section on the wiki detailing what to do in your map to integrate with the plugin, including VScript examples.
Requirements
Thanks/Credits
Scag, for TF2 Jailbreak Redux.
FortyTwo, for the VScript plugin.
Github Repo
Plugin Wiki