forked from trinitrix/core
Docs(Commands): Documented the command system
This commit is contained in:
parent
a30229b763
commit
05d4b4d097
|
@ -0,0 +1,7 @@
|
|||
# Command Line
|
||||
Trinitrix has a command line, which you can use to control and navigate the app.
|
||||
You can activate it with the `CommandLineShow` command, which is mapped to `<Ctrl>+c` by default.
|
||||
|
||||
## Syntax (LUA)
|
||||
The command line uses [lua](https://www.lua.org/about.html) and provides a builtin function for every internal command.
|
||||
The function names are the snake case variants of the command names.
|
|
@ -0,0 +1,13 @@
|
|||
# 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. |
|
|
@ -0,0 +1,3 @@
|
|||
# Config
|
||||
To configure trinitrix, you can add a file named `config.lua` to the userdata path.
|
||||
This file will be interpreted on startup with the same syntax as the Command Line.
|
Loading…
Reference in New Issue