Download And Installation

Installing zorobot

Necessary Software

You'll need to have MySQL, a MySQL GUI frontend like SQLyog, and The Java SE Development Kit (JDK) software on your system before running zorobot. You can download them and install them from the sites below:

MySQL (community server) - http://dev.mysql.com/downloads/
SQLyog (GUI community edition) - http://www.webyog.com/en/downloads.php
JDK (Any JDK SE above v5.0) - http://java.sun.com/javase/downloads/index.jsp

(Note: JDK: Any JDK SE above version 5 should work fine. I'm using JDK 6 Update 3.)

Installation Notes:

MySQL: Upon installing MySQL, you'll see a screen asking for a username and password. It's recommended you set a password, and do not forget it, you'll need it later to connect the database. You'll also have the option to have MySQL automatically start when Windows boots. This is a good idea if you plan to use zorobot frequently. You can also leave the "host address" as "localhost"

Once all of the software is installed, you're ready to begin installing zorobot.

Zorobot files

Below is a list of files you will need for zorobot. Although not all are necessary, you'll probably want them all, and errors may occur if you are missing some files.

zorobot.jar (the most up-to-date version of zorobot)
database and settings files (not including zorobot.jar, the main executable)
question sets

New zorobot (requires different files than old zorobot, check back for updates or ask in the irc channel)
zorobot08-alpha0.21

zorobot.jar
zorobot0.073g.zip (older version: zorobot0.063c.zip zorobot0.052f.zip)

database files
zorobot_db_20071109.zip (older version: zorobot_db.zip)

database import files
KanjiImport.zip
KanjiImportA.zip
edictimp.zip
NewJapaneseString.zip
Database.zip
EdictRomajiConstructor.zip

question sets
questionset.zip
hirakata.zip
animemanga.zip

kanjidic2.xml
kanjidic2.zip (one available elsewhere might not be compatible w/ linux)

some libraries that might be required
otherlib.zip
wnjn.zip

Once you've downloaded all the files above, extract them all into the same directory of your choosing.
(NOTE: As of 0.073g, you should also create a "saved" folder inside this same directory)

Setting up the database

Connecting to the database

Start SQLyog, and it will ask you for a username and password. Enter what you chose when you installed MySQL earlier.

From the next GUI screen, go to the DB menu option in the top, and select Restore SQL from dump.

Select the .sql file in your zorobot directory and hit okay. You should now be connected to the database.

We don't need to make any changes now, so you can exit the program. if you would like to doublecheck that you're connected, restart SQLyog, connect, and you should see a new DB labelled "zorobot" on the leftside of the window.

Building the kanji database

Open a command prompt window (click start button -> click run -> type: cmd <enter>).
Go to the zorobot directory.
type
java -cp .;mysql.jar;jdom.jar -mx256m KanjiImportA <enter>
java -cp .;mysql.jar;jdom.jar -mx256m KanjiImport <enter>

in linux:
java -cp .:mysql.jar:jdom.jar -mx256m KanjiImportA <enter>

If there are no problems, it should complete the kanji database. (NOTE: KanjiImportA should be run first, though it doesn't appear to harm anything)

Do the same for Edict (EdictImport -> EdictMeaningImport -> EdictPosImport) and anything else you may be adding to the database (NOTE: As of 0.073g, you will likely need to delete columns "romaji", romaji1", and "romaji2" from the "japword" table in order to import the edict data. Replace them once you are ready to use EdictRomajiConstructor)

Some possible problems/solutions:
- missing JDBC-connection: Download mysql-connector and rename the jar file to mysql.jar and place it to the zorobot directory.
-jdom prob: Download jdom, copy the jdom.jar from the build directory to the zorobot directory.
- missing edict.txt. Download edict from web, rename to edict.txt (note: in new zorobot 08 version, place all the .txt files such as enamdict.txt, edict.txt to /dict directory. Then run with ^start enamdict kanji=[:kanji:]+ for example.)
- missing settings.txt, see below.

Settings

In your favourite text editor, open/create the file "settings.txt" in your zorobot directory. There you will see a list of options you can configure for the bot. Below is an explanation of them.

user=The username you used for MySQL
password=The password you used for MySQL
nickname=The nickname you want the bot to use, you may register it with nickserv
fullname=The identd that the bot will use
nickpass=The password for the bot to identify with nickserv for registered nicknames
server=The IRC server the bot will connect to
port=The IRC server port number to use
channel=The channels to join, with "#" separated by "," (#mychan,#mychan2,etc.)
joindelay=How long to wait before joining the channels.
prefix=The prefix key to use to control the bot in the channel (Ex: prefix=# means all bot commands will start with "#". #start, #help, #review, etc.

Running the bot

If all went well, you are now ready to start the bot and connect to IRC.

Open a command prompt window again, go to the main zorobot directory, and use "java -jar <filename>" to start the main zorobot.jar file in the directory.

Example: java -jar zorobot0.072c.jar

You should see zorobot connect to IRC in that command prompt window, and join the channels you chose in the settings.txt file. You will also be able to see channel messages, etc. as normal in that window. The bot can be disconnected by using ctrl+c, or closing the command prompt window.

FAQ and Troubleshooting

zorobot is still a work in progress, so errors and problems are to be expected. If you have any problems, please check the list below. If you don't find an answer, please let us know, and we'll try to help you resolve the issue as soon as possible.

You may name the main zorobot directory anything you like.
You may rename the main zorobot.jar file (example: zorobot0.072c.jar) to anything you like.
If the bot cannot join a channel you listed in the settings.txt, it may be because the channel requires users to have registered nicknames. In this case, please register the nickname you wish the bot to use with through the server.
If you have registered the nickname already, and the bot still will not join the channel you chose, it may be connecting to IRC, trying to join the channel quickly, and then registering its nickname after. If this is the case, you need to give the bot more time to register its nickname before joining a channel. Simply adjust the "joindelay=" setting in the "settings.txt" file to a higher number.

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-Share Alike 2.5 License.