TF2 Custom Attribute Starter Pack

A collection of (mostly) production-ready custom attributes written for the Custom Attribute framework.

I'll move the other ones eventually…

About

This repository contains attributes I've written. I don't run a Custom Weapon server, so most of the plugins are made through work-for-hire. If you'd like a custom attribute created, feel free to contact me on AlliedModders — I'm open to inquiries.

The wiki documents the available custom attributes.

Special thanks to Karma Charger for allowing the release of the stuff I've written for him; a lot of the plugins available here were created for his videos.

If you like this project, you may also want to check out its sibling project:

• TF2 Attribute Extended Support, a zero-configuration plugin that improves interactions in the game's native attributes.

Microframeworks

Some attributes are libraries that can be hooked onto by other plugin developers to implement their own behaviors. These include:

• custom lunchbox effect: Replaces lunchbox effects — Sandvich, Bonk!, etc.
• custom buff type: Replaces rage effects — currently only tested on Soldier's banners and Sniper's Heatmaker, but should work on other weapons that use the rage system

The API for those frameworks are provided in scripting/include/ and examples are available in scripting/{buff_overrides,lunchbox_effects}.

Installation

These installation steps assume that you're a server operator and are familiar with how SourceMod works. I can't provide individualized support on configuration; if you're running into issues, please look at the Troubleshooting page first.

1. Install the required runtime dependencies.
2. Download the latest package.zip and unpack. Do not click the green "Code" button with the download-like icon. If you intend to modify / build from source, refer to the Building section below.
   • Github now builds the entire package on every commit by default, so the latest release should be up-to-date.
3. Copy the resulting gamedata/, and plugins/ folders into your TF2 server's addons/sourcemod/ folder.
4. Apply custom attributes to your weapons.

The plugins of any attributes that aren't in use can be safely removed from the server; the project is designed to let you choose what attributes are running (though it does make development easier at the same time).

Custom Weapon Configs

The included CW3 configuration files are provided as-is for attribute demonstration purposes and not intended to showcase completely balanced weapons.

Building

This project can be built in a consistent manner with Ninja, git, and Python 3.

1. Clone the repository and its submodules: git clone --recurse-submodules ...
   • If you have pulled updates for the repository, make sure you've also updated the submodules: git submodule update --recursive --remote --checkout.
2. Execute python3 configure.py --spcomp-dir ${PATH} within the repo, where ${PATH} is the path to the directory containing spcomp. Builds against 1.10.
3. Run ninja. Output will be available under build/.

(If you'd like to use a similar build system for your project, the template project is available here.)

Dependencies

This project uses a bunch of external tooling. Not all plugins use every dependency. To run the plugins from this project, you will need the compiled releases of the following:

• TF2 Custom Attributes: the core plugin, keeps track of equipment and their associated key / value "attribute" pairs
• TF2Attributes: interoperation with game attributes
  • This previously required @nosoop's fork of the project, but all of the functionality has been merged upstream.
• DHooks with detour support: engine-level hooks
  • The current stable version of SourceMod (1.11 or newer) now comes with this preinstalled. You only need to download this separately if you are using 1.10.
• Custom Status HUD: unified HUD library for drawing text elements on-screen
• TF2 Max Speed Detour: allows plugins to transform player maximum speed before application
• TF2 OnTakeDamage hooks: hooks into damage functions, specifically adding support for manipulating (mini-)crits
• Source Scramble: memory-level tweaking, for when DHooks isn't enough
• TF2 Econ Data: identifies loadout slots for weapons, among other things
• TF2Utils: wrappers around some game functions / memory accessors (version 0.14.0+)
• TF2 DamageInfo Tools: additional wrapper solely for radius damage, because bomb entities just don't work exactly right for custom explosions. Uses Source Scramble's MemoryBlock handles for struct allocation.

The following is only used when building from source; if you're just running the plugins, you do not need these:

• stocksoup: personal library for reusable SourceMod functions
• smlib: massive community-created function stock library

Includes are bundled in the third_party/ subdirectory to ensure builds are consistent.

Contributing

As stated before, I don't run a Custom Weapon server. All plugins here are provided on an as-is basis and has the potential of breaking whenever TF2 gets an update.

• Issues: You may post bug reports or other issues related to plugins currently in the project. I cannot guarantee that I will address them in a timely manner, or even at all, but opening a report makes an issue known to me and other potential and current users of the plugin.
• Pull Requests: You are welcome to create pull requests that make backwards-compatible changes to plugins currently in the project, or to fix gamedata. Again, I can't promise I'll get to them, but it's useful for end users to discover. Please test your changes; if they are not ready for merging, mark them as drafts.

I can't accept ideas nor implementations for new plugins here.

License

This project uses the MIT license. Do note that once compiled, SourceMod plugins are still bound to GPLv3, but you're welcome to use the code as reference in other projects under the more permissive license.

The following is a non-exhaustive list of what you're allowed / required to do (that said, this is not legal advice):

• You can modify / use any of the code provided under the MIT license. You may use the code as reference documentation for things like MetaMod:Source bindings under that license.
• If you provide a compiled SourceMod plugin to another person, you MUST include the source code with your modifications per GPLv3+. (This applies to all SourceMod code / plugins in general.)
• If you run a compiled SourceMod plugin on a server you own, modified or not, you are under no further obligation to provide any source code to any end-users (that is, any players on the server).
  • Attribution is nice, but not required if you're simply running the code. I couldn't care less, really. If you do feel like providing a URL for attribution of any custom attributes available here that you are using, linking to this repository is preferred. If you need a name to credit, "nosoop" is acceptable. (I do have a number of other aliases.)

The software is provided "as is", and there is no real guarantee of support. While I will make an effort to maintain the plugins in response to game updates out of goodwill, it is at my discretion — I can't afford to do so in perpetuity.