| 1 |
Wolfpack is a scripting framework for Eggdrop written in Tcl, and is freely |
| 2 |
distributable under the GNU General Public License (GPL). |
| 3 |
|
| 4 |
It is designed to replace the traditional use of sourced Tcl scripts with |
| 5 |
Eggdrop. One of the more unique features is its ability to dynamically load, |
| 6 |
unload, and configure script 'modules' while the bot is running. The |
| 7 |
Wolfpack framework is designed in such a way that there should never be a |
| 8 |
need to manually edit a script 'module' to change its settings. |
| 9 |
|
| 10 |
To install Wolfpack, first copy the main 'wolfpack' directory to your |
| 11 |
'eggdrop/scripts' directory. You should then have an |
| 12 |
'eggdrop/scripts/wolfpack' directory. |
| 13 |
|
| 14 |
Next, at your shell prompt while inside the 'eggdrop' directory, run: |
| 15 |
|
| 16 |
./scripts/wolfpack/wolfpack.tcl -c |
| 17 |
|
| 18 |
This starts Wolfpack in a standalone mode with tclsh so that initial |
| 19 |
settings can be configured. |
| 20 |
|
| 21 |
There are 3 paths that need to be configured before Wolfpack can be loaded |
| 22 |
by eggdrop. These are the 'configpath', 'datapath', and 'modulepath'. The |
| 23 |
'configpath' and 'datapath' directories are where modules will store their |
| 24 |
config files or data files (if they use them), respectfully. The |
| 25 |
'modulepath' is where module '.tcl' files are located. If you have installed |
| 26 |
Wolfpack into 'eggdrop/scripts/wolfpack' as mentioned above, these can be |
| 27 |
set as follows: |
| 28 |
|
| 29 |
set configpath scripts/wolfpack/wpconf/ |
| 30 |
set datapath scripts/wolfpack/wpdata/ |
| 31 |
set modulepath scripts/wolfpack/modules/ |
| 32 |
|
| 33 |
Modules can then be enabled or disabled with the 'enable' or 'disable' |
| 34 |
commands. See 'help' and 'help <command>' for more detailed information. |
| 35 |
|
| 36 |
After typing the above commands, the 'quit' command will exit the |
| 37 |
configuration program and save the 'wolfpack.conf' config file. |
| 38 |
|
| 39 |
Once the initial config file is created, add a 'source' command to your |
| 40 |
bot's config file as you would for tradition scripts: |
| 41 |
|
| 42 |
source scripts/wolfpack/wolfpack.tcl |
| 43 |
|
| 44 |
You can then start your bot, which should then print out some status |
| 45 |
information as Wolfpack is loading with your bot: |
| 46 |
|
| 47 |
Wolfpack: wolfpack.tcl v1.9.9 loading... |
| 48 |
Wolfpack: Using configuration file: wolfpack.conf |
| 49 |
Wolfpack: Loading module database... |
| 50 |
Wolfpack: Done. |
| 51 |
Wolfpack: Comparing and updating module database... |
| 52 |
Wolfpack: Done. |
| 53 |
Wolfpack: Building command table... |
| 54 |
Wolfpack: Done. |
| 55 |
Wolfpack: Loading modules... |
| 56 |
Wolfpack: Done. |
| 57 |
Wolfpack: Modules loaded (2/53): texttools usertools |
| 58 |
|
| 59 |
Once you've gotten this far, everything else can be configured via '.wpconf' |
| 60 |
while in dcc chat with your bot. To use this command, you must have the |
| 61 |
owner (n) flag, and your handle must also be listed in the 'owner' variable |
| 62 |
if you have enabled 'must-be-owner'. There is a built-in help system for |
| 63 |
'.wpconf' which contains detailed information on each command. Typing 'help' |
| 64 |
will list the available commands and 'help <command>' will provide detailed |
| 65 |
usage information. |
| 66 |
|
| 67 |
Good luck! |
Parent Directory
| 
Revision Log
| 
Revision Graph