Getting Started

To get started, just visit the downloads page and get the latest non-beta release, and unpack it.

Configuration

Inside the main folder is a "config.txt" file. It should contain someting like this:

# This is the config file for Hazelnut. # Please visit http://hazelnut.asmcbain.net/started.html for details on this file. # IRC information name=Hazelbot password= prefix=@ server=irc.freenode.net channels=#pircbot chankeys= # Hazelnut framework information plugins=quit,ping,time # Plugin information

This file tells the bot what to do when it starts up. Here's a table of what most of these default values mean:

name	Name of the bot when it joins a server
prefix	Prefix the bot responds to (inaddition to its name)

server	Server the bot joins when it starts
channels	A list of channels to join after the bot is connected to a server

plugins

A list of plugins to load when the bot is started

Plugins are listed by their filename, minus the extension (assumed to be ".js"). They should be inside the "plugins" folder inside the main Hazelnut folder. For more details on using this config file, see Configuring Hazelnut.

Running the Bot

After the bot is appropriately configured, find the "start up file", and run it. For Windows, this file will be "run.bat" and for Linux/Mac "run.sh". There are also " -debug" variants to these files, but they are mainly for developers.