About The Project

This project is to maintain and enhance the megahal module (megahal.mod) for the current release of the Eggdrop IRC bot.

Read more about MegaHal at Wikipedia.

Read more about Eggdrop at Wikipedia.

(back to top)

Getting Started

Prerequisites

You need to be familiar with building Eggdrop from source. If this is something you have never done, please review and refer to the Eggdrop documentation first.

Installation

Once you have your Eggdrop bot building, you can add in this module pretty easily. Follow the following basic steps to get your module built and installed.

The following commands assume you have your Eggdrop source extracted to ~/eggdrop/ directory. Adjust the paths as required.

1. Clone the repo into the src/mod folder:

cd ~/eggdrop/src/mod
git clone https://github.com/orkim/megahal.mod.git megahal.mod

2. Configure Eggdrop again (config or iconfig Makefile targets) to build the megahal module. This assumes you are building eggdrop in the source tree. If you are using out-of-source build directory you will need to adjust the path to be where you're top Makefile is located.

cd ~/eggdrop
make config

3. Once successfully built, you can copy the module over with make install.

make install

4. The first time you install megahal.mod you probably want to copy over the initial megahal files. This will copy over the scripts/megahal.tcl file, an example eggdrop-megahal.conf to append to your Eggdrop configuration file, and a skeleton megahal.data directory for use by the module.

cp -a ~/eggdrop/src/mod/megahal.com/conf/* /path/to/eggdrop

5. Finally, edit your Eggdrop configuration file for you bot and add the few lines in eggdrop-megahal.conf to the end end.

cat /path/to/eggdrop/eggdrop-megahal.conf >> /path/to/eggdrop/bot.conf

(back to top)

Usage

TBD

• Enable/disable per channel
• Training data

(back to top)

Roadmap

TBD

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPLv2 License. See LICENSE.txt for more information.

(back to top)

Contact

We use this projects github issues (for bugs, feature requests, etc) or github discussions for general announcements/questions/support.

Project Link: https://github.com/orkim/megahal.mod

(back to top)

Acknowledgments

• Eggheads - The Eggdrop IRC Bot
• Jason Hutchens (github) - MegaHal Author
• Jason Hutchens (homepage) - Current Homepage
• Jason Hutchens (homepage) - Homepage Circa 2000
• Jason Hutchens - How MegaHal Works
• Zev "^Baron^" Toledano - megahal.mod v3.5
• z0rc / Nexor - megahal.mod v3.6 and v3.7

(back to top)