zdm/envoy
zdm
/
envoy
Archived
3
Fork 0
Code Issues 22 Pull Requests Releases 1 Wiki Activity

Add current system commands

Leon Hofmeister 2020-10-20 19:49:06 +02:00
parent fe9679794e
commit 216ce8859a
1 changed files with 57 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
Client-using-system-commands.md Normal file

@ -0,0 +1,57 @@
Envoy Client can be used as a `pseudo-command line interface(CLI)` messenger:
You have the option to perform most actions by entering an `activator` as the first visible letter where you type new messages. <br>
If an activator is found (case insensitive), the word starting exactly behind it will be executed (that's a `system command`).<br>
A system command may need parameters to work, those have to be separated by a space.<br>
If not enough parameters have been given, default parameters will be supplied. In some cases however, they'll only ask you to enter one yourself.<br>
If the necessary parameters behind this system command have the correct format, the system command will be executed.<br>
If there are more parameters than necessary, the remaining ones will be ignored.<br>
If a system command has been executed, it will not be sent as a message (others won't know that you entered a system command).
<p>
The default activator is `/`.
It is planned that in the future this activator might be customizable according to your preferences.
## Current system commands are:
| Command | Parameters | Default values | Action |
| ---------------------------------- | --------------------- | -------------- | ----------------------------------------------- |
| `error` | `none` | `none` | Displays an error message |
| `dabr` | 0: int - the number of rotations,<br>1: float - the amount of time `it` rotates | 0: 1-4, 1: 1-4s | Short for "Do a barrel roll". But see for yourself |
| `logout` | `none` | `none` | Logs the current user out |
| `q` / `exit` | `none` | `none` | Closes Envoy (or minimizes it, depending on the settings option chosen) |
| `settings` | `none` | `none` | Opens the settings screen |
| `status` | 0: either `offline`, `away`, `busy` or `online` (case insensitive) | `none` | Changes your status to the given status |
#### message dependant commands (**ADVANCED**):
The following commands require a message to be parsed from the first parameter.
There are two ways how to aquire the message here (x is here a whole number):
1. "absolute": The x-th message from the top - i.e. using 3 as argument will use the third highest completely visible message
2. "relative": using `s+-x` will use the message +-x below the currently selected message - i.e. s+5 will use the message that is 5 messages below the currently selected one. Note: `++s`/ `s++` (= `s+1` ) and `--s`/ `s--` (= `s-1` ) are also possible.
<p>
If the parameter is not given, the currently selected message will be used.
| Command | Additional Parameters | Action |
| `s` | `none` | Selects the given message |
| `cp` | `none` | Copies the text of the given message |
| `del` | `none` | Deletes the given message locally |
| `save-att` | `none` | Saves the attachment of the given message if present (either directly or by asking you where, depending on your settings) |
### Examples
(Assuming default activator is the activator(`/`)):
`/error xyz abc test`<br>
`/DaBr`<br>
`/dabr 3 1.536`<br>
`/logout`<br>
`/s s++`<br>
`/cp 3`<br>
`/del --s`<br>
`/save-att s--`<br>
`/s 0`<br>
### Notation
* `int` refers to a whole number
* `float` refers to a decimal number where `.` is used as the separator between the whole number and the fraction