core/docs/Commands.md

<!--
Copyright (C) 2024 - 2024:
The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
SPDX-License-Identifier: GPL-3.0-or-later

This file is part of Trinitrix.

This program is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your option)
any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program.
If not, see <https://www.gnu.org/licenses/>. 
-->

# Commands

Trinitrix relies heavily on the concept of commands.
There is a command for every interaction with the application.
By this, everything can use the same internal API, what makes the whole application extreme extensible and customizable.

## Available Commands

| Command         | Description                                                                   |
|-----------------|-------------------------------------------------------------------------------|
| Exit            | Terminates the whole application.                                             |
| CommandLineShow | Shows the command line.                                                       |
| CommandLineHide | Hides the command line.                                                       |
| RoomMessageSend | Sends the message, which is passed as argument, to the currently active room. |
chore(treewide): Add up-to-date license headers 2024-05-04 18:55:52 +00:00			`<!--`
			`Copyright (C) 2024 - 2024:`
chore(treewide): change license to GPL-3.0 or later To archive this, the previous MIT-License and its mentions were removed, COPYING was added, LICENSE.spdx and README were modified to show the correct license, sils@sils.li was added to the project's E-Mail adresses and ./scripts/renew_copyright_header.sh was executed. 2024-05-06 14:29:15 +00:00			`The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>`
			`SPDX-License-Identifier: GPL-3.0-or-later`
chore(treewide): Add up-to-date license headers 2024-05-04 18:55:52 +00:00
			`This file is part of Trinitrix.`

chore(treewide): change license to GPL-3.0 or later To archive this, the previous MIT-License and its mentions were removed, COPYING was added, LICENSE.spdx and README were modified to show the correct license, sils@sils.li was added to the project's E-Mail adresses and ./scripts/renew_copyright_header.sh was executed. 2024-05-06 14:29:15 +00:00			`This program is free software: you can redistribute it and/or modify it`
			`under the terms of the GNU General Public License as published by the`
			`Free Software Foundation, either version 3 of the License, or (at your option)`
			`any later version.`

			`This program is distributed in the hope that it will be useful, but`
			`WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY`
			`or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.`

			`You should have received a copy of the GNU General Public License along with this program.`
			`If not, see <https://www.gnu.org/licenses/>.`
chore(treewide): Add up-to-date license headers 2024-05-04 18:55:52 +00:00			`-->`

Docs(Commands): Documented the command system 2023-07-10 21:36:54 +00:00			`# Commands`
style(treewide): Format and improve the headers This commit represents one run of `./scripts/renew_copyright_headers.sh`. 2024-05-04 19:06:17 +00:00
Docs(Commands): Documented the command system 2023-07-10 21:36:54 +00:00			`Trinitrix relies heavily on the concept of commands.`
			`There is a command for every interaction with the application.`
			`By this, everything can use the same internal API, what makes the whole application extreme extensible and customizable.`

			`## Available Commands`

			`\| Command \| Description \|`
			`\|-----------------\|-------------------------------------------------------------------------------\|`
			`\| Exit \| Terminates the whole application. \|`
			`\| CommandLineShow \| Shows the command line. \|`
			`\| CommandLineHide \| Hides the command line. \|`
			`\| RoomMessageSend \| Sends the message, which is passed as argument, to the currently active room. \|`