clicraft-actions(5) Manual Page

Clicraft’s positional parameters are available, but are shifted once to the left. Thus, when an action script foo.sh is invoked with clicraft foo bar baz, $1 is "bar" and $2 is "baz".

The name of this action. For an action script foo.sh invoked with clicraft foo bar baz, $ACTION is "foo".

Configuration options are stored in variables by the same name as the option. For a description of these options and their default values, see clicraft.conf(5).

Clicraft exposes variables for each key-value pair in the regex database. The name of each variable is the uppercase version of the key prefixed with RE_ and with special characters replaced with underscores. The value of the variable is set to the value of the key in the database, with any leading occurences of "^^" replaced with the value of the timestamp database entry.

The directory where the clicraft script is stored. If you need to refer to the clicraft script directly, you should use $BINDIR/clicraft instead of $0, since the latter will not work if clicraft was called using a relative path (e.g. ./bin/clicraft).

The directory where clicraft stores its configuration files. This is where clicraft.conf(5) is located. User action scripts are located in this directory under $CLICRAFT_CONFIG/action.d. See clicraft.conf(5) for a description of how the value of $CLICRAFT_CONFIG is determined.

The default value for $CLICRAFT_CONFIG.

The directory for scripts used internally by clicraft. System action scripts are located in this directory under $EXECDIR/action.d.

In most circumstances, files under this directory should not be removed or modified, and no new files should be created.

Clicraft’s version number.

An array of commands to be run if clicraft exits abnormally. This variable should not be directly manipulated.

Print a formatted informational message to stdout. message is a format string composed of plain characters, character escape sequences, and format specifications for additional arguments, as described for printf under the SHELL BUILTIN COMMANDS section of bash(1).

Print a formatted warning message to stderr. message is a format string composed of plain characters, character escape sequences, and format specifications for additional arguments, as described for printf under the SHELL BUILTIN COMMANDS section of bash(1).

Print a formatted error message to stderr. message is a format string composed of plain characters, character escape sequences, and format specifications for additional arguments, as described for printf under the SHELL BUILTIN COMMANDS section of bash(1).

Print the location of the action script for action. If a system action script and user action script share the same name, print the value of the user action script. If no action script can be found, print an error to stderr and return nonzero.

Like action, but will only print the location of a user action.

Like action, but will only print the location of a system action.

Execute the action script for action with arguments args. If a system action and user action share the same name, run the user action script. If an action script cannot be found for action, print an error to stderr and return nonzero.

Like action, but will only execute a user action.

Like action, but will only execute a system action.

Print a list of available actions to stdout.

Return zero if the server is running, or nonzero otherwise.

Sends command to the server.

Print the usage message for action to stdout.

Look up key in the regex database and print the corresponding value to stdout. If the value of key has two leading start-of-line characters (^^) and prefix is given, insert prefix in place of the second ^ before printing. If a regex for key does not exist, print an error message to stderr and return nonzero.

Insert a new key and value into the regex database. If a regex for key already exists, print an error message to stderr and return nonzero.

Change the value for key to value in the regex database. If a regex for key does not exist, print an error message to stderr and return nonzero.

Delete the regex for key from the regex database. If a regex for key does not exist, print an error message to stderr and return nonzero.

If another process holds a "save" lock, do nothing and return nonzero. Otherwise, run /save-off on the server and wait for it to finish.

If another process holds a "save" lock, do nothing and return nonzero. Otherwise, run /save-on on the server and wait for it to finish.

If another process holds a "save" lock, do nothing and return nonzero. Otherwise, run /save-all on the server and wait for it to finish.

Print a space-delimited list of logged in players to stdout.

Kick player from the server. Returns nonzero if the kick was unsuccessful.

Ban target from the server. target can be a player or ip address.

Pardon banned target on the server. target can be a player or ip address. Returns nonzero if the pardon was unsuccessful.

Prints a variable name corresponding to string to stdout. Special characters in string not suitable for variable names are changed to underscores (_). If case is "upper" or "lower", alphabetical characters are changed to the respective case.

Prints the value of the variable corresponding to string to stdout. The variable to use is determined using `str2var string [case]\`.

Print the directory for dimension to stdout.

$ dimdir overworld
/srv/world

$ SERVER_TYPE=minecraft dimdir nether
/srv/world/DIM-1

$ SERVER_TYPE=minecraft dimdir end
/srv/world/DIM1

$ SERVER_TYPE=bukkit dimdir nether
/srv/world_nether

$ SERVER_TYPE=bukkit dimdir end
/srv/world_the_end

$ dimdir foo
/srv/world_foo

Print the value of property in server.properties to stdout. If the property cannot be found, print an error message to stderr and return nonzero.

Search for executable prog in PATH, HOME/bin, and SERVER_DIR. If prog can’t be found, search for any additional progs in the same way. If none can be found, return nonzero.

Run the commands in TRAPSTACK.

Add a command to TRAPSTACK for clicraft to run if it exits abnormally.

Try to remove the last command added to TRAPSTACK. If it doesn’t match command, poptrap will fail.

Try to create a lock identified by lockname. Returns nonzero if the lock is already held.

Try to remove the lock identified by lockname. Returns nonzero if the lock isn’t held by this clicraft process.

Start printing SERVER_LOG to stdout, run command, and wait until condition is reached or TIMEOUT seconds have passed before stopping output and returning. If TIMEOUT is reached, return nonzero. See clicraft.conf(5) for a description of the TIMEOUT option.