diff options
| author | marzavec <admin@marzavec.com> | 2018-05-20 02:21:08 +0200 |
|---|---|---|
| committer | marzavec <admin@marzavec.com> | 2018-05-20 02:21:08 +0200 |
| commit | a70006b5bca3c3273ba34bfd0607235339e87583 (patch) | |
| tree | f360e6d4e5e636956fa03a32a6f8064285ba424a /documentation/DOCUMENTATION.md | |
| parent | Merge pull request #12 from neelkamath/master (diff) | |
| download | hackchat-a70006b5bca3c3273ba34bfd0607235339e87583.tar.gz hackchat-a70006b5bca3c3273ba34bfd0607235339e87583.zip | |
streamline dev flow
Diffstat (limited to '')
| -rw-r--r-- | documentation/DOCUMENTATION.md (renamed from DOCUMENTATION.md) | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/DOCUMENTATION.md b/documentation/DOCUMENTATION.md index 4fa9055..b070dfa 100644 --- a/DOCUMENTATION.md +++ b/documentation/DOCUMENTATION.md @@ -1,19 +1,19 @@ -You can programmatically access hack.chat using the following commands via a websocket. To prevent getting disconnected, ping the server every 50 seconds. A list of wrappers written for accessing hack.chat can be found [here](https://github.com/hack-chat/3rd-party-software-list#libraries). +You can programmatically access hack.chat using the following commands via a websocket. A list of wrappers written for accessing hack.chat can be found [here](https://github.com/hack-chat/3rd-party-software-list#libraries). -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 the respective 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. +The commands are to be sent through a websocket to the URL `wss://hack.chat/chat-ws` (everything sent and received are JSON). If you are sending messages locally or to another domain, replace 'hack.chat' with the respective 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. All commands sent must be JSON objects with the command specified in the `"cmd"` key. For example: ```json { "cmd": "join", "channel": "programming", - "nick": "johndoe#fag" + "nick": "john#doe" } ``` -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`. +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 `user`. `mod` is above `user`, so it can access `user` commands in addition to `mod` commands. `admin` is similarly above `mod`. -# `core` +# `user` |Command|Parameters|Explanation| |-------|----------|-----------| @@ -43,4 +43,4 @@ hack.chat has three permission levels. When you access a command, hack.chat auto |`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.|
\ No newline at end of file +|`shout`|`text`|Displays the passed text to each client connected.| |