Changeset 547 for trunk/README


Ignore:
Timestamp:
09/19/04 15:01:22 (7 years ago)
Author:
james
Message:

updated

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/README

    r450 r547  
    22------------------ 
    33 
    4 http://bmotion.sourceforge.net 
     4http://www.bmotion.net 
    55 
    6 Thanks for trying out bMotion... if you encounter problems please  
    7 check the bug tracker on sourceforge before reporting them. The 
    8 bugtracker is the best place to report problems. 
     6Thanks for trying out bMotion! 
    97 
    108You can also get limited assistance from #bmotion on EFNet -- note 
     
    1311will spring up. 
    1412 
    15 There's also a sourceforge mailing list you may want to join for 
    16 discussing bMotion (as well as a low-traffic announements list). 
    17  
    18 Below are the instructions for installing bMotion, taken from the manual. 
    19 The full manual (currently a work in progress) is available from: 
    20  
    21 http://bmotion.sourceforge.net/docs/bMotion.pdf 
     13The official home for documentation is now http://www.bmotion.net 
    2214 
    2315Have fun! 
     
    2921HOW TO INSTALL 
    3022 
    31 (This assumes a working knowledge of eggdrop. If you're having problems 
    32 installing due to problems with eggdrop or your configuration, please 
    33 take them to the proper place rather than bringing them to me :) 
     23Please see http://www.bmotion.net/wiki/index.php/Installing for details 
     24on how to install bMotion. 
    3425 
    35 You'll need the following: 
     26--------------------------------------------------------------------- 
     27FEEDBACK 
    3628 
    37 * bMotion's code  
    38 * An eggdrop, already set up and working. (If you don't know  
    39 how to do this, or what I'm talking about, stop reading right here.)  
    40 * A cup of coffee 
     29Please bring feedback (positive and negative) to #bmotion on EFNet, or 
     30you can mail me at james@bmotion.net 
    4131 
    42 Version requirements: 
    43 * eggdrop 1.6.x (where x is reasonably high) 
    44 * TCL 8.3 or better 
    45  
    46 (bMotion may work to a varying degree on older versions, but you'll get 
    47 errors probably. If you're using older versions (check .status) then 
    48 I strongly recommend you upgrade.) 
    49  
    50 To get the latest bMotion release source, download it from  
    51 http://bmotion.sourceforge.net 
    52  
    53 If you're feeling daring, you can run the CVS code. The CVS version is always  
    54 the latest version, but it may have half-complete features and may even crash  
    55 your bot (however, I'm not in the habit of knowingly commiting code that kills  
    56 eggdrop to CVS... after all, it's what my bot runs). 
    57  
    58  
    59 Installing the files 
    60  
    61 Once you have your bMotion code, eggdrop, and coffee do the following: 
    62  
    63 Put the bmotion...tar.gz file in your eggdrop's scripts directory (usually  
    64 .../scripts). Run tar zxvf bmotion...tar.gz (substituting the proper filename).  
    65 This extracts the bMotion code to .../scripts/bmotion/. If you want to move the  
    66 code somewhere else, do so now. Change into the bmotion directory, and edit  
    67 bMotion.tcl with your favourite editor. The first two lines of code should look  
    68 like this: 
    69  
    70 set bMotionModules "scripts/bmotion/modules" 
    71 set bMotionPlugins "scripts/bmotion/plugins" 
    72  
    73 If you put bmotion somewhere else, edit these two variables to match. Close and  
    74 save the file. 
    75  
    76 (bMotion will try to load customised versions of certain files (see the manual for 
    77 more on customising), and the settings file is one of them. For easier upgrades, 
    78 copy modules/settings.tcl to modules/settings_BOTNETNICK.tcl (where BOTNETNICK is 
    79 the value from the 'set botnetnick ...' line in your eggdrop's config). Edit that 
    80 file instead of settings.tcl below.) 
    81  
    82 Now change into the modules directory. Fire up your editor and open settings.tcl  
    83 This file contains (brace yourself) all the settings for bMotion. You WILL want  
    84 to change these, so pay attention: 
    85  
    86 set bMotionInfo(gender) "male"  
    87 This sets the bot's gender. Choose from "male" or "female" 
    88  
    89 set bMotionInfo(balefire) 1  
    90 A somewhat traditionally-named setting. This  
    91 determines if the bot responds to things not directly addressed to it that you  
    92 wouldn't want more than one bot to answer. If you have only one bMotion bot on a  
    93 channel, set it to 1, else set it to 0 on all but one of the bots. 
    94  
    95 set bMotionInfo(randomChannels) { "#molsoft" "#ags" "#exeter" "#namcoarcade"  
    96 "#startrek" }  
    97 This is the list of the channels bMotion should be active on. If  
    98 the bot's on a channel not listed here, it will ignore all bMotion  
    99 commands/events there. Putting a channel in here that the bot isn't on will  
    100 likely cause TCL to strop, so get it right. Remember, bMotion can be annoying,  
    101 so only put it in channels where you have the right to, and where it will be  
    102 welcome. 
    103  
    104 set bMotionInfo(orientation) "straight"  
    105 Set the bot's sexual orientation. Choose  
    106 "straight", "bi", "gay", or "lesbian" 
    107  
    108 set bMotionSettings(needI) 1  
    109 Set this to one to require users to have the global  
    110 I (that's capital i) flag for most of bMotion to respond to them. This flag  
    111 isn't used much now anyway. Set it to 0 to have the bot treat all users equally. 
    112  
    113 set bMotionSettings(melMode) 0  
    114 Set this to 1 to make the bot ignore its morals  
    115 and sleep with anyone, regardless of gender or orientation. 
    116  
    117 set bMotionSettings(botnicks) "nt|bots|the bots"  
    118 This is an important one. It  
    119 defines the names your bot understands as referring to itself. (My bot is called  
    120 NoTopic, so the first field is nt). List all the names it should respond to,  
    121 separating them with a | (shift-\ on my keyboard). Case doesn't matter. Don't  
    122 use parentheses — ( and ). You don't need to include the bot's IRC nick, it will  
    123 always respond to that. 
    124  
    125 set bMotionSettings(typos) 7  
    126 A factor affecting how many typos the bot should  
    127 make. 100 will make the bot make typos almost continuously, 0 will stop it.  
    128 (This is used by the output_typos plugin. See the section on Managing bMotion  
    129 for more information about turning plugins on and off.) 
    130  
    131 set bMotionSettings(colloq) 10  
    132 A factor affecting how much the bot will use  
    133 (English) colloquialisms (common expressions). Values are 0 to 100 as above. 
    134  
    135 set bMotionSettings(noPlugin) "simple:huk,complex:wb"  
    136 If you don't want bMotion  
    137 to load a plugin ever, but don't want to delete the file, list them here using  
    138 <type>:<name>. You can list more than one by separating them with commas. See  
    139 the Managing bMotion chapter for more information. 
    140  
    141  
    142  
    143 set bMotionInfo(minRandomDelay) 20  
    144 set bMotionInfo(maxRandomDelay) 120  
    145 These two  
    146 settings control how often the bot does random things (like going "lalala" and  
    147 stuff). The first sets the minimum length of the gap between events, and the  
    148 latter sets the longest delay. bMotion will pick a value between the two. These  
    149 values are both in minutes. 
    150  
    151 set bMotionInfo(maxIdleGap) 45  
    152 This setting stops the bot talking to itself.  
    153 During bMotion's early days, it was common for it to chatter ("lalala") to  
    154 itself overnight even though everyone else in the channel was idle. If there has  
    155 been no activity on a channel for more than this many minutes, bMotion will keep  
    156 quiet (or set itself away until people start talking again). 
    157  
    158 set bMotionInfo(brigDelay) 30  
    159 This is the number of seconds someone should be  
    160 kept in the brig before being tried by the courtmartial plugin. 
    161  
    162 set bMotionSettings(leetRandom) 0.5  
    163 How often the bot should say something in  
    164 1337-speak randomly. Values are 0-100. 
    165  
    166 set bMotionSettings(languages) "en,nl"  
    167 set bMotionInfo(language) "en"  
    168 Choose the  
    169 languages bMotion thinks it can speak. Changing these won't actually make the  
    170 bot speak a different language; they change which plugins it loads. Currently,  
    171 bMotion ships with just English plugins (and about 2 Dutch ones). Don't change  
    172 this unless you know you have other languages available. See the Managing  
    173 bMotion chapter for more information. 
    174  
    175 Save and close settings.tcl 
    176  
    177 Back up to your eggdrop directory and open your bot's config file. Scroll to the  
    178 end section where the source ... statements are to load scripts, and add: 
    179  
    180 source scripts/bmotion/bMotion.tcl 
    181  
    182 (If you put bMotion somewhere else, adjust this.) 
    183  
    184 Save and close the configuration file. 
    185  
    186 Optional bMotion saves some information about users in the userfile, and you may  
    187 want to set/edit these directly (indeed, you'll need to make this change in  
    188 order to take advantage of the feature in bMotion). 
    189  
    190 Change to your scripts directory, and open userinfo.tcl (the filename may be  
    191 slightly different). 
    192  
    193 Find the line that looks like this: set userinfo-fields "URL BF GF IRL EMAIL DOB  
    194 PHONE ICQ" 
    195  
    196 Add "GENDER IRL" to the list. Save the file.  
    197 (End optional section). 
    198  
    199  
    200 Ok. Now for the important bit. Rehash your bot (/msg <botnick> rehash  
    201 <password>, or .rehash on the partyline). If all goes well, you should see  
    202 something like: 
    203  
    204 [21:13] bMotion v 1.19 2002/11/19 19:54:55 james AI online (randoms file: $Id:  
    205 abstracts.tcl,v 1.25 2002/11/18 23:28:58 james Exp $) 
    206  
    207 ...as your bot starts up. 
    208  
    209 If you get an error, refer to the currently non-existent Troubleshooting  
    210 section. (Sorry, until I get feedback on what goes wrong for people I can't  
    211 really write that bit.) 
    212  
    213 If you do require assistance, try me in #bmotion on EFNet. Don't ask for help in  
    214 any of my other channels because I shall taunt you. 
    215  
    216 To check it's working, try typing .bmadmin status on the partyline. 
    217  
    218 You can also do "!bmadmin <botnick> parse hello" in a channel and it should say hello. 
    219  
    220 Drink the coffee. 
Note: See TracChangeset for help on using the changeset viewer.