Go to file
Jeremy Fincher 56e6fbd21c There is no more BasePlugin. 2003-09-03 17:50:32 +00:00
docs Updated. 2003-09-01 19:43:00 +00:00
examples Initial revision 2003-03-12 06:26:59 +00:00
others Added dict command. 2003-09-03 09:38:17 +00:00
plugins There is no more BasePlugin. 2003-09-03 17:50:32 +00:00
sandbox Removed friendly.py; it needs to be renamed Friendly.py and stuck in plugins/ 2003-03-27 08:47:25 +00:00
scripts Guarded inserts into sys.path. 2003-09-01 05:59:02 +00:00
src Updated world.upkeep to return the number of objects that have been collected and updated the upkeep command to return that number. 2003-09-03 17:27:08 +00:00
test Changed bold and mircColor to use the right ender \x0F. 2003-09-03 09:46:06 +00:00
tools Guarded inserts into sys.path. 2003-08-30 19:20:08 +00:00
.cvsignore Initial revision 2003-03-12 06:26:59 +00:00
ACKS Added more specifics for jamessan 2003-08-21 13:40:31 +00:00
BUGS Added link to SF.net page 2003-03-25 23:21:42 +00:00
LICENSE Initial revision 2003-03-12 06:26:59 +00:00
README Added some information, removed others, etc. 2003-04-02 10:21:14 +00:00
TODO Newest list of stuff for beta release. 2003-09-01 21:04:55 +00:00

README

EVERYONE:
---------
Read LICENSE.  It's a 2-clause BSD license, but you should read it anyway.


DEVELOPERS:
------------
Read OVERVIEW to see what the modules are used for.  Read EXAMPLE to see some
examples of callbacks and command written for the bot.  Read STYLE if you ever
wish to contribute.

Use PyChecker.  Believe me, it makes things better.  A sample
.pycheckrc file is included as tools/pycheckrc.  Copy this to your
~/.pycheckrc and you'll be able to check your code with the same
stringent guidelines I've found useful to check my code.


USERS:
------
All commands should be run from the root directory, never from any
subdirectory such as conf/, log/, src/, or plugins/.

All you have to do to get a working bot is run scripts/setup.py and
answer the questions!