From 05d4b4d09726ef452a7398639b0cb56a896ed798 Mon Sep 17 00:00:00 2001 From: antifallobst Date: Mon, 10 Jul 2023 23:36:54 +0200 Subject: [PATCH] Docs(Commands): Documented the command system --- docs/CommandLine.md | 7 +++++++ docs/Commands.md | 13 +++++++++++++ docs/Config.md | 3 +++ 3 files changed, 23 insertions(+) create mode 100644 docs/CommandLine.md create mode 100644 docs/Commands.md create mode 100644 docs/Config.md diff --git a/docs/CommandLine.md b/docs/CommandLine.md new file mode 100644 index 0000000..c6d1e6b --- /dev/null +++ b/docs/CommandLine.md @@ -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 `+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. \ No newline at end of file diff --git a/docs/Commands.md b/docs/Commands.md new file mode 100644 index 0000000..1f08062 --- /dev/null +++ b/docs/Commands.md @@ -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. | diff --git a/docs/Config.md b/docs/Config.md new file mode 100644 index 0000000..e6237b9 --- /dev/null +++ b/docs/Config.md @@ -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. \ No newline at end of file