ConVars

Table of Contents

1. Config Files
   1. Listen Servers vs Dedicated Servers
   2. Editing Config Files
2. Custom Roles for TTT ConVars
   1. Shared Role ConVars
   2. Grouped Role ConVars
   3. Shop ConVars
   4. Miscellaneous ConVars

Config Files

As ConVars reset every time the server restarts or the map changes, it is important to create a config file that will automatically update ConVars to the desired value any time this happens.

Listen Servers vs Dedicated Servers

There are two types of Garry's Mod servers and they each need to be configured through different files. The process is otherwise identical but make sure you know which type of server you are running and have the correct file path before continuing.

If you are starting a multiplayer game from within the Garry's Mod client then you are running a listen server. The config file for listen servers is located within your Garry's Mod game files. In Steam, right click on Garry's Mod and select 'Manage', then 'Browse local files'. An explorer window should open to the folder containing your Garry's Mod game files. Open 'garrysmod', then 'cfg'. Inside this folder is a file named 'listenserver.cfg' which is the config file you should use for the rest of the tutorial.

If you are running your server separately from your Garry's Mod client, either through another process or a server hosting platform, you are running a dedicated server. The config file for dedicated servers is located inside the server folders. Open the folder containing your server and open 'garrysmod', then 'cfg'. Inside this folder is a file named 'server.cfg' which is the config file you should use for the rest of the tutorial.

Editing Config Files

Once you have located your config file, open it using a plain text editor such as Notepad. You can add ConVars to this file such that each line contains a single ConVar followed by one or more spaces and then the value you want to set that ConVar to. Comments can be added to the file by typing '//'. Anything after those slashes on the same line will be ignored when the file is loaded by the server. This allows you to write notes and reminders to help organise your config file. Blank lines will also be ignored by the server allowing you to organise ConVars into groups.

ConVars can come in four different types. Depending on the type you may need to format the ConVar value in a specific way:

• Integers require whole number values. Any decimal values will be rounded down and anything that isn't a number will be treated as if it were 0. (e.g. ttt_example_integer_convar 15 will set the value of the ConVar ttt_example_integer_convar to 15.)
• Floats are numbers that can be decimals or whole numbers. Anything that isn't a number will be treated as if it were 0. (e.g. ttt_example_float_convar 0.33 will set the value of the ConVar ttt_example_float_convar to 0.33.)
• Booleans are true or false values. For true use a value of 1 and for false use a value of 0. (e.g. ttt_example_boolean_convar 0 will set the value of the ConVar ttt_example_boolean_convar to false.)
• Strings are text. When setting the value of a string ConVar, you need to surround the text you want to provide as the value with quotation marks. (e.g. ttt_example_string_convar "test" will set the value of the ConVar ttt_example_string_convar to "test".)

Below is an example of what a functional config file could look like:

ttt_example_convar 1 // This text will be ignored because it comes after two slashes
ttt_another_example 0.5 // This line will set the value of the ConVar 'ttt_another_example' to 0.5
ttt_yet_another_example           10 // You can have as many spaces as you want between the ConVar and its value
// Comments can take up full lines and lines can even be left blank

// ConVars can use whole numbers (integers), decimals (floats), true/false (booleans), or text (strings) as their values
ttt_boolean_convar 0 // If a ConVar requires true or false (otherwise known as a 'boolean') as its value, use 0 for false and 1 for true
ttt_another_boolean 1 // This line would set the value of the ConVar 'ttt_another_boolean' to true

ttt_string_convar "hello" // If a ConVar requires text (otherwise known as a 'string') as its value, put the text inside quotation marks
ttt_another_string "custom roles for ttt" // This line would set the value of the ConVar 'ttt_another_string' to "custom roles for ttt"

A full list of Custom Roles for TTT ConVars and their default values in a config file ready format can be found on the Custom Roles for TTT GitHub repository.

Custom Roles for TTT ConVars

Custom Roles for TTT has over 800 ConVars that can be used to customise your server. Most of these ConVars are unique to each role and won't be listed here, but you can find them in the expandable sections for each role on their respective team's page.

Shared Role ConVars

Some ConVars are automatically generated for each role and have been grouped here to save space. For each of these ConVars replace the '*' with the name of the role you want to configure in lower case and without spaces.

Grouped Role ConVars

Some roles can only spawn in groups and do not use the same role spawning system as other roles. In these cases the ttt_*_enabled, the ttt_*_spawn_weight, and the ttt_*_min_players are not used to configure each role individually and the following ConVars are used instead. For each of these ConVars replace the '*' with the name of the group you want to configure in lower case and without spaces. (e.g. replace '*' with 'twins' to configure the Twins group containing the Evil Twin and the Good Twin.)

The following roles are grouped:

• Twins: Evil Twin, Good Twin.

NOTE: Health and name ConVars can still be used to configure each role individually, even if those roles are part of a group.

Shop ConVars

Some ConVars are used to configure who has access to a shop, what items are available and how many credits they have. For each of these ConVars replace the '*' with the name of the role you want to configure in lower case and without spaces. These ConVars only apply to roles that are configured to have access to a shop.

Miscellaneous ConVars