Skip to content

Commit c481833

Browse files
committed
docs: add missing commands to readme documentation
1 parent 7e99e77 commit c481833

File tree

1 file changed

+40
-8
lines changed

1 file changed

+40
-8
lines changed

README.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,52 @@
11
# Repository of a plugin for BigBlueButton
22

3+
## Implemented Commands
4+
5+
### `/list`
6+
- **Description:** Lists all available commands in the chat.
7+
- **Usage:** Type `/list` in the chat.
8+
- **Restrictions:** None.
9+
10+
### `/demote`
11+
- **Description:** Demotes the user who issued the command to the viewer role.
12+
- **Usage:** Type `/demote` in the chat as a moderator.
13+
- **Restrictions:** Only users with moderator privileges can execute this command.
14+
15+
### `/demoteAll`
16+
- **Description:** Demotes all users in the meeting to the viewer role, except for the user who issued the command.
17+
- **Usage:** Type `/demoteAll` in the chat as a moderator. The command will change the role of all other users to viewers.
18+
- **Restrictions:** Only users with moderator privileges can execute this command. The command will not affect the sender.
19+
20+
### `/promoteAll`
21+
- **Description:** Promotes all users in the meeting to the moderator role, except for the user who issued the command.
22+
- **Usage:** Type `/promoteAll` in the chat as a moderator. The command will change the role of all other users to moderators.
23+
- **Restrictions:** Only users with moderator privileges can execute this command. The command will not affect the sender.
24+
25+
### `/spam`
26+
- **Description:** Sends a message repeatedly, either a specified number of times or at regular intervals.
27+
- **Usage:**
28+
- For multiple sends: `/spam "message with spaces" [times]` (default 1, max 100)
29+
- For interval spam: `/spam "message" interval <ms>`
30+
- **Restrictions:** None. Use `/stopSpam` to stop interval spam.
31+
32+
### `/stopSpam`
33+
- **Description:** Stops all active spam intervals started by the `/spam` command.
34+
- **Usage:** Type `/stopSpam` in the chat.
35+
- **Restrictions:** None.
36+
37+
### `/debug`
38+
- **Description:** Displays detailed debug information about the current session, including user details, browser environment, timing information, and storage data.
39+
- **Usage:** Type `/debug` in the chat.
40+
- **Restrictions:** None.
41+
342
## Description
443

544
This is an experimental internal plugin developed by mconf for BigBlueButton. Its main purpose is to allow the inclusion and execution of custom chat commands in meetings. The plugin is designed to be easily extensible, enabling developers to add new commands with minimal effort.
645

746
### Features
847
- Easily add new chat commands by extending the configuration.
948
- Commands can trigger custom mutations and actions in the meeting context.
10-
- Example command: `/demote` (see below for details).
49+
- Example command: `/demote` (see above for details).
1150

1251
A screenshot and/or a short video can be added here to illustrate usage.
1352

@@ -60,13 +99,6 @@ const DEFAULT_COMMANDS: CommandConfig = {
6099
};
61100
```
62101

63-
## Implemented Commands
64-
65-
### `/demote`
66-
- **Description:** Demotes all users in the meeting to the viewer role, except for the user who issued the command.
67-
- **Usage:** Type `/demote` in the chat as a moderator. The command will change the role of all other moderators to viewers.
68-
- **Restrictions:** Only users with moderator privileges can execute this command. The command will not affect the sender or users who are already viewers.
69-
70102
## Development mode
71103

72104
As for development mode (running this plugin from source), please, refer back to https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk section `Running the Plugin from Source`

0 commit comments

Comments
 (0)