mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-11-02 17:29:22 +01:00
81 lines
3.6 KiB
Plaintext
81 lines
3.6 KiB
Plaintext
Common
|
|
|
|
First things first: Supybot *requires* at least Python 2.6 and
|
|
setuptools. There ain't no getting around it. You can get Python from
|
|
http://www.python.org/ and setuptools from
|
|
https://pypi.python.org/pypi/setuptools.
|
|
|
|
Recommended Software
|
|
|
|
PySQLite -- Version 1.x
|
|
|
|
Twisted -- Version 1.2.0 or greater
|
|
|
|
For more information and help on how to use Supybot, checkout
|
|
the documents under docs/ (especially GETTING_STARTED and
|
|
CONFIGURATION).
|
|
|
|
So what do you do? That depends on which operating system you're
|
|
running. We've split this document up to address the different
|
|
methods, so find the section for your operating system and continue
|
|
from there.
|
|
|
|
UNIX/Linux/BSD
|
|
|
|
If you're installing Python using your distributor's packages, you may
|
|
need a python-dev package installed, too. If you don't have a
|
|
'/usr/lib/python2.x/distutils' directory or
|
|
'/usr/lib/python2.x/config/Makefile' (assuming '/usr/lib/python2.x' is
|
|
where your Python libs are installed), then you will need a python-dev
|
|
package.
|
|
|
|
After you extract Supybot and cd into the supybot directory just
|
|
created, you'll want to run (as root) 'python setup.py install'. This
|
|
will install Supybot globally. If you need to install locally for
|
|
whatever reason, see the notes at the end of this section. You'll then
|
|
have several new programs installed where Python scripts are normally
|
|
installed on your system ('/usr/bin' or '/usr/local/bin' are common on
|
|
UNIX systems). The two that might be of particular interest to you, the
|
|
new user, are 'supybot' and 'supybot-wizard'. The former, 'supybot', is
|
|
the script to run an actual bot; the latter, 'supybot-wizard', is an
|
|
in-depth wizard that provides a nice user interface for creating a
|
|
registry file for your bot.
|
|
|
|
Local Install
|
|
|
|
You can install Supybot in a local directory by using the '--user'
|
|
option when running 'setup.py'. E.g., 'python setup.py install
|
|
--user' to install into your home directory. You'll now have
|
|
a $HOME/.local/bin directory containing Supybot programs ('supybot',
|
|
'supybot-wizard', etc.) and a $HOME/.local/lib directory containing the
|
|
Supybot libraries.
|
|
|
|
Windows
|
|
|
|
**Note**: If you are using an IPV6 connection, you will not be able
|
|
to run Supybot under Windows (unless Python has fixed things). Current
|
|
versions of Python for Windows are *not* built with IPV6 support. This
|
|
isn't expected to be fixed until Python 2.4, at the earliest.
|
|
|
|
Now that you have Python installed, open up a command prompt. The
|
|
easiest way to do this is to open the run dialog (Programs -> run) and
|
|
type "cmd" (for Windows 2000/XP/2003) or "command" (for Windows 9x). In
|
|
order to reduce the amount of typing you need to do, I suggest adding
|
|
Python's directory to your path. If you installed Python using the
|
|
default settings, you would then do the following in the command prompt
|
|
(otherwise change the path to match your settings)::
|
|
|
|
set PATH=C:\Python2x\;%PATH%
|
|
|
|
You should now be able to type 'python' to start the Python
|
|
interpreter. Exit by pressing CTRL-Z and then Return. Now that that's
|
|
setup, you'll want to cd into the directory that was created when you
|
|
unzipped Supybot; I'll assume you unzipped it to 'C:\Supybot' for these
|
|
instructions. From 'C:\Supybot', run 'python setup.py install'. This
|
|
will install Supybot under 'C:\Python2x\'. You will now have several new
|
|
programs installed in 'C:\Python2x\Scripts\'. The two that might be of
|
|
particular interest to you, the new user, are 'supybot' and 'supybot-wizard'.
|
|
The former, 'supybot', is the script to run an actual bot; the latter,
|
|
'supybot-wizard', is an in-depth wizard that provides a nice user interface for
|
|
creating a registry file for your bot.
|