Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 2.66 KB

README.md

File metadata and controls

44 lines (34 loc) · 2.66 KB
Raw

LizardIRC/NetOpsBot

This project is a network operations bot designed to assist staff tasks on the LizardIRC IRC network, replacing the older NOC-Bot bot written in PHP.

Building NetOpsBot

To build NetOpsBot from source, you'll need the Java SE 8 JDK and Apache Maven (version 3.0.0 or later recommended). You can also use a Maven-compatible IDE, such as IntelliJ IDEA or Eclipse, instead of Maven.

Simply clone the repository, run mvn package, and run the resulting jarfile! The bot will automatically create a default configuration file for you then terminate, so you have a chance to set things up; then just run the bot again!

Contributing

As an open source project, you are welcome to contribute to NetOpsBot's development!

Bug reports/feature requests/other issues

If you would like to file a bug report, request a feature, or report some other issue, please use the Issues section of our GitHub repository.

Code

If you would like to contribute code, there are a couple different ways you could go about doing this.

  • If you are familiar with Gerrit Code Review, you can use LizardNet Code Review to clone the code, and submit patches directly to us that way. Note though that you'll need a LizardWiki account to log in to LizardNet Code Review; this page has more information on that (if you don't have a LizardWiki account, you can easily request one be created for you).
  • Alternatively, just clone the GitHub repository and submit a pull request. Note, though, that the GitHub repository is just a read-only mirror of the LizardNet Code Review repository, so all pull requests will be copied to Gerrit by a Beancounter developer for you before merging into the mainline.

Licensing/Authors/Acknowledgments

LizardIRC/NetOpsBot is licensed under the GNU GPL v3+. For more information, please see the LICENSE.txt file. For authors information, please see the AUTHORS.txt file.

This project contains code from and components derived from the Beancounter general-purpose IRC bot, also developed by LizardIRC. Please see here for more information. Beancounter is also licensed under the GNU GPL v3+.