About:
------
saiph - [Stupid|Silly|Smart|Superior]* AI Playing netHack.
* use a descriptive word beginning with "S".

The project is GPLv2 licensed.


Fetch code:
-----------
Given that you're reading this document there's a fair chance you've already
downloaded the code, but nevertheless, fetch it with Git here:
git clone http://projects.exent.net/saiph.git

Also, there are several people working on saiph, you might want to add their
repositories too:
  Vidar Wahlberg: git://github.com/canidae/saiph.git
Adrien Panhaleux: git://github.com/DainDwarf/saiph.git
      Kenny Root: git://github.com/kruton/saiph.git
 Jeffrey Bosboom: git://github.com/DrSunglasses/saiph.git

You should add these to git using the following command:
 git remote add -f <nick> <url>
Example:
 git remote add -f canidae git://github.com/canidae/saiph.git


Keeping your repo updated:
--------------------------
You should pull regularly from http://projects.exent.net/saiph.git or
git://github.com/canidae/saiph.git with this command:
 git pull canidae master
Replace "canidae" if you used another name for that repo.

If some of the other repos got a patch you really want that hasn't been merged
into the main repos, then you can get that patch with the following commands:
 git fetch <nick>
 git log HEAD..FETCH_HEAD
 git show <commit>
 git cherry-pick <commit>


Building & running:
-------------------
Depending on whether you wish to run remotely or locally, edit Saiph.cpp and
change between CONNECTION_TELNET and CONNECTION_LOCAL in
"Saiph *saiph = new Saiph(CONNECTION_TELNET);" (near the bottom of the file).

If you're running locally you'll have to do this once before executing saiph:
 export NETHACKOPTIONS=@<path to nethackrc>

You'll also need a terminal that's capable of displaying at least 160x50
characters.

Then build & start the bot:
 make clean && make
 ./saiph

Optionally start the game this way:
 make game


People who are working on or have contributed to saiph:
-------------------------------------------------------
Vidar Wahlberg <canidae@exent.net>, aka. canidae
Adrien Panhaleux <adrien.panhaleux@ens-lyon.fr>, aka. DainDwarf
Kenny Root <kenny@the-b.org>, aka. kRutOn
Jeffrey Bosboom <doctorsunglasses@dslextreme.com>, aka. DrSunglasses