hack-chat / main

a minimal, distraction-free chat application

Home Page:https://hack.chat/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Can someone add a read me page with just how to use the commands within the client?

Adithr123 opened this issue · comments

Within the client, you can send /help, which will list all available commands. For specific information about these commands, you can add a command name after, for example /help emote, which will display all the information about the command along with it's usage (both API and texted based if available).

No, like can u make a read me, so that I don't have to flood my chat with /help

The output from running /help is only shown to the person who runs the command, no one else in the chat will see the text.

By design, hack.chat command modules are 'self-documenting'. The text you see when you run /help isn't just preformatted static data- it's live information that is taken from each enabled command module. That means that when a module is added/updated/removed, the developer does not need update X amount of other information sources- which is the main issue with having a "readme". A single source of truth already exists and does not need to be duplicated.

This is not a rhetorical issue either, as people have tried creating a "readme", available here. You will notice that this is out of date.