StarMirror/hack-chat-main
1
0
Fork 0
mirror of https://github.com/hack-chat/main.git synced 2024-03-22 13:20:33 +08:00
Code Issues Projects Releases Wiki Activity

Clarify documentation

Browse Source
This commit is contained in:
neelkamath 2018-05-12 13:49:55 +05:30
parent 3cb0e8dc5f
commit 880b0f7c27
2 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
DOCUMENTATION.md
View File

@ -2,35 +2,37 @@ You can programmatically access hack.chat using the following commands.
hack.chat has three permission levels. When you access a command, hack.chat automatically knows your permission level from your trip code. The lowest permission level is `core`. `mod` is above `core`, so it can access `core` commands in addition to `mod` commands. `admin` is similarly above `mod`.
The commands are to be sent through a websocket to the URL wss://hack.chat/chat-ws (everything sent and received are `string`s). If you are sending messages locally or to another domain, replace 'hack.chat' with that domain. If you're running your own instance of hack.chat, you can retain backwards-compatibility in order to ensure that software created for the main server will work on yours too.
# `core`
|Command|Parameters|Explanation|
|-------|----------|-----------|
|`changenick`|`nick`|This will change your current connections nickname|
|`chat`|`text`|Broadcasts passed `text` field to the calling users channel|
|`disconnect`||Event handler or force disconnect (if your into that kind of thing)|
|`help`|`type` or `category`, `command`|Outputs information about the servers current protocol|
|`invite`|`nick`|Generates a unique (more or less) room name and passes it to two clients|
|`join`|`channel`, `nick`|Place calling socket into target channel with target nick & broadcast event to channel|
|`morestats`||Sends back current server stats to the calling client|
|`move`|`channel`|This will change the current channel to the new one provided|
|`changenick`|`nick`|Changes the current connection's nickname.|
|`chat`|`text`|This broadcasts `text` to the channel the user is connected to.|
|`disconnect`||An event handler or forced disconnect.|
|`help`|`category` or `command`|Gives documentation programmatically. If `category` (the permission level, such as `mod`) is sent, a list of commands available to that permission level will be sent back (as a `string` and not an `array`). This list only includes what is unique to that category and not every command a user with that permission level could perform. If `command` (e.g., `chat`), a description of the command will be sent back.|
|`invite`|`nick`|Generates a pseudo-unique channel name and passes it to both the calling user and `nick`.|
|`join`|`channel`, `nick`|Places the calling socket into the target channel with the target nick and broadcasts the event to the channel.|
|`morestats`||Sends back the current server's stats to the calling client.|
|`move`|`channel`|This will change the current channel to `channel`.|
|`showcases`|`echo`|Simple command module template & info|
|`stats`||Sends back legacy server stats to the calling client|
|`stats`||Sends back legacy server stats to the calling client. Use `morestats` when possible.|
# `mod`
|Command|Parameters|Explanation|
|-------|----------|-----------|
|`ban`|`nick`|Disconnects the target nickname in the same channel as calling socket & adds to ratelimiter|
|`kick`|`nick`|Silently forces target client(s) into another channel. `nick` may be string or array of strings|
|`unban`|`ip` or `hash`|Removes target ip from the ratelimiter|
|`ban`|`nick`|Disconnects the target nickname in the same channel as the calling socket and adds it to the rate limiter.|
|`kick`|`nick`|Silently forces target client(s) into another channel. `nick` may be `string` or `array` of `string`s.|
|`unban`|`ip` or `hash`|Removes the target ip from the rate limiter.|
# `admin`
|Command|Parameters|Explanation|
|-------|----------|-----------|
|`addmod`|`nick`|Adds target trip to the config as a mod and upgrades the socket type|
|`listusers`||Outputs all current channels and sockets in those channels|
|`reload`||(Re)loads any new commands into memory, outputs errors if any|
|`saveconfig`||Saves current config|
|`shout`|`text`|Displays passed text to every client connected|
|`addmod`|`nick`|Adds the target trip to the config as a mod and upgrades the socket type.|
|`listusers`||Outputs all current channels and sockets in those channels.|
|`reload`||(Re)loads any new commands into memory and outputs errors, if any.|
|`saveconfig`||Saves the current config.|
|`shout`|`text`|Displays the passed text to each client connected.|

4
README.md
View File

@ -86,8 +86,8 @@ If you are changing the commands, make sure it is backwards compatible with the
## Authors
* **Marzavec** - *Initial work* - [marzavec](https://github.com/marzavec)
* **MinusGix** - *Base updates* - [MinusGix](https://github.com/MinusGix)
* [**Marzavec**](https://github.com/marzavec) - *Initial work*
* [**MinusGix**](https://github.com/MinusGix) - *Base updates*
See also the list of [contributors](https://github.com/hack-chat/main/graphs/contributors) who participated in this project.