Update Readme.md and work on the CLI
Readme.md update - added cli usage section CLI work continues (not finished)
This commit is contained in:
11
README.md
11
README.md
@@ -5,11 +5,20 @@ This bot is a CMDli or Terminal application that should run on most systems.
|
|||||||
|
|
||||||
The Theory is this should be a Light Weight application and to that point, it can only handle Text based (Chat) commands.
|
The Theory is this should be a Light Weight application and to that point, it can only handle Text based (Chat) commands.
|
||||||
|
|
||||||
|
>### CMDli interface / usage
|
||||||
|
> [ $twitchbot ] will start the bot and show bot:>
|
||||||
|
> the options you can use are:
|
||||||
|
> bot:>title [get|set] <newTitle> - view the Current Title or set a new one
|
||||||
|
> bot:>category [get|set] <category> - view the Current Category or set a new one
|
||||||
|
> bot:>list [categories|cmd] <permLevel> - catergories = view a list of categories from twitch | cmd <permLevel> = shows url for the commands list for that permission level or all commands if <premLevel> isn't specified
|
||||||
|
> bot:>stats [--watch | --interval=2m] - watch command usage & how many times the commands have been used in the lifetime of the bot
|
||||||
|
> bot:>uptime - shows your current stream uptime
|
||||||
|
> bot:>cmd [add|del|edit] [trigger] <response> (response only required if adding or editing a command)
|
||||||
|
|
||||||
>[!NOTE]
|
>[!NOTE]
|
||||||
>While there is a command response for greetings, the bot should greet every user upon FirstWords (of the stream).
|
>While there is a command response for greetings, the bot should greet every user upon FirstWords (of the stream).
|
||||||
>The bot sohuld also NOT greet userNames that are removed from chat via WizeBot.
|
>The bot sohuld also NOT greet userNames that are removed from chat via WizeBot.
|
||||||
|
|
||||||
|
|
||||||
## The Commands it comes with:
|
## The Commands it comes with:
|
||||||
|
|
||||||
>[!NOTE]
|
>[!NOTE]
|
||||||
|
@@ -91,6 +91,10 @@ func dispatch(apiClient *twitchapi.Client, streamerChan string, args []string, w
|
|||||||
}
|
}
|
||||||
|
|
||||||
case "title":
|
case "title":
|
||||||
|
if len(args)<2 { fmt.Println("usage: title get|set <value>"); return }
|
||||||
|
sub := strings.ToLower(args[1])
|
||||||
|
switch sub {
|
||||||
|
case "get":
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user