Core Commands Plugin
This is a built-in core plugin that follows the plugin template system.
Usage:
!exit/!quit
: Initializes the bot exit procedure.!stopplugin 'plugin_name'
: Stops a running plugin using the plugin's shutdown procedures.!startplugin 'plugin_name'
: Starts an inactive plugin using the plugin's startup procedures.!restartplugin 'plugin_name
: Restarts a currently running plugin.!help
: Displays a list of the help commands for all the available plugins.!help 'plugin_name'
: Displays all the commands available for the given plugin.!setcomment 'comment_text'
: Sets the bot's user comment with the given text.!resetcomment
: Resets the bot's user comment to the default text.!pguistresstest
: Conducts a stress test of the PGUI system in the channel chat. Uses a default of 5 lines.!pguistresstest 'number of lines'
: Conducts a stress test of the PGUI system in the channel chat. Optionally set the number of lines to control the size of the test.!version
: Displays the bot version.!restartplugins
: Quits and restarts all active plugins.!restart
: Completely stops the bot and restarts it.!saferestart
: Completely stops the bot and restarts it.!about
: Displays the bots about screen.!refreshuserprivileges
: Refreshes the custom user privileges from the config folder and updates the database.!refreshpermissions
: Refreshes the custom command permissions from the config folder and updates the database.!refreshaliases
: Refreshes the custom aliases from the config folder and updates the database.!importuserprivileges 'url_to_csv_file'
: Imports user privileges a csv file downloaded from the provided URL and updates the database.!importpermissions 'url_to_csv_file'
: Imports command permissions a csv file downloaded from the provided URL and updates the database.!importaliases 'url_to_csv_file'
: Imports aliases from a csv file downloaded from the provided URL and updates the database.!getpermission 'commmand_name'
: Displays the command's permission level.!setpermission 'commmand_name' 'permission_level'
: Sets the command's permission level to the number provided.!setalias 'alias_name' 'command'|'command'|...
: Registers an alias for single/multi-commands.!removealias 'alias_name'
: Removes a registered alias by the given name.!clearaliases
: Removes all registered aliases.!aliases
: Displays a list of registered aliases.!history
: Displays the command history.!clearhistory
: Clears the command history.!uptime
: Displays the amount of time the bot has been online.
Plugin Metadata
[Plugin Information]
PluginVersion = 5.2.0
PluginName = Core Commands
PluginDescription = The Core Commands plugin handles core functionality commands.
PluginLanguage = EN
PluginCommands: [
"stopplugin",
"startplugin",
"restartplugin",
"sleep",
"version",
"about",
"uptime",
"exit",
"restart",
"saferestart",
"restartplugins",
"setcomment",
"resetcomment",
"pguistresstest",
"help",
"refreshuserprivileges",
"refreshpermissions",
"refreshaliases",
"importuserprivileges",
"importpermissions",
"importaliases",
"getpermission",
"setpermission",
"setalias",
"aliases",
"removealias",
"clearaliases",
"clearhistory",
"history"
]
[Plugin Settings]
ThreadWaitForCommands: ["exit", "sleep"]
UseSingleThread = False
[Plugin Type]
ControllablePlugin = False
AudioPlugin = False
ImagePlugin = False
CorePlugin = True
ExtensionPlugin = False