From ffe1accdf68f05466f5100b63140faee9f0747ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Ku=C3=9Fowski?= Date: Thu, 21 Aug 2025 12:15:10 +0200 Subject: [PATCH] chore: Add documentation for commands --- doc/commands.md | 156 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 156 insertions(+) create mode 100644 doc/commands.md diff --git a/doc/commands.md b/doc/commands.md new file mode 100644 index 00000000..8c8f6a27 --- /dev/null +++ b/doc/commands.md @@ -0,0 +1,156 @@ +## Available Chat Commands + +The Matrix Dart SDK supports out of the box chat commands. Just use `Room.sendTextEvent("/command");`. If you do not desire to get chat commands parsed, you can disable them like this: `Room.sendTextEvent("/command", parseCommands: false);` + +### Available Commands: + +## Available Chat Commands + +The Matrix Dart SDK supports out of the box chat commands. Just use `Room.sendTextEvent("/command");`. If you do not desire to get chat commands parsed, you can disable them like this: `Room.sendTextEvent("/command", parseCommands: false);` + +### Available Commands: + +```sh +/send +``` +Sends a plain message to the current room (commands are not parsed). + +```sh +/me +``` +Sends an emote message (e.g., `/me is happy` will display as "YourName is happy"). + +```sh +/dm [--no-encryption] +``` +Starts a direct chat with the given user. Optionally disables encryption. + +```sh +/create [] [--no-encryption] +``` +Creates a new group chat with the given name. Optionally disables encryption. + +```sh +/plain +``` +Sends a plain text message (no markdown, no commands) to the current room. + +```sh +/html +``` +Sends a message as raw HTML to the current room. + +```sh +/react +``` +Reacts to the message you are replying to with the given emoji. + +```sh +/join +``` +Joins the specified room. + +```sh +/leave +``` +Leaves the current room. + +```sh +/op [] +``` +Sets the power level of a user in the current room (default: 50). + +```sh +/kick +``` +Kicks a user from the current room. + +```sh +/ban +``` +Bans a user from the current room. + +```sh +/unban +``` +Unbans a user in the current room. + +```sh +/invite +``` +Invites a user to the current room. + +```sh +/myroomnick +``` +Sets your display name in the current room. + +```sh +/myroomavatar +``` +Sets your avatar in the current room. + +```sh +/discardsession +``` +Discards the outbound group session for the current room (forces new encryption session). + +```sh +/clearcache +``` +Clears the local cache. + +```sh +/markasdm +``` +Marks the current room as a direct chat with the given user. + +```sh +/markasgroup +``` +Removes the direct chat status from the current room. + +```sh +/hug +``` +Sends a "hug" event to the current room. + +```sh +/googly +``` +Sends a "googly eyes" event to the current room. + +```sh +/cuddle +``` +Sends a "cuddle" event to the current room. + +```sh +/sendRaw +``` +Sends a raw event (as JSON) to the current room. + +```sh +/ignore +``` +Ignores the given user (you will not see their messages). + +```sh +/unignore +``` +Stops ignoring the given user. + +```sh +/roomupgrade +``` +Upgrades the current room to a new version. + +```sh +/logout +``` +Logs out the current session. + +```sh +/logoutAll +``` +Logs out all sessions for the user. \ No newline at end of file