List of main bot commands

All commands listed in this documentation works even if no function is activated. Don't forget that functions can provide own commands. A description can be found at the function documentation in the ConfigHelp.html file.

Arguments in squared brackets are optional. Arguments in angle brackets are required.

Possible bot admin permission levels: LA = Light Admin
BA = Bot Admin
FBA = Full Bot Admin

Command Alternative commands Needed Permissions? Description
!botinfo !info Nothing needed Shows you the running bot version and uptime. It also displays the current bot admin permission level.
!bothelp !h Nothing needed Shows you a list of bot chat commands (based on the own bot admin permission level). Optionally you can add a command name to this command to get a help message about this command.
Usage: !bothelp [bot chat command]
!getchannelid !channellist LA / BA / FBA Search for channel name to see the channel id or vice versa. The full channel name is not needed, just enter a part of the channel name.
Usage: !getchannelid [channel id or part of the channel name]
!listchannelgroups LA / BA / FBA Get a list of all channel groups of a client! Without arguments you get a complete list of all channel groups.
Usage: !listchannelgroups [client database id or unique id]
!listinactiveclients !inactiveclients LA / BA / FBA List all clients which are inactive since X days. Without argument the most inactive clients will be displayed. The client database list cache needs to be enabled in the main bot configuration!
Usage: !listinactiveclients [minimum days inactive]
!listinactivechannels !emptychannels LA / BA / FBA List of empty channels sorted by empty since time. Optionally you can add a channel name or channel id to this command to filter the list. You can use nospacer as first argument to ignore spacer channels in this list.
Usage: !listinactivechannels [nospacer] [channel id or part of the channel name]
!listservergroups LA / BA / FBA Get a list of all server groups of a client! Without arguments you get a complete list of all server groups.
Usage: !listservergroups [client database id or unique id]
!msgall LA / BA / FBA Sends a private message to all online clients. You can use §+§ to split a message into multiple messages.
Usage: !msgall <message>
Example: !msgall Hello guys!
!msgchannelgroup !msgchannelgroups LA / BA / FBA Sends a private message to all online clients with this specified channel groups at the moment. Multiple comma separated channel groups without spaces are possible. You can use §+§ to split a message into multiple messages.
Usage: !msgchannelgroup <channelgroup id> <message>
Example: !msgchannelgroup 8,5 Hello guys!
!msgservergroup !msgservergroups LA / BA / FBA Sends a private message to all online clients that are member of the specified server groups. Multiple comma separated server groups without spaces are possible. You can use §+§ to split a message into multiple messages.
Usage: !msgservergroup <servergroup id> <message>
Example: !msgservergroup 6,7 Hello guys!
!pokeall LA / BA / FBA Sends a poke message to all online clients. You can use §+§ to split a message into multiple messages.
Usage: !pokeall <message>
Example: !pokeall Hello guys!
!pokechannelgroup !pokechannelgroups LA / BA / FBA Sends a poke message to all online clients with this specified channel groups at the moment. Multiple comma separated channel groups without spaces are possible. You can use §+§ to split a message into multiple messages.
Usage: !pokechannelgroup <channelgroup id> <message>
Example: !pokechannelgroup 8,5 Hello guys!
!pokeservergroup !pokeservergroups LA / BA / FBA Sends a poke message to all online clients that are member of the specified server groups. Multiple comma separated server groups without spaces are possible. You can use §+§ to split a message into multiple messages.
Usage: !pokeservergroup <servergroup id> <message>
Example: !pokeservergroup 6,7 Hello guys!
!removeservergroups LA / BA / FBA Removes all server groups of a client!
Usage: !removeservergroups <client database id or unique id>
!removechannelgroups LA / BA / FBA Sets all non-default channel groups of a client to the default channel group in all channels!
Usage: !removechannelgroups <client database id or unique id>
!searchclient !clients
!clientlist
!clientsearch		 LA / BA / FBA Shows some database information of a client. Search using the client name (* as a wildcard possible). You can also search using the complete unique id.
Example: !clientsearch *foo*bar*
!searchdesc !searchdescription LA / BA / FBA Shows some database information of a client found using the client description. Use * as a wildcard. The client database list cache needs to be enabled in the main bot configuration!
Example: !searchip *foo*bar*
!searchip LA / BA / FBA Shows some database information of a client found using ip address. Use * as a wildcard. The client database list cache needs to be enabled in the main bot configuration!
Example: !searchip 127.0.*
!setchannelname !renamechannel LA / BA / FBA Set a new channel name for the given channel id.
Usage: !setchannelname <channel id> <new channel name>
!setchannelgroup LA / BA / FBA Sets channel group to client to all specified channels! Separate all channel ids with a comma at the end of this command!
Usage: !setchannelgroup <client database id or unique id> <channel group id> <channel id list separated with comma>
!botcfghelp BA / FBA Returns information about a config key. If no key argument given, a list of config keys will be returned.
Example: !botcfghelp bot_channel_id
!botcfgget BA / FBA Returns the value of a current config key.
Example: !botcfgget bot_channel_id
!botcfgset BA / FBA Set a new value for a config key. Notice: You have to save and reload the bot configuration to see the changes!
Example: !botcfgset bot_channel_id = -1
!botcfgcheck BA / FBA Check if current config (for example after using !botcfgset) is valid.
!botcfgreload BA / FBA Reloads the bot configuration. You can use a function name as argument to reload only that configuration of that function. The bot will not reconnect using this command.
!botcfgsave BA / FBA Saves current bot configuration.
!botconfirmerrors !confirmerrors BA / FBA Resets the exception error counter, if you solved the configuration error without restarting the bot.
!botfunctionlist !functionlist BA / FBA Get a list of currently loaded functions.
!botfunctioninfo !functioninfo BA / FBA Return a short information about the function.
Usage: !botfunctioninfo <function prefix>
!botfunctionactivate !functionon BA / FBA Activate the given function.
Usage: !botfunctionactivate <function prefix>
!botfunctiondisable !functionoff BA / FBA Disable the given function.
Usage: !botfunctiondisable <function prefix>
!botjoinchannel !joinchannel
!botchannel		 BA / FBA Switch the bot into another channel. Without argument, the current channel of the bot will be returned.
Usage: !botjoinchannel [channel id]
!botlog BA / FBA Shows you the location of the bot log.
!botrename BA / FBA Without argument bot renames back to default client name from bot config. Specify a client name as argument to set a new temporary client name for the bot.
Usage: !botrename [new name]
!botreload !reconnect BA / FBA Disconnects the current virtual bot instance, reload bot configuration and start the virtual bot instance again. Bot configuration will be checked first!
!botversioncheck !botversion
!version		 BA / FBA Displays current installed, latest stable and latest development (if exists) versions of this bot.
!botinstancelist FBA Shows a list of all virtual bot instances with the current status.
!botinstancename FBA Returns the name of the current virtual bot instance.
!botinstancelistreload FBA Reloads the bot list from the JTS3ServerMod configuration. This command also reloads the most settings from the JTS3ServerMod_InstanceManager.cfg like the Bot Full Admin List or the exec command state.
!botinstancestart FBA Starts a virtual bot instance with the given name.
Usage: !botinstancestart <name>
!botinstancestop FBA Stops a virtual bot instance with the given name. If no name given, the current virtual bot instance will be stopped.
Usage: !botinstancestop [name]
!botreloadall FBA Disconnects all virtual bot instances, reload bot configuration and start all virtual bot instances again. This command do not check bot configuration first!
!botquit !quit
!exit		 FBA Disconnect and quits all virtual bot instances. The JTS3ServerMod process will be stopped afterwards.
!exec FBA Executes the specified system command. This command don't return the text output, just fire and forget! For security reasons this command needs to be enabled at the JTS3ServerMod_InstanceManager.cfg file.
Usage: !exec <system command>
!execwait FBA Executes the specified system command and waits for process end. Program text output and return code will be send as answer. For security reasons this command needs to be enabled at the JTS3ServerMod_InstanceManager.cfg file.
Usage: !execwait <system command>