Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@vanosg
vanosg committed Apr 10, 2023
1 parent 6d705dc commit 6685190
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 41 deletions.
2 changes: 1 addition & 1 deletion doc/sphinx_source/modules/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Please note that these are only basic instructions for compiling and installing
2. Place the new module in its own directory (in the format of
(modulename).mod) in src/mod.

3. Run ./configure (from eggdrop1.9.x/).
3. Run ./configure (from eggdrop-|version|/).

4. Type 'make config' or 'make iconfig'.

Expand Down
37 changes: 19 additions & 18 deletions doc/sphinx_source/tutorials/setup.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,17 @@ The super-short version

You can read the `Installation`_ section for a more detailed explanation of these steps.

1. Download the `latest stable Eggdrop release <https://ftp.eggheads.org/pub/eggdrop/source/stable/eggdrop-1.9.5.tar.gz>`_ to your shell via FTP, or simply type ``wget geteggdrop.com -O eggdrop-1.9.5.tar.gz``
2. From the commadline of your shell, type ``tar zxvf eggdrop-1.9.5.tar.gz``
3. Type ``cd eggdrop-1.9.5``
4. Type ``./configure``
5. Type ``make config``
6. Type ``make``
7. Type ``make install``
8. Type ``cd ~/eggdrop``
9. For a quick start, edit the eggdrop-basic.conf file. To take advantage of all Eggdrop's features, we recommend using eggdrop.conf instead. It is also a good idea to rename the file to something easy to remember and specific to your bot, like botnick.conf.
10. Type ./eggdrop -m <config file>
#. Download |dlink| to your shell via FTP, or simply type: wget geteggdrop.com -O eggdrop-|version|.tar.gz
#. Next, from the commandline of the shell, ensure you are in the same directory that you downloaded the tar file into
#. Type: tar zxvf eggdrop-|version|.tar.gz
#. Type: cd eggdrop-|version|
#. Type ``./configure``
#. Type ``make config``
#. Type ``make``
#. Type ``make install``
#. Type ``cd ~/eggdrop``
#. For a quick start, edit the eggdrop-basic.conf file. To take advantage of all Eggdrop's features, we recommend using eggdrop.conf instead. It is also a good idea to rename the file to something easy to remember and specific to your bot, like botnick.conf.
#. Type ./eggdrop -m <config file>

Getting the source
------------------
Expand All @@ -38,7 +39,7 @@ History

The current supported version of Eggdrop is the 1.9.x tree. The 1.8 and 1.6 series, while still popular, are no longer supported by the developers.

The most current version of Eggdrop, and the one appropriate for most users, is the current 1.9 series. It added many features such as SASL support, multi-ip listening, and a new password hashing module. It is the most complete, feature-rich, and functional version of Eggdrop. If you're just starting out with Eggdrop, you should use 1.9.5
The most current version of Eggdrop, and the one appropriate for most users, is the current 1.9 series. It added many features such as SASL support, multi-ip listening, and a new password hashing module. It is the most complete, feature-rich, and functional version of Eggdrop. If you're just starting out with Eggdrop, you should use |version|.

Prior to that, the 1.8 series added several major features, to include IPv6 support and SSL/TLS connections. 1.6.21, which is now over 10 years old, was the last release of the 1.6 series and is still used by users who have become comfortable with that version and may have spent much time applying their own modifications to make it work the way they want, and therefore don't wish to move to a newer version. The majority of Tcl scripts out there were written for 1.6 bots, but those scripts usually work on 1.8 and 1.9 bots as well.

Expand All @@ -47,9 +48,9 @@ The 1.9 Eggdrop tree is currently under active development and the most recent c
Download locations
~~~~~~~~~~~~~~~~~~

The developers distribute Eggdrop via two main methods: FTP, and GitHub. For FTP, it is packaged in tarball format (with the .tar.gz filename extension), with the version number in the filename. The Eggdrop 1.9.5 source, for example, would be named eggdrop-1.9.5.tar.gz.
The developers distribute Eggdrop via two main methods: FTP, and GitHub. For FTP, it is packaged in tarball format (with the .tar.gz filename extension), with the version number in the filename. The Eggdrop |version| source, for example, would be named eggdrop-|version|.tar.gz.

`The Eggheads FTP <https://ftp.eggheads.org/pub/eggdrop/>`_ is a repository for the `current <https://ftp.eggheads.org/pub/eggdrop/source/1.9/eggdrop1.9.5.gz>`_ version of Eggdrop, as well as the most current development snapshot and previous stable releases.
`The Eggheads FTP <https://ftp.eggheads.org/pub/eggdrop/>`_ is a repository for the `current <https://ftp.eggheads.org/pub/eggdrop/source/1.9/eggdrop-|version|.tar.gz>`_ version of Eggdrop, as well as the most current development snapshot and previous stable releases.

Eggdrop also maintains a `GitHub page <https://github.com/eggheads/eggdrop>`_ where you can download the development snapshot or a stable version, via either git commandline or by downloading a tarball. To download via git, type ``git clone https://github.com/eggheads/eggdrop.git``, then ``cd eggdrop``. This gives you the development version. To switch to the most recent stable version, type ``git checkout stable/1.9``. You can then skip to step 4 in the Installation section below.

Expand All @@ -58,13 +59,13 @@ Installation

Installing Eggdrop is a relatively simple process provided your shell has the required tools for successful compilation. On most commercial shell accounts which allow Eggdrop bots you won't have any problems with installation, but on some private boxes or a shell on your ISP you may experience errors during compilation.

Below is a step by step guide to the installation process. These instructions apply to 1.9 bots. It assumes you will be installing eggdrop-1.9.5.tar.gz, so just change the numbers if you are installing another version.
Below is a step by step guide to the installation process. These instructions apply to 1.9 bots. It assumes you will be installing eggdrop-|version|.tar.gz, so just change the numbers if you are installing another version.

1. Put the Eggdrop source on your shell using one of the specified download locations, either by downloading the `eggdrop-1.9.5.tar.gz <https://ftp.eggheads.org/pub/eggdrop/source/1.9/eggdrop-1.9.5.gz>`_ file to your system then uploading it to the shell via FTP, or downloading it directly to the shell via the shell's FTP client, git, wget, or curl. You don't need to put the .tar.gz file in its own directory (it'll be done automatically in the next step).
1. Put the Eggdrop source on your shell using one of the specified download locations, either by downloading the `eggdrop-|version|.tar.gz <https://ftp.eggheads.org/pub/eggdrop/source/1.9/eggdrop-|version|.tar.gz>`_ file to your system then uploading it to the shell via FTP, or downloading it directly to the shell via the shell's FTP client, git, wget, or curl. You don't need to put the .tar.gz file in its own directory (it'll be done automatically in the next step).

2. SSH to the shell (if you haven't already), and type ``tar zxvf eggdrop-1.9.5.tar.gz`` (if this doesn't work, try ``gunzip eggdrop-1.9.5.tar.gz`` then ``tar xvf eggdrop-1.9.5.tar``). This will extract the Eggdrop source into its installation directory, named 'eggdrop-1.9.5'.
2. SSH to the shell (if you haven't already), and type ``tar zxvf eggdrop-|version|.tar.gz`` (if this doesn't work, try ``gunzip eggdrop-|version|.tar.gz`` then ``tar xvf eggdrop-|version|.tar``). This will extract the Eggdrop source into its installation directory, named 'eggdrop-|version|'.

3. Type cd eggdrop-1.9.5 switch to the directory the Eggdrop source was extracted to.
3. Type cd eggdrop-|version| switch to the directory the Eggdrop source was extracted to.

4. Type ``./configure`` (that's a period followed by a slash followed by the word 'configure'). This makes sure the shell has all the right tools for compiling Eggdrop, and helps Eggdrop figure out how to compile on the shell.

Expand All @@ -74,7 +75,7 @@ Below is a step by step guide to the installation process. These instructions ap

7. Type ``make install DEST=~/botdir``. This will install Eggdrop into a directory named 'botdir' in your home directory. You can change 'botdir' to anything you like. Note that in some cases you may need to specify the full path, e.g. ``make install DEST=/home/cooldude/botdir``, using the ~ character in make install won't always work. You can get the full path by typing ``pwd``.

8. You can safely delete the installation directory named 'eggdrop-1.9.5' (to do this, type ``cd ~`` then ``rm -rf eggdrop-1.9.5``) that was created previously, although some people may find it handy to keep that directory for performing additional or future installations of the same version without recompiling.
8. You can safely delete the installation directory named 'eggdrop-|version|' (to do this, type ``cd ~`` then ``rm -rf eggdrop-|version|``) that was created previously, although some people may find it handy to keep that directory for performing additional or future installations of the same version without recompiling.

That's it! Eggdrop is now installed into its own directory on the shell. It's time to edit the configuration files to make Eggdrop work the way you want it to.

Expand Down
44 changes: 22 additions & 22 deletions doc/sphinx_source/using/text-sub.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,28 @@ text:
These variables will be interpreted by Eggdrop and replaced by their
respective values:

+------+---------------------------------------------------------+
| %B | bot's nickname (i.e. "LamestBot") |
+------+---------------------------------------------------------+
| %V | current Eggdrop version (i.e. "eggdrop v1.9.5") |
+------+---------------------------------------------------------+
| %E | long form of %V (i.e. "Eggdrop v1.9.5 (C) 1997 Robey |
| | Pointer (C) 2010 Eggheads Development Team") |
+------+---------------------------------------------------------+
| %C | channels the bot is on (i.e. "#lamest, #botnetcentral") |
+------+---------------------------------------------------------+
| %A | whatever is set in the config file by 'set admin' |
+------+---------------------------------------------------------+
| %n | whatever is set in the config file by 'set network' |
+------+---------------------------------------------------------+
| %T | the current time (i.e. "15:00") |
+------+---------------------------------------------------------+
| %N | the current user's nickname (i.e. "Robey") |
+------+---------------------------------------------------------+
| %U | the current operating system the bot is running on |
+------+---------------------------------------------------------+
| %% | a percent sign ("%") |
+------+---------------------------------------------------------+
+------+----------------------------------------------------------+
| %B | bot's nickname (i.e. "LamestBot") |
+------+----------------------------------------------------------+
| %V | current Eggdrop version (i.e. "eggdrop v\ |version|") |
+------+----------------------------------------------------------+
| %E | long form of %V (i.e. "Eggdrop v\ |version| (C) 1997 |
| | Robey Pointer (C) 2010 Eggheads Development Team") |
+------+----------------------------------------------------------+
| %C | channels the bot is on (i.e. "#lamest, #botnetcentral") |
+------+----------------------------------------------------------+
| %A | whatever is set in the config file by 'set admin' |
+------+----------------------------------------------------------+
| %n | whatever is set in the config file by 'set network' |
+------+----------------------------------------------------------+
| %T | the current time (i.e. "15:00") |
+------+----------------------------------------------------------+
| %N | the current user's nickname (i.e. "Robey") |
+------+----------------------------------------------------------+
| %U | the current operating system the bot is running on |
+------+----------------------------------------------------------+
| %% | a percent sign ("%") |
+------+----------------------------------------------------------+

You can also encode messages which can only be read by people
with certain flags:
Expand Down

0 comments on commit 6685190

Please sign in to comment.