public
Fork of sartak/TAEB
Description: the Tactical Amulet Extraction Bot (for NetHack)
Homepage: http://taeb.sartak.org
Clone URL: git://github.com/sorear/TAEB.git
TAEB /
name age message
file .gitignore Sat Jul 11 00:29:27 -0700 2009 Ignore lib/local/lib.pm [sartak]
file .perlcriticrc Fri Feb 27 22:56:49 -0800 2009 MXRP gives you strict/warnings too [sartak]
file LICENSE Wed Jun 10 20:04:30 -0700 2009 Revert "Remove the "how to use GPL" metadata fr... [sartak]
file Makefile.PL Wed Nov 04 01:06:16 -0800 2009 use new native traits [doy]
file README Loading commit data...
directory bin/ Fri Aug 28 11:58:35 -0700 2009 Adding a TAEB log -> ttyrec conversion script [Alex Smith]
directory doc/ Fri Jul 10 17:53:32 -0700 2009 Merge branch 'master' of git://github.com/sarta... [doy]
directory etc/ Fri Nov 20 19:50:29 -0800 2009 Turn off kiosk mode in my config [sartak]
directory inc/ Thu Jun 04 21:51:42 -0700 2009 Bump Module::Install [sartak]
directory lib/
directory t/ Sat Mar 14 08:22:18 -0700 2009 Remove monster tests :/ [sartak]
README
-- GETTING TAEB

The preferred method for obtaining the TAEB source is from the github repo:
    git clone git://github.com/sartak/TAEB.git

Alternatively, you can download "http://github.com/sartak/TAEB/tarball/master"
and extract to the directory of your choice.

You can also download TAEB from the CPAN: cpan -i TAEB

Downloading the tarball or installing from CPAN means less work up front (no
need to install git), but it'll be more work every time you want to update.


-- INSTALLING FROM TARBALL

If you're on Ubuntu, you'll first need to install the "build-essential" (for
make) and "libncurses5-dev" (for the Curses library) packages. If you are on OS
X, you will need Xcode and probably a few packages from MacPorts.


$ perl Makefile.PL

Or to install in your home directory instead of in the default location

$ perl Makefile.PL PREFIX=/home/username/.local

Answer the defaults to any dependencies it asks about. You may have to
set up CPAN. The defaults are usually fine. Be sure to set a mirror though.

$ make && sudo make install

This will install the modules from CPAN. TAEB's dependencies themselves
usually have a few dependencies. All in all you're probably looking at
about 60 modules.


-- AI

Though TAEB ships with a demo AI, you should still install a robust AI. There
are two actively developed AIs. The older of the two is Behavioral. The
preferred method to get it is through git:
    git clone git://github.com/doy/taeb-ai-behavioral.git

Or you can get a tarball from
"http://github.com/sartak/TAEB-AI-Behavioral/tarball/master" or the CPAN.

The newer actively developed AI is Planar, whose design principle is "be the
opposite of Behavorial". You can get it from darcs:

    darcs get http://ais523.sartak.org/TAEB-AI-Planar

-- CONFIGURATION

TAEB itself has a lot of configuration. It sets up some sensible defaults for
you (such as playing nethack locally with the Demo AI and communicating with
you via Curses). You aren't required to set up config, but if you want to
change how TAEB operates, such as by making him play on a NetHack server, you
can. Specify configuration in ~/.taeb/config.yml, which is written in YAML
(http://en.wikipedia.org/wiki/Yaml). Read the sample configuration in
TAEB::Config for more details.

-- RUNNING TAEB

You should now be ready to run TAEB! Type "taeb" and cross your fingers.

If perl doesn't find the installed modules you may need to set PERL5LIB to
where you placed them.