Hooks are a way to add additional behaviour to the scripts. They are basically custom scripts that are called upon specific events. For example one could define a hook which is called on player connects and then send a message in the in-game chat to greet the new player.

All hooks have to executable files in SDTD_BASE/hooks/<name of hook>/<any name>.sh. The folder <name of hook> has to be in exactly the same case as the hook name column in the table below shows it.

If you want to use the functions of the management scripts in your hook you can add this to the start of your script:

#!/bin/bash
. /usr/local/lib/7dtd/common.sh

An example can be found in the greet.sh hook for playerConnect. Note that you have to use Bash as interpreter for your script if you want to use the script functions!

If you think a hook for another event could be interesting please create a ticket or contact me.

Currently the following hooks are defined:

Hook name	Called on event	Passed parameters	Examples
playerConnect	After a player has connected	Instance name Player ID Entity ID Nickname Steam ID	https://7dtd.illy.bz/attachment/wiki/Hooks/greet.sh
playerDisconnect	After a player has disconnected
serverPreStart	Before an instance is started	Instance name
serverPostStart	After an instance was started
serverPreStop	Before an instance is stopped
serverPostStop	After an instance was stopped
backup	After a backup was created	Path of new backup folder
chat	After message was sent in the chat	Instance name Message including player name