/[cvs]/wolfpack/README
ViewVC logotype

Contents of /wolfpack/README

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.13 - (show annotations) (download)
Sat Apr 3 05:28:48 2004 UTC (16 years, 2 months ago) by tothwolf
Branch: MAIN
Changes since 1.12: +1 -1 lines
*** empty log message ***

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

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23