
News System v4 for eggdrop *1.3.x*

  by Ernst <baschneo@trick.informatik.uni-stuttgart.de> 16/11/97

  Provides a way of storing and retrieving "news" from channels your
  bot sits in.  News can be added by users (can be limited to certain flags).
  News can expire after a given time or total number of news avaliable.

  Based on a script by Robey.  Development passed through eden
  <brookes@cs.uq.edu.au>, |eXiLe| <exile@perplex.eagle.ovik.se>, FireD
  <goofyguy@genitek.com> and now myself.

Versions:

  v0            Robey
  v0.5          eden    <brookes@cs.uq.edu.au>
                |eXiLe| <exile@perplex.eagle.ovik.se>
  v2   06/12/96 FireD   <goofyguy@genitek.com>
  v3   17/7/97 Ernst    <baschneo@trick.informatik.uni-stuttgart.de>
  v4   16/11/97 Ernst   <baschneo@trick.informatik.uni-stuttgart.de>

Changes in v4:

  This script is now *only* for eggdrop 1.3.x, will *not* work with 1.1 bots.

  Changes to make this possible include:
  - Support for the new flags and flag matching
  - New access method of the XTRA field (with get/setuser)
  - New method on accessing laston information

  Other fixes/changes were also made from v3 to v4:
  - Error saying 'no such element in array' when someone joins a channel which
    has no news configured. Fixed
  - Fixed 'can't read "news":  variable is an array' when trying to read the
    news without being on a channel
  - Fixed method of guessing the best channel if none is specified
  - 'maxnews = 0' now keeps all msgs, instead of deleting them
  - help files in the new 1.3 help format (should be installed automatically
    the first time you run the script).

Installation:

  1) Copy all the included files to your bots scripts directory.
  2) Edit the news4.conf file to your needings
  3) Add the news4.tcl to your bots config (source scripts/news4.tcl)
  4) .rehash or .restart your bot and news will be up and running. Watch
     your log for any errors that might be encountered while reading your
     configuration

  If you did that correctly, the help files will be copied over to your bots
  help directory and you will have '.help news' and '/msg bot help news'
  avaliable.

  All configuration is done in news4.conf! You don't need to edit anything in
  the news4.tcl file, unless you want to!

MSG and DCC news commands avaliable:

  Type '.news help' to get a brief help.  If the help file were installed
  correctly (this should be done automatically the first time you run the
  script), you can access this help with '.help news', '.help news add' etc.

  You don't have to specify the '#channel' in any command, this is optional!
  If you don't specify a channel will make the bot make a reasonable guess of
  which channel you want.

  For dcc commands, prefix "news" with a dot (e.g '.news #channel add bla').
  To use them on IRC via MSG, use '/msg bot' (e.g 'msg bot news #channel add
  bla').

  news #channel add <message...>
    Adds a message to the news file of one channel on the bot.

  news #channel erase <number>
    Erases the message number <number> from the news file.  Only the user who
    put the message there may erase it, except for masters (global or channel
    specific for that channel), who can erase any message.

  news #channel read
  news #channel read <number>
  news #channel read all
    Shows the newsfile of a channel.  If no parameter is given, show only new
    news (if user is known).  If a <number> is given, shows only that item.
    "all" makes bot show all news items stored.

  news #channel check
    Sends a private notice to a user telling them how much news there is.
    This is optionally done automatically when user joins the channel (or
    party-line).

  news default #channel
  news default none
  news default
    If channel is given, changes default news channel for this user.  If there
    is no parameter, shows current setting.  If parameter is "none", erases
    the default channel.

  news #channel reset
    (requires global +m or channel +m in given channel)
    Resets the counter associated with the news system of a channel but does
    not modify the news file itself.  Shouldn't be necessary in an ideal
    world.  :)

  news #channel clear
    (requires global +m or channel +m in given channel)
    Erases all news in a channels news file and resets the counter.

