Skip to content
This repository was archived by the owner on Nov 29, 2021. It is now read-only.

Commit 5d20c0d

Browse files
committed
Version 1.1.0
1 parent a1a884e commit 5d20c0d

3 files changed

Lines changed: 20 additions & 6 deletions

File tree

ConsoleAwesome/ConsoleAwesome.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<package >
33
<metadata>
44
<id>$id$</id>
5-
<version>1.0.2</version>
5+
<version>1.1.0</version>
66
<title>$title$</title>
77
<authors>$author$</authors>
88
<owners>$author$</owners>

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ConsoleAwesome
1+
# ConsoleAwesome ![Version](https://img.shields.io/nuget/v/ConsoleAwesome.svg?label=version) [![Build status](https://ci.appveyor.com/api/projects/status/1hxfce410715c2fl?svg=true)](https://ci.appveyor.com/project/Tunous/consoleawesome)
22

33
ConsoleAwesome provieds easy access to execution of BotBits commands from the command line and displays various EverybodyEdits messages received through BotBits in an easy to read way.
44

@@ -11,11 +11,25 @@ To use this library you only have to call 2 methods and everything will be autom
1111
First step is to call `ConsoleAwesome.Initialize("Name of your bot")` which initializes the message handler.
1212
You should call it early in your program to be able to use write methods provided by ConsoleAwesome.
1313

14-
Second step is to bind console to BotBits client with `ConsoleAwesome.BindClient(YourBotBitsClient)`.
15-
This will handle listening and displaying of chat/info/etc messages and will allow you to execute commands by simply typing them in the console.
14+
Second step is to bind console to BotBits client with `ConsoleAwesome.BindClient(BotBitsClient)`.
15+
This will handle listening and displaying of chat/info/etc messages and will allow you to execute BotBits commands by simply typing them in the console.
1616

1717
# Commands
1818

1919
When you type something into the console and press enter it will be sent to the bot using say command which simply results in bot saying what you wrote.
2020
If you want to execute other commands you should prefix them with '/' or '!'.
21-
For example typing '/help' would execute the help command.
21+
For example typing '/help' would execute the help command.
22+
23+
## Custom commands
24+
25+
If you didn't bind BotBitsClient to the ConsoleAwesome you can add custom commands with `ConsoleAwesome.AddCustomCommand()` method.
26+
It accepts name of the command as first parameter and action to be executed as second.
27+
These commands are then executed when console input starts with specified command name.
28+
Whole input text is provided as an argument to the action so you can parse it to handle additional command arguments.
29+
30+
**NOTE:** You can't add multiple actions for single command name and command names shouldn't contain any spaces.
31+
32+
# Logging
33+
34+
You can enable logging of the messages by setting `ConsoleAwesome.LogFile` parameter.
35+
Once it's set to something different than null or white space all output will be appended to the path specified by `LogFile`.

appveyor.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: 1.0.{build}
1+
version: 1.1.{build}
22

33
nuget:
44
disable_publish_on_pr: true

0 commit comments

Comments
 (0)