-
Notifications
You must be signed in to change notification settings - Fork 5
SEL Command Information
This document describes expanded details about commands found in the Stumble Standard Extensions Library.
It is sorted by each extension.
Usage:
gaingain LEVEL
The gain command sets the internal gain of all audio. Valid values range between 1 and 100, inclusive. Going outside this range sets the gain to either borderline.
Given no LEVEL, it simply returns the current gain.
Usage:
mute
The mute command toggles a self-mute on the bot.
Usage:
feedback
The feedback command causes all audio output to be fed back into the audio input.
This command is ignored if the bot is busy with other audio related tasks.
Usage:
playplay KEY
The play command looks up the given key against the database, and attempts to play the associated audio clip from disk.
If there is audio playing, and room in the queue, the clip will be place into the queue.
Usage:
next
The next command stops any audio playing, and attempts to play the next clip in the queue.
Usage:
stop
The stop command stops any audio playback, and does not involve the queue in any way.
Usage:
findfind QUERY
The find command searches the database for audio keys, returning keys, the uploader of each, and the date which it was added. QUERY is a substring to match against individual keys.
Providing no QUERY will return all keys.
Usage:
clear
The clear command clears all entries in the queue.
Usage:
stream AUDIO_URL
The stream command downloads a valid audio file from the provided URL, plays it, and deletes the file afterwards.
You can not queue streams.
Usage:
save KEY AUDIO_URL
The save commands downloads a valid audio file from the provided URL, stores it on disk, records the location, and creates a database entry.
There can not be duplicate keys stored in the database.
Usage:
rename KEY
The rename command is used to change the key associated with a previously saved audio file. The bot will prompt the user for a followup message, that will become the new key value.
Usage:
delete KEY
The delete command removes a key entry from the database, and removes the file associated with it from disk.
No commands.
Usage:
infoinfo COMMAND_NAME
The info command treats any text passed to it as the name of another command, and attempts to retrieve information about that command. Information about the command will be sent directly to the invoking user.
Passing nothing, the bot will provide a link to this page.
The user will be informed in the event that the given text does not match any loaded command, or in the event that the command offers no information.
Usage:
help
The help command lists the all of the commands currently loaded in the bot.
Usage:
get KEY
The get command returns the message associated with the given key.
Usage:
set KEY
The set command associates a message with the given key. The user will be prompted for a followup message, which will become the associated value.
There can not be duplicate keys stored in the database.
Usage:
unset KEY
The unset command removes a key and message pair from the database.
Usage:
searchsearch QUERY
The search command searches the database for message keys, returning keys, number of images contained in the message, the uploader of each, and the date which it was added. QUERY is a substring to match against individual keys.
Providing no QUERY will return all keys.
Usage:
echo TEXT
The echo command simply replies to the invoking user with TEXT.
No commands.
Usage:
leave
The leave command causes the bot to exit the current channel, and move up one level in the channel tree.
The bot can not leave the root channel. Use join or afk in that instance.
Usage:
joinjoin NUMERIC_IDjoin CHANNEL_NAME
The join command causes the bot to move to the specified channel. Channels can be specified by their numeric IDs, or their names, with the latter taking precedence.
Passed nothing, the bot will join the channel of the user who invoked the command.
Usage:
afk
The afk command sends the bot to the AFK channel specified in the config.
The invoking user will be informed if there is no specified channel, or the specified channel can not be found.
Usage:
home
The home command sends the bot to the Home channel specified in the config.
The invoking user will be informed if there is no specified channel, or the specified channel can not be found.
No commands.
See usersystem.
Usage:
time
The time command informs the invoking user's channel of the current UTC time.
Usage:
uptime
The uptime command informs the invoking user's channel of how long the time extension has been loaded.
Commands here are prefixed, meaning they are super serious.
Usage:
system::load EXTENSION
The system::load command attempts to load the specified extension from the Standard Extension Library.
It will inform the invoking user about the result of the load.
Usage:
system::unload EXTENSION
The system::load command attempts to unload the specified extension from the Standard Extension Library.
It will inform the invoking user about the result of the unload.
Yes, a user can unload the system extension.
Usage:
channel-id
The channel-id command returns the numeric ID of the invoking user's current channel.
Usage:
comment TEXT
The comment command sets the bot's comment.
Stumble is created with love.