This book contains all information to using a DCWatch robot.
The current DCWatch releases don't contain executable installer. You must simple unzip the archive of release and you can use the robot immediately.
The robot will connect to the developer hub by default. You can change the default settings. Edit the conf/dcwatch.xml file.
The file contains this:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE configuration SYSTEM "http://dcwatch.hu/dtd/configuration.dtd"> <configuration> <service host="adcs://dcwatch.hu:29673" name="DCWatch" share="0"> <plugin class="hu.dcwatch.plugin.lua51.Lua51Plugin"/> <plugin class="hu.dcwatch.plugin.base.BasePlugin"/> <plugin class="hu.dcwatch.plugin.chatlink.ChatLinkPlugin"/> <plugin class="hu.dcwatch.plugin.statistic.StatisticPlugin"/> <plugin class="hu.dcwatch.plugin.aggregator.AggregatorPlugin"/> <user id="ULPVY74AMJAUYJH6VOGXZYYTNSRFBI6HUHPDFBY" name="Admin"/> </service> </configuration>
Az XML felépítése eléggé magáért beszél. A service egy robot által nyújtott szolgáltatást tartalmaz. Jelen esetben egy ADCS hubot, amit a host attribútum mutat meg. A name tartalmazza, hogy a robot milyen nick nevet használjon a hubra lépéshez. Ezek a paraméterek kötelezőek. Ha egy jelszóval védett accountot használunk, akkor a password attribútumban meg tudjuk adni a jelszót is.
All supported attributes:
| Attribute | Description |
|---|---|
| description | The robot's description in service |
| The robot's email address in service | host | An URI of service |
| name | The identifier of robot in service |
| password | The password if the robot is registered in service |
You can launch the program with startup32.cmd, startup32.sh or startup64.sh shell scripts. It depends from type and architecture of your OS.
When the robot connected to the hub enter the --help command to main or bot's private chat to displaying available commands.
[13:39:18] <CyB> --help [13:39:18] <Jabber> Available commands: chatlink - Chat link manager connection - Connection management exit - Exit feed - Manage RSS and ATOM feeds gc - Run Java Garbage Collector help - Show list of available commands info - Show statistic and general information language - Language management save - Save configuration to file user - User management
A listában szereplő parancsokat két részre lehet osztani. There are standalone commands and some command has subcommands.
The most important standalone command is the --help but the --exit, --gc, --info and --save commands belong here.
Mint a nevéből is adódik, ezzel a paranccsal tudjuk kiléptetni a robotot. A parancs hatására a robot lementi az aktuális beállításokat (--save), és kilép az összes hubról.
The GC is the acronym of Java Garbage Collector. This command call the Garbage Collector to free all unused memory spaces.
It shows some base information from the server and Java Virtual Machine. Memory usage, uptime and software versions.
When you enter this command the robot will save all settings to configuration files.
Ebbe a kategóriába tartozik a legtöbb plugin által nyújtott parancs. The base package contains three commands.
You can handle existing connections or you can create a new connection with this command.
More information: <liter>
You can change the language of the bot with --language command. Az eddigi verziókban csak globálisan tudjuk megmondani a nyelvet, de a későbbi verziókban hubonként lehet majd megadni, hogy a robot az adott hubra milyen nyelven írjon.
More information: <liter>
You can handle the registrations of users or you can launch some user specific process.
More information: http://www.dcwatch.hu/hu/node/69
A robot --user parancsával érhetjük el a felhasználó kezelő adminisztrációs felületét. Let's look what can do with this.
If you enter the --user help command, you will get more information of available subcommands.
[14:05:41] <CyB> --user help
[14:05:41] <Jabber>
User manager:
add [host] <id> <name> - Create user registration with <id> and <name>
drop [host] <id> - Drop connected user by <id>
find [host] <condition> - Search for users with <condition>
help - Show this help
list [host] - Show registered users
message [host] <condition> <message> - Send chat <message> to filtered users.
remove [host] <id> - Remove user registration by <id>
Use the --user add command to create a new user registration.
--user add [host] <id> <name>
Parameters:
You can delete a registration with --user remove command.
--user remove [host] <id>
Parameters: