From 159ad6254c1a1e89b48ebc0d37f7d9e9cc3d214b Mon Sep 17 00:00:00 2001 From: Tearzz Date: Tue, 24 Apr 2018 16:11:21 +0200 Subject: [PATCH] Updated README.md Changed description to be more clear under "Admin Commands:" Added description and images for adding API commands. --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 12ce416..74207e2 100644 --- a/README.md +++ b/README.md @@ -21,15 +21,23 @@ But as you can see in the preview image it's also able to handle custom commands **Adding Commands:** 1. Open **"CommandsHandler.rb"** and scroll down to the `commands` array and add your own. 2. Go to folder **"Responses"** and add the command as a text file in all lowercase. _Examples have been included_ - + +**Admin Commands:** If you are adding admin commands add a custom response next to it. There you'll be able to add commands that gives data to the socket instead of a chat message as a response. Example: `admin_commands = { "disconnect" => "PART ##{CHANNEL}" }` -When the command `"!disconnect"` has been typed in chat by the channel owner it will send a request to disconnect from the current Twitch channel._ +When the command `"!disconnect"` has been typed in chat by the channel owner _(or anyone specified in the `admins` array)_ it will send a request to disconnect from the current Twitch channel._ ![alt text](https://i.imgur.com/iYtSvaG.png "Prefix, commands and admin commands") + +**API Commands:** +If you want to add API commands you just scroll down to `# ----- API COMMANDS ----- #` _(First section after receiving messages)_ and add your commands. In the example it calls some functions which are made at the bottom of the script. +![alt text](https://i.imgur.com/CBF7vYf.png "Right after the received messages section") + +Then you scroll down to the bottom under `# ----- API COMMANDS ----- #` and add a function to that command. +![alt text](https://i.imgur.com/CBF7vYf.png "Here you add your dedicated function for the API command") ----