A fork of JJMumblebot which is a complete mess
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
JJMumbleBot/docs/wiki/plugins/core/whisper_plugin.html

69 lines
2.8 KiB

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>JJMumbleBot - Whisper Plugin</title>
<link rel="stylesheet" href="https://bootswatch.com/4/darkly/bootstrap.css" crossorigin="anonymous">
<link rel="stylesheet" href="https://duckboss.github.io/JJMumbleBot/css/content-pages.css" crossorigin="anonymous">
<noscript>Please enable JavaScript in your browser!</noscript>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<script src="https://duckboss.github.io/JJMumbleBot/js/insert_html.js"></script>
</head>
<body>
<nav id="table_of_contents"></nav>
<div class="main-content">
<h2 id="page-title">Whisper Plugin</h2>
<p>
This is a built-in core plugin that follows the plugin template system. <br>
Adds whisper support for audio and text data.
</p>
<h3>Usage:</h3>
<code>!setwhisperuser 'username'</code>: Sets the whisper target to the given user<br>
<code>!setwhisperusers 'username1,username2,...'</code>: Sets the whisper target to multiple users.<br>
<code>!addwhisperuser 'username'</code>: Adds the user to the whisper targets.<br>
<code>!setwhisperme</code>: Sets the whisper target to the command sender.<br>
<code>!setwhisperchannel 'channelname'</code>: Sets the whisper target to the given channel.<br>
<code>!clearwhisper</code>: Clears any previously set whisper target.<br>
<code>!removewhisperuser 'username'</code>: Removes a specific user from the whisper targets.<br>
<code>!getwhisper</code>: Displays the current whisper target.
<div>
<details>
<summary>Plugin Metadata</summary>
<pre><code>
[Plugin Information]
PluginVersion = 5.0.0
PluginName = Whisper
PluginDescription = The Whisper plugin handles mumble whisper functionality.
PluginLanguage = EN
PluginCommands: [
"setwhisperuser",
"setwhisperusers",
"addwhisperuser",
"setwhisperme",
"setwhisperchannel",
"clearwhisper",
"removewhisperuser",
"getwhisper"
]
[Plugin Settings]
; List commands that need the core thread to wait for completion.
; This may include processes that require multiple commands in succession.
; For example: [Youtube Plugin - !yt -> !p] process requires 2 commands in that order.
ThreadWaitForCommands: []
UseSingleThread = False
[Plugin Type]
ControllablePlugin = False
AudioPlugin = False
ImagePlugin = False
CorePlugin = True
ExtensionPlugin = False
</code></pre>
</details>
</div>
</div>
<footer></footer>
</body>
</html>