Skip to content

Custom-Roles-for-TTT/TTT-Custom-Roles

Repository files navigation

Custom Roles for TTT

Important Notes

  1. All custom roles are disabled by default. Please read the ConVar list to find out how to turn them on.
  2. Traitor voice chat has been rebound to allow sprint to be shift by default. You will need to bind a new key to "Suit Zoom" to use traitor voice chat.
  3. The radio menu (quick chat) has been rebound to "n" by default but that can be changed in the F1 settings menu.

Roles

List

See the links below for the list of available roles per team in each available version:

Renaming

If you would like to rename one of the existing roles, see below for how to do it for each available version:

Creating Custom Roles

If you would like to create your own role to integrate with Custom Roles for TTT, see here.

Creating Custom Weapons

If you would like to create your own shop weapons, see here.

Configuration

This addon has many ConVars available so it can be customized to how you want your server to run. All custom roles are disabled by default.
A full list of ConVars can be found here (for the release version) or here (for the beta and development versions).

If you would like to test the available configurations, we recommend using ULX/ULib and our ULX plugin for Custom Roles for TTT. See below for links to the various versions:

NOTE: Changing settings via the ULX module will NOT save them when the map changes or server restarts. You can use the ULX module to test settings changes and identify which ones to put in the appropriate configuration file (server.cfg for dedicated servers or listenserver.cfg for peer-to-peer, listen, and local servers)

Special Thanks:

Conflicts

  • Any other addon that adds roles such as Town of Terror, TTT2, or the outdated versions of Custom Roles for TTT. There is no reason to use more than one role addon so remove all the ones you don't want.
  • Better Equipment Menu - This has its functionality built in
  • TTT Damage Logs - Use this version instead
  • TTT DeadRinger - Overrides several scripts that are core to TTT that this also overrides (notably, the scoreboard and client initialization). As a workaround, you can use this version instead.
  • TTT: Advanced Body Search - Overwrites the body search dialog in ways that don't keep compatibility with the changes we also make to the same dialog.
  • TTT SimpleHUD - Overrides several scripts that are core to TTT that this also overrides (notably, the weapon switch HUD). Claims compatibility with Custom Roles, but only supports the outdated version.

FAQs

How do I use Custom Roles for TTT?
To use CR for TTT, subscribe to the addon in the Steam workshop and refer to the Configuration section above for how to change settings (including enabling the new roles).

How do I get this on my server?
The easiest way to get CR for TTT onto a dedicated server is to create use an addon collection. See this guide on how to create and use a collection for your dedicated server.

If you're using a peer-to-peer, listen, or local server then we still recommend using an addon collection, but any addon you subscribe to and have enabled will automatically be loaded when you start the server. Having an addon collection makes it easier for your players to get the same addons without having to download them from you each time they want to play.

How do I get the changed convars to save? The settings I change reset when I restart the server -- how do I save them?
The convars added in Custom Roles for TTT follow the precedent of many of the convars from the base TTT: They do not archive (save) automatically. To save the convar changes, add the changed values to your server.cfg (for dedicated servers) or listenserver.cfg (for peer-to-peer, listen, and local servers).

Do I need the other versions of Custom Roles or Town of Terror as well?
No, you should only use one addon that adds roles. That means only this version of Custom Roles, no Town of Terror, no TTT2, etc.

This lags everyone when I play on my peer-to-peer (aka listen, aka local) server/game
Everyone needs to subscribe to this workshop item, not just the host. We're not sure why that is, but having everyone subscribed to the addon seems to help.

We would suggest making a workshop collection of the addons you have and then having your friends subscribe to them all.

How do I enable the new roles? How do I change X, Y, or Z?
Check out the Configuration section above and add the setting value you want in your server.cfg (for dedicated servers) or listenserver.cfg (for peer-to-peer, listen, and local servers). If you don't see a setting for what you want to change, leave a comment on the workshop or join the Discord server (see below) and we'll either help you find it or try to add one.

How do I make a Detective spawn every round?
Set the following settings:

ttt_detective_min_players 1
ttt_detective_pct 1

Also if you want ONLY one detective, set:
ttt_detective_max 1

My shop is not working for anyone but the Detective and Traitor/I am getting errors when I try to open the shop/My shop is not loading correctly, it's just a blank grey window
This is probably due to another mod conflicting with this one. Check for things like the 'Better Equipment Menu' mod (which is integrated into this one). If removing that doesn't fix the problem, join the Discord server (see below) and we'll try to help you identify any other conflicts.

Nothing happens when I search a body as a detective
This is most likely caused by a conflict with a mod like 'TTT: Advanced Body Search'. If removing that doesn't fix the problem, join the Discord server (see below) and we'll try to help you identify any other conflicts.

The addon doesn't load when I place it in the addons folder on my server
If you are using a Linux machine to host your server you may need to lowercase the folder name for it to be loaded properly. For example, [INSTALL_DIR]/garrysmod/addons/TTT-Custom-Roles would become [INSTALL_DIR]/garrysmod/ttt-custom-roles. See GMod Linux Dedicated Server Hosting for details.

Official Links:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages