Quick Description

From K-Wiki

Fyrewolf's Quick Description

Fyrewolf is capable of keeping on-hand information about characters and other things important to Kaerwyn (Especially when you need the information quickly).

Quick Description Creation Format:

!define <name> <Species> <Gender> <Height> <Weight> <Other Visual Description> <Standard Gear/ Attire> ~ <CSLINK> ~ You can put additional, unnecessary info here.

Please note that the "~" represents a LINE BREAK. That means you can have multiple 'definitions' for a single entry. Keep the important first-look information on the first line. Put the CS link on the second line (To guarantee it doesn't get chopped) You can put additional stuff on the third line.

Quick Description Example:

<Lorelei> !define Lorelei Human Female, 5'7", 140lbs or so, long blonde hair, radioactive green eyes, bad attitude. Typical human. Usually seen wearing Raekartan style clothes, with a knapsack just above her ass. Usually has several weapons on her, not always visible. ~ http://forums.kaerwyn.com/showthread.php?t=1 ~ Lorelei is totally made of win.
<Lorelei> ?? Lorelei
<FyreWolf> Displaying 'lorelei', 3 lines:
<FyreWolf> (1/3) Human Female, 5'7", 140lbs or so, long blonde hair, radioactive green eyes, bad attitude. Typical human. Usually seen wearing Raekartan style clothes, with a knapsack just above her ass. Usually has several weapons on her, not always visible.
<FyreWolf> (2/3) http://forums.kaerwyn.com/showthread.php?t=1
<FyreWolf> (3/3) Lorelei is totally made of win.

Command/User Reference

Usage/limitations: You can only access the commands of this script via public (a channel). You set up which chans the script should work on, and do your stuff from there. It can of course work on multiple channels - but note that sometimes if there is much traffic, the bot may lag some. I.e. if to users in different chans request a topic at the same time; the bot will answer a bit slow - to avoid being flooded from IRC.

To access the different commands, you need different access levels with the eggdrop, or channel status. The requirements are as follows; o Add a topic: voice o Delete a topic you have set: voice o Delete a topic someone else has set: OP o Replace a topic you have set: voice o Replace a topic someone else has set: OP o Search for a user's entries: voice o Showing who sat a topic: voice o Search for topics, the regular way: none o Search for topics, body search: none o Search for topics, special: none o Display a topic: none o Show database stats: none

You can not change these settings in the config, sorry.

The usage of the commands, will now be a explained a little more. The command-char I've used here is !, but you can substitute that with what you want - in the config. Now, lets see how it all works;

o Add a topic: !learn <topic> <body> Alias; !define This will add the topic you specify. There can be NO spaces in the topic, as it only catches the first word as the topic. You can also use a separator in the body, to make the bot type out the reply over several lines. This chr defaults to ~, since it is the first chr I found that is not used in any programming languages (afaik) - since I added this feature to ease the adding of raw code in topics (help chan, remember).

o Delete a topic: !forget <topic> Aliases; !remove, !delete This will delete the topic you specify. No wildcards allowed. Not case- sensitive.

o Replace a topic: !replace <topic> <new body> Alias; !brainwash This will delete the body in the specified topic, and add the new one. Same rules as the !learn command.

o Search for a user's entries: !search-author <nick/handle> No aliases. This command runs the nich/handle through the database, and returns the topics it finds, that were set by that nick/handle. No wildcards allowed!

o Showing who sat a topic: !author <topic> Alias; !whoset, !whosat This shows you who sat the topic you specify. No wildcards allowed.

o Search for topics, regular: !search <string> Aliases; !search-topic, !find This command searches through the list of topics, finding the ones that match your query. Wildcards are supported, and spaces are converted to them.

o Search for topics, body: !search-body <string> No aliases. Search for topics, looking for a string-match in the body. Wildcards are supported, and spaces are converted to them.

o Search for topics, special: !seek <string> No aliases. This command searches through the list of topics, finding the ones that match your query. The difference from the !search is that here the wildcards are optional. Meaning that you chose yourself where you want the wildcards - they are not appended to the front and end of the string, and spaces are not converted. Uses the first word in your sting. Can be useful, if you want to find *something instead of *something* etc.

o Displaying a topic: ?? <topic> Aliases; !display, !show This is the command that prints out the topic you choose. Wildcards not supported. You can also display a topic to a user in the chan, by typing ?? <topic> <nick> It will be displayed as a private msg. There is also a timer, that prevents the same topic from being displayed in the same channel within the number of minutes that you specify. This is to prevent flooding and other kinds of lameness.

o Showing database stats: !db Alias; !db-info This commands shows some information about the database. Number of topics, and file-size of the db (optional)..