ServerMod2

ServerMod2 is a server side plugin system with a bunch of additional configuration options, bug fixes, security patches and some optimisations built in.

The latest release can be found here: Release link

Discord

You can join our Discord here: https://discord.gg/8nvmMTr

ServerMod Installation:

SteamCMD (Recommended)

Windows:

1. Download SteamCMD, and extract it to a new folder. Be aware that it will fill the folder with its own files.

2. Create a text file (.txt) to be used as the install script (uncomment one of the "app_update" lines):

@ShutdownOnFailedCommand 1
@NoPromptForPassword 1
login anonymous
force_install_dir "your/desired/install location/here"
//app_update 786920 validate //uncomment this line if you want the stable branch
//app_update 786920 -beta beta validate //uncomment this line if you want the beta branch
quit

3. Create a batch file or shortcut to run SteamCMD: steamcmd +runscript "path/to/install script.txt"

4. Run the batch file or shortcut. If SteamCMD reports that " @ShutdownOnFailedCommand" is an unknown command, make sure that the text file is not saved with UTF-8 Signature / Unicode BOM (Byte-Order Mark). A batch file likewise won't work if saved that way.

Linux:

1. Install SteamCMD, either by package manager (for instance sudo apt-get install steamcmd), or by downloading it manually by following the instructions of the Linux section here.

2. Create a new file and name it update.sh and put the following text into it:

# !/bin/bash

# The latest version of the game that supports ServerMod, with ServerMod and MultiAdmin pre-installed
# steamcmd +login anonymous +force_install_dir /enter/absolute/path/here +app_update 786920 validate +quit

# The latest version of the base game that works with the ServerMod beta version, with ServerMod Beta pre-installed
# steamcmd +login anonymous +force_install_dir /enter/absolute/path/here +app_update 786920 -beta beta validate +quit

# The latest version of the game, without ServerMod
# steamcmd +login "steam-username" "steam-password" +force_install_dir /enter/absolute/path/here +app_update 700330 -beta linux validate +quit

# The latest beta version of the game, without ServerMod
# steamcmd +login "steam-username" "steam-password" +force_install_dir /enter/absolute/path/here +app_update 700330 -beta beta_linux validate +quit

3. Remove the # infront of the line you want to use. I included the base game downloads too so you can quickly switch to the unmodded game while ServerMod is outdated after a game update. If you installed SteamCMD manually, you have to put the path to it's directory instead of steamcmd at the start of the line.

4. Run the script file using sh update.sh. If there is an error you may have to make it executable by using chmod 777 update.sh or if you are using FileZilla, right click on the script and give it all file permissions.

To install via Steam Library:

1. Open your Library in Steam.
2. In the upper left is a search box. In that box, click the word "GAMES" and change it to "TOOLS".
3. Search for SCP. You should see "SCP: Secret Laboratory ServerMod".
4. If you want the stable branch, just install what you see. If you want the beta branch, right click it, "Properties", "Betas", select the beta in the dropdown, then install it.
5. Remove steam_appid.txt in the install folder. This causes you to show up as playing SCPSL on steam & can prevent you from launching client.
   • Optionally, remove discord-rpc.dll from "SCPSL_Data\Plugins\". This prevents showing up as playing the game on Discord while hosting. This does however spam a lot of errors, so it's not recommended.

To install via Steam URI (on Windows with Steam installed):

1. Launch steam://install/786920 (using "Run", File Explorer address bar, or web browser address bar)
2. This installs the stable branch by default. If you want the beta branch, you'll need to follow the directions using the Steam Library, which can still be done after installing it this way.
3. Remove steam_appid.txt in the install folder. This causes you to show up as playing SCPSL on steam & can prevent you from launching client.
   • Optionally, remove discord-rpc.dll from "SCPSL_Data\Plugins\". This prevents showing up as playing the game on Discord while hosting. This does however spam a lot of errors, so it's not recommended.

If you use any of the above methods, you will have to manually run MultiAdmin, not launch it directly through steam.

To install manually:

1. Download Assembly-CSharp.dll and Smod2.dll from the latest release or from some other release in the releases tab.
2. Navigate to your SCP Secret Lab folder. For example, "C:\Program Files\Steam\steamapps\common\SCP Secret Laboratory\"
   • If you also play the game on this system, create a copy of this directory somewhere else. ServerMod needs its own directory. Installing it in the same directory from which you play the game will prevent the game from working properly.
3. Inside the resulting new directory, navigate to "SCPSL_Data\Managed\"
4. Back up Assembly-CSharp.dll (either by renaming it or moving it somewhere).
5. Copy the downloaded Assembly-CSharp.dll and Smod2.dll into that folder.
6. Remove steam_appid.txt in the install folder. This causes you to show up as playing SCPSL on steam & can prevent you from launching client.

• Optionally, remove discord-rpc.dll from "SCPSL_Data\Plugins\". This prevents showing up as playing the game on Discord while hosting. This does however spam a lot of errors, so it's not recommended.

Server Name Variables

Currently supported variables (place in your servers name):

• $player_count (current number of connected players) EG: "$player_count playing!"
• $port (the port of the current server) EG: "Welcome to SCPServer.com:$port"
• $ip (the ip of the server) EG: "Welcome to SCPServer.com [$ip:$port]"
• $full_player_count (will display player count as $player_count/$max_player_count or FULL if there are $max_player_count players) EG: "Server.com $full_player_count"
• $number (will display the number of the instance, assuming youre using default ports, this works by subtracting 7776 from the port (so $number will = 1 for the first server, #2 for the second)
• $lobby_id (debugging to print the lobby_id)
• $version (version of the game)
• $sm_version (version of ServerMod)
• $max_players (max amount of players in the config)
• $scp_alive - number of alive SCPS.
• $scp_start - number of SCPs at start of the round.
• $scp_counter - prints $scp_alive/$scp_start
• $scp_dead - number of dead scps.
• $scp_zombies - current number of zombies.
• $classd_escape - how many class ds have escaped.
• $classd_start - the amount of starting class ds.
• $classd_counter - $classd_escape/$classd_counter.
• $scientists_escape - The number of scientists to escape so far.
• $scientists_start - the amount of starting scientists
• $scientists_counter - $scientists_escape/$scientist_start.
• $scp_kills - number of people killed by scps.
• $warhead_detonated - prints ☢ WARHEAD DETONATED ☢ if its gone off.

Example:

Config Additions

Type Info:

• Boolean: True or False value
• Integer: A number without decimals
• Float: A number with decimals (Formatting like "1.0" and "1,0" both work and are the same value)
• List: A list with items separated by ",", for example: list: 1,2,3,4,5
• Dictionary: A dictionary with items separated by ":", and each entry separated by ",", for example: dictionary: 1:2,2:3,3:4
• Seconds: Time in seconds, usually a value of -1 disables the feature
• Minutes: Time in minutes, usually a value of -1 disables the feature
• R: If the config option has an R before it, it means that you can use a random value in it. A random value is defined by having "{}", items listed like "weight%value" where if you don't put a weight it defaults to a weight of 1, separated by "|", for example: rlist: {1%1|2%7|6},3,6,{15%3|2|45%2} RDictionary: {6%1:1|2%1:6|2%1:8|1:10|2%1:13}

Crossed out config options are removed, unless otherwise specified in the description

Bolded config options are ones that are in the vanilla game

General

Config Option	Value Type	Default Value	Description
allow_incompatible	Boolean	False	Allow the server to run an incompatible version of ServerMod
auto_round_restart_time	Seconds	10	The time before the next round starts when a round ends
server_frame_rate	Integer	60	The framerate that a server runs at
show_on_serverlist	Boolean	True	If your server is verified, this shows it on the server list
sm_debug	Boolean	False	Print more verbose debug messages for debugging
sm_server_name	String	Dynamic	server name in a separate option, defaults to the value of server_name (You'd use server_name if you don't want variables showing up in your server name when ServerMod isn't working)
sm_tracking	Boolean	True	Appends the ServerMod version to your server name, this is for tracking how many servers are running ServerMod
master_server_to_contact	String	https://hubertmoszka.pl/authenticator.php	The master server to push data to, this is used for private server lists (DEPRICATED, USE "secondary_servers_to_contact")
secondary_servers_to_contact	List	Empty	The master servers to push data to, this is used for private server lists
start_round_timer	Seconds	20	The amount of time before the round auto-starts (when queueing for a round)
sm_floating_items_everyone	Boolean	False	Make everyone's items float when they're dropped (includes items spawned on the map in the beginning)
sm_floating_items_steamids	List	Empty	A list of SteamID64s for the players that should have their items float when dropped
start_round_minimum_players	Integer	2	Minimum playercount for starting the countdown before the round starts.
window_health	Float	30.0	Sets the HP of breakable windows. If the amount is less than zero, windows can't be broken.

Administration / Gameplay

Config Option	Value Type	Default Value	Description
disable_badges	Boolean	False	If true, admins will not have the admin badge on your server. (DEPRICATED, use "hidden" as badge color in remote admin config instead)
enable_ra_server_commands	Boolean	True	Enables / Disables running console commands through text based Remote Admin
server_command_whitelist	List	Empty	A list of SteamID64s for the users allowed to run console commands through text based Remote Admin (Whitelist is used by default even if you don't specify it), as of ServerMod 3.1.7 this now also supports rank ids (for example, "owner, admin, moderator")
bypass_server_command_whitelist	Boolean	False	Allows anybody with access to text based Remote Admin to run console commands
filler_team_id	Integer	4	If the team spawn queue is shorter than the max player count, this team number will be used for the rest of the players when they spawn
item_cleanup	Seconds	-1	Cleans up items after the specified amount of time
ragdoll_cleanup	Seconds	-1	Cleans up ragdolls after the specified amount of time
nickname_filter	List	Empty	Automatically kicks anyone who's nickname contains anything in this list
remove_item_loot	RList	Empty	Removes all instances of the specified item ID from all lockers
replace_item_loot	RDictionary	Empty	Replaces all instances of the specified item ID from all lockers with the second specified item ID
add_item_loot	RList	Empty	Adds the specified item ID to all lockers' loot
scp_grenade_multiplier	Float	1.0	The multiplier for the amount of damage grenades do to SCPs
human_grenade_multiplier	Float	0.7	The multiplier for the amount of damage grenades do to humans
disable_blood_on_screen	Boolean	False	Disable the blood effect on player's screen
nuke_cleanup	Boolean	False	Deletes all items underground after the nuke goes off
scp106_lure_amount	Integer	1	The amount of lures required to contain SCP-106
scp106_lure_team	List	1,2,3,4,6	Teams that will be killed and counted as a sacrifice for the Femur Breaker
tesla_triggerable_team	List	1,2,3,4,6	Teams that can trigger tesla gates

Reserved Slots

Config Option	Value Type	Default Value	Description
dedicated_slots	Integer	Number of IPs in Reserved Slots.txt	The number of slots above the maximum to reserve for certain players (REQUIRES RESTART) (Depricated, use "reserved_slots" instead)
reserved_slots	Integer	Number of IPs in Reserved Slots.txt	The number of slots above the maximum to reserve for certain players (REQUIRES RESTART)
dedicated_slot_location	String	[appdata]/SCP Secret Laboratory	The directory that the Reserved Slots file should be (Depricated, use "reserved_slots_location" instead)
dedicated_slot_file_name	String	Reserved Slots.txt	The file name to use for the Reserved Slots file (Depricated, use "reserved_slots_file_name" instead)
reserved_slots_location	String	[appdata]/SCP Secret Laboratory	The directory that the Reserved Slots file should be
reserved_slots_file_name	String	Reserved Slots.txt	The file name to use for the Reserved Slots file
dedicated_slot_ips	List	Empty	A list of the IPs of players to allow into the reserved slots (Depricated, use "Reserved Slots.txt" instead, scroll down for the usage)
reserved_slots_simulate_full	Boolean	False	For debugging, this simulates the server being full, so only players with reserved slots can (Do not enable this if you don't know what you're doing)
reserved_slots_comment_symbol	String	//	The comment symbol to prefer out of the available options, you can also set a custom one if you'd like, the default available symbols are "//" and "#"

How to use the new Reserved Slots: In the new "Reserved Slots.txt" file in the SCP AppData location, you put one SteamID or IP per line, and you can end each line with a comment using "//". If you want to use both an IP and SteamID, you put the IP, a semicolon (";"), then the SteamID

Everything following and including the "//" is optional

Update as of ServerMod 3.1.6: As of now, formatting will be less enforced, there can now be empty lines, commented out lines, and multiple comment symbols

For comment symbols, the current default is "//" or "#", you can add your own using the reserved_slots_comment_symbol config option

Example Usage:

1.1.1.1 // IP
11111111111111111 // SteamID64 (Automatically fetches IP)
127.0.0.1;22222222222222222 // IP and SteamID64 (Automatically updates IP)
127.0.0.1;22222222222222222
127.0.0.1;11111111111111111

Player Management

Config Option	Value Type	Default Value	Description
afk_kick	Seconds	-1	Kicks players who haven't moved in a specified amount of time
escapee_restrained_check	Boolean	False	If true, escapees are set to the opposite team if they are cuffed (disarmed), for example, if a Class-D escaped while cuffed, they would become NTF
last_movement_timeout	Seconds	30	After this amount of time without a player sending any movement, they will be kicked (still sends movement if they're standing still, so this isn't anti-afk)
rejected_movement_limit	Integer	-1	The amount of movements detected by the anti-cheat as invalid before a player is kicked, the detection count increases per invalid movement and decreases per valid movement
sm_onplayerjoin_tries_timeout	Integer	50	The amount of tries before the OnPlayerJoin event gives up on executing for a player (to prevent it constantly running if a player disconnects before it's run)

Warhead Options

Config Option	Value Type	Default Value	Description
auto_warhead_start	Seconds	-1	Automatically activated the nuke after the specified amount of time has elapsed (-1 disables this feature)
auto_warhead_start_lock	Boolean	False	Automatically prevents the warhead detonation from being cancelled when it's automatically started

Decontamination Options

Config Option	Value Type	Default Value	Description
disable_decontamination	Boolean	False	Enables / Disables Light Containment Zone decontamination
decontamination_time	Minutes	11.74	The time before LCZ is locked and decontaminated

SCP-914 Options

Config Option	Value Type	Default Value	Description
scp914_teleport_players	Boolean	True	Moves players in SCP-914's input area to the output area
scp914_keep_health	Boolean	True	Keep the same health when a player moves from SCP-914's input area to the output area and the class is changed
scp914_<rough/coarse/1_to_1/fine/very_fine>_change_class	RDictionary	Empty	Changes a player's class from the first specified class to the second specified class when they're teleported to SCP-914's output area
scp914_in_<rough/coarse/1_to_1/fine/very_fine>_damage	RDictionary	Empty	Damages a player by the second specified value when the class matches the first specified value before their class is changed
scp914_out_<rough/coarse/1_to_1/fine/very_fine>_damage	RDictionary	Empty	Damages a player by the second specified value when the class matches the first specified value after their class is changed and if they're in the output area

Pocket Dimension Options

Config Option	Value Type	Default Value	Description
pd_exit_count	Integer	2	The amount of exits to the Pocket Dimension
pd_random_exit_rids	RList	Empty	The list of RoomIDs that players will be randomly teleported to after escaping from Pocket Dimension
pd_random_exit_rids_after_decontamination	RList	Empty	The list of RoomIDs that players will be randomly teleported to after LCZ decontamination
pd_refresh_exit	Boolean	False	Randomly refresh the exit of Pocket Dimension after it's used
scp106_cleanup	Boolean	False	Stops items and ragdolls from spawning in the pocket dimension

Class Based

Config Option	Value Type	Default Value	Description
no_scp079_first	Boolean	True	Computer (SCP-079) will never be the first scp in a game
173_door_starting_cooldown	Seconds	25	The time before SCP-173's door can be opened
maximum_MTF_respawn_amount	Integer	15	The maximum amount of MTF that can be respawned in a single respawn wave
scp049_hp	Integer	1700	Sets the starting HP for SCP-049
scp049-2_hp	Integer	400	Sets the starting HP for SCP-049-2
scp079_hp	Integer	100	Sets the starting HP for SCP-079
scp096_hp	Integer	2000	Sets the starting HP for SCP-096
scp106_hp	Integer	650	Sets the starting HP for SCP-106
scp173_hp	Integer	3200	Sets the starting HP for SCP-173
scp457_hp	Integer	700	Sets the starting HP for SCP-457
scp939_53_hp	Integer	2200	Sets the starting HP for SCP-939-53
scp939_89_hp	Integer	2200	Sets the starting HP for SCP-939-89 (Or SCP-939-109 as on the forceclass tab)
classd_hp	Integer	100	Sets the starting HP for Class Ds
scientist_hp	Integer	100	Sets the starting HP for Scientists
ci_hp	Integer	100	Sets the starting HP for Chaos Insurgency
ntfg_hp	Integer	100	Sets the starting HP for NTF Guards
ntfscientist_hp	Integer	120	Sets the starting HP for NTF Scientists
ntfl_hp	Integer	120	Sets the starting HP for NTF Lieutenants
ntfc_hp	Integer	150	Sets the starting HP for NTF Commanders
facilityguard_hp	Integer	100	Sets the starting HP for Facility Guards
force_disable_enable	Boolean	False	Overrides game's default class ban value with chosen values (USE OF THIS IS NOT RECOMMENDED)
scp049_disable	Boolean	False	Disables SCP-049
scp079_disable	Boolean	True	Disables SCP-079
scp096_disable	Boolean	False	Disables SCP-096
scp106_disable	Boolean	False	Disables SCP-106
scp173_disable	Boolean	False	Disables SCP-173
scp457_disable	Boolean	True	Disables SCP-457
scp939_53_disable	Boolean	False	Disables SCP-939-53
scp939_89_disable	Boolean	False	Disables SCP-939-89 (Or SCP-939-109 as on the forceclass tab)
scp049_amount	Integer	1	Max amount of SCP-049 that can be spawned in randomly
scp079_amount	Integer	1	Max amount of SCP-079 that can be spawned in randomly
scp096_amount	Integer	1	Max amount of SCP-096 that can be spawned in randomly
scp106_amount	Integer	1	Max amount of SCP-106 that can be spawned in randomly
scp173_amount	Integer	1	Max amount of SCP-173 that can be spawned in randomly
scp457_amount	Integer	1	Max amount of SCP-457 that can be spawned in randomly
scp939_53_amount	Integer	1	Max amount of SCP-939-53 that can be spawned in randomly
scp939_89_amount	Integer	1	Max amount of SCP-939-89 (Or SCP-939-109 as on the forceclass tab) that can be spawned in randomly
scp_healing_duration	Seconds	-1	Heal SCPs who haven't moved and got hurt in a specified amount of time
scp_healing_health	Integer	100	The amount of HP that SCPs will recover

Smart Class Picker (All in Vanilla Game)

Config Option	Value Type	Default Value	Description
smart_class_picker	Boolean	True	Enables/Disables Smart Class Picker
smart_cp_starting_weight	Integer	6	The weight a class starts out with
smart_cp_weight_min	Integer	1	The minimum weight a class can have
smart_cp_weight_max	Integer	11	The maximum weight a class can have
smart_cp_class_<Class #>_weight_decrease	Integer	Dynamic	The amount a weight goes down when a player plays the specified class, the default value is dynamic based on which team and class the player is
smart_cp_class_<Class #>_weight_increase	Integer	Dynamic	The amount a weight goes up when the player isn't the specified class, the default value is dynamic based on which team and class the player is
smart_cp_team_<Team #>_weight_decrease	Integer	Dynamic	The amount the weight for each class on a team goes down when a player plays on the specified team, the default value is dynamic based on which team and class the player is
smart_cp_team_<Team #>_weight_increase	Integer	Dynamic	The amount the weight for each class on a team goes up when the player isn't on the specified team, the default value is dynamic based on which team and class the player is

Default Functionality

• Every class gets +1 weight except for the class the player is chosen to be or the chosen class is NTF or SCP
• If the player is chosen to be NTF, the chosen class gets -4 weight and every other NTF class gets -2 weight
• If the player is chosen to be SCP, the chosen class gets -3 weight and every other SCP class gets -2 weight
• If the player is chosen to be Class D, Class D gets -3 weight
• If the player is chosen to be any other class, the chosen class gets -2 weight

Place any suggestions/problems in issues!

Thanks & Enjoy.