Skip to content

FurCode/RoboCop2

 
 

Repository files navigation

RoboCop

About

RoboCop is an IRC bot, designed for Python 3, which is based on RoboCop Classic, which in turn is based on Cloudbot (by Luke Rogers and the Cloudbot contributors), that is in turn based on Skybot. That's a big history.

Getting and using RoboCop

=======

Installing RoboCop

To install RoboCop 2 on *Unix, see docs/installing-unix.md

To install RoboCop 2 on Windows, see docs/installing-windows.md

If you're going to be actively developing on RoboCop 2, and submitting PRs back, we recommend running it inside Vagrant. This allows everyone to have an identical development environment.

To install RoboCop 2 in Vagrant (both *Unix and Windows), see docs/installing-vagrant.md

Running RoboCop 2

Before you run the bot, rename config.default to config.json and edit it with your preferred settings. You can check if your JSON is valid using jsonlint.com!

Once you have installed the required dependencies and renamed the config file, you can run the bot! Make sure you are in the correct folder and run the following command:

python3.4 -m cloudbot

Note that you can also run the cloudbot/__main__.py file directly, which will work from any directory.

python3.4 CloudBotRefresh/cloudbot/__main__.py

Specify the path as /path/to/repository/cloudbot/main.py, where cloudbot is inside the repository directory.

Getting help with RoboCop

Documentation

To configure your CloudBot, visit the Config Wiki Page.

To write your own modules, visit the Module Wiki Page.

More at the Wiki Main Page.

Note that the configuration page, and the main wiki page, are still for CloudBot Develop. The Module Wiki Page has been rewritten for refresh, but the other pages are outdated.

Support

The developers reside in #techsupport and would be glad to help you.

If you think you have found a bug/have a idea/suggestion, please open a issue here on Github.

Requirements

CloudBot runs on Python 3.4.x. It is currently developed on Mac OS X 10.10 with Python 2.3.4.

It requires the Python module lXML. The module Enchant is needed for the spellcheck plugin. The module PyDNS is needed for SRV record lookup in the mcping plugin.

Windows users: Windows compatibility some plugins is broken (such as ping), but we do intend to add it. Eventually.

If you think you have found a bug/have a idea/suggestion, please open a issue here on Github and contact us on IRC!

License

RoboCop is licensed under the GPL v3 license. The terms are as follows.

RoboCop

Copyright © 2011-2014 Luke Rogers and CloudBot Contributors
Copyright © 2014 FurCode Team

RoboCop is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

RoboCop is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with RoboCop.  If not, see <http://www.gnu.org/licenses/>.

About

RoboCop 2, the next generation bot based on CloudBot Refresh and Python 3.4

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.8%
  • Shell 0.2%