Skip to content
Permalink
Browse files

Add additional usage info

  • Loading branch information...
vanosg committed Nov 6, 2019
1 parent f47ad10 commit 099707cbf2a2d26afd8e21b25b22253ac4d492ea
Showing with 56 additions and 3 deletions.
  1. +56 −3 doc/sphinx_source/firstinstall/firstinstall.rst
@@ -184,13 +184,66 @@ Additionally, you can kill the bot via the command line (``kill pid``, the pid i

If you're still unsure what the problem is, try asking in #eggdrop on Freenode, and be sure to include any relevant information from the logfile. Good luck!

First steps- log on to the partyline
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
First steps
-----------

Log on to the partyline
~~~~~~~~~~~~~~~~~~~~~~~
Now that your bot is online, you'll want to join the partyline to further use the bot. First, read what it tells you when you started it up::

STARTING BOT IN USERFILE CREATION MODE.
Telnet to the bot and enter 'NEW' as your nickname.
OR go to IRC and type: /msg BotNick hello
This will make the bot recognize you as the master.

If you choose not to telnet to connect to the partyline, you can either ``/dcc chat BotNick`` or ``/ctcp BotNick chat``. If one of those methods does not work for you, try the other. Once you're on the bot for the first time, type ``.help`` for a short list of available commands, or ``.help all`` for a more thorough list. Common first commands you'll want to review are ``.help +chan`` to tell the bot to join a channel, ``.help +user`` to add a user, ``.help whois`` for a list of flags you can add to that user, and ``.help chattr`` to add those flags to a user.
You can either telnet to the bot, or connect to the bot using DCC Chat. To telnet, you'll either need a program like Putty (Windows), or you can do it from the command line of your shell using the telnet command::

telnet <IP of bot> <listen port>

You can find the IP and port the bot is listening on by a) remembering what you set in the config file ;) or b) reading the display the bot presented when it started up. Look for a line that looks similar to this::

Listening for telnet connections on 2.4.6.9:3183 (all).

This tells you that the bot is listening on IP 2.4.6.9, port 3183. If you see 0.0.0.0 listed, that means Eggdrop is listening on all available IPs on that particular host.


If you choose not to telnet to connect to the partyline, you can either ``/dcc chat BotNick`` or ``/ctcp BotNick chat``. If one of those methods does not work for you, try the other. Once you're on the bot for the first time, type ``.help`` for a short list of available commands, or ``.help all`` for a more thorough list.

Common first steps
~~~~~~~~~~~~~~~~~~

To learn more about any of these commands, type .help <command> on the partyline. It will provide you the syntax you need, as well as a short description of how to use the command.

To tell the Eggdrop to join a channel, use::

.+chan #channel

To register a user with the bot, use::

.+user <handle>

The handle is the name that the bot uses to track a user. No matter what nickname on IRC a user uses, a single handle is used to track the user by their hostmask. To add a hostmask of a user to a handle, use::

.+host <handle> <hostmask>

where the hostmask is in the format of <nick>!<ident>@hostname.com . Wildcards can be used; common formats are \*!\*@hostname.com for static hosts, or \*!ident@*.foo.com for dynamic hostnames.
To assign an access level to a user, first read ``.help whois`` for a listing of possible access levels and their corresponding flags. Then, assign the desired flag to the user with::

.chattr <+flag> <handle>

So to grant a user the voice flag, you would do::

.chattr +v handle

It is important to note that, when on the partyline, you want to use the handle of the user, not their current nickname.

Finally, Eggdrop is often used to moderate and control channels. This is done via the ``.chanset`` command. To learn more about the (numerous!) settings that can be used to control a channel, read::

.help chaninfo

Common uses involve setting channels modes. This can be done with the chanmode channel setting::

.chanset #channel chanmode +snt

which will enforce the s, n, and t flags on a channel.

0 comments on commit 099707c

Please sign in to comment.
You can’t perform that action at this time.