xsBot was forked from CloudBot, which you can find here. I have no plans to change licenses or anything. Although it's my repo, I won't change much. (Expect some major overhauls, but not too much.)
There are currently two different branches of upstream, each with a different level of stability:
UPSTREAM:
- master (stable): This branch contains stable, tested code. This is the branch you should be using if you just want to run your own CloudBot!
- python3.4 (unstable): This branch is where we test and develop new features. If you would like to help develop CloudBot, you can use this branch.
FORK:
- Travis CI for this fork will be added soon.
New releases will be pushed from python3.4 to master whenever we have a stable version to release. This should happen on a fairly regular basis, so you'll never be too far behind the latest improvements.
Firstly, xsBot will only run on Python 3.4 or higher. Because we use the asyncio module, you will not be able to use any other versions of Python.
To install xsBot on *nix (linux, etc), see the upstream wiki.
You should be able to install the bot in the same way it is done upstream. Also, I do recommend running it on *nix.
Conflicting software I have seen (so far): Bitdefender (in my testing. Windows only.)
To install CloudBot on Windows, see the upstream wiki.
Before you run the bot, rename config.default.json to config.json and edit it with your preferred settings. You can check if your JSON is valid using JSONLint!
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
Usually you can run it from the command python3 /path/to/cloudbot/__main__.py.
The CloudBot documentation is currently somewhat outdated and may not be correct. If you need any help, please visit our IRC channel and we will be happy to assist you.
To write your own plugins, visit the Plugins Wiki Page.
More at the Wiki Main Page.
The developers reside in #CloudBot on EsperNet and would be glad to help you.
If you think you have found a bug/have an idea/suggestion, please open an issue here on Github and contact us on IRC!
You can find a number of example bots in #CloudBot.
See CHANGELOG.md
CloudBot is licensed under the GPL v3 license. The terms are as follows.
xsBot
Upstream code: Copyright © 2011-2015 Luke Rogers / CloudBot Project
Fork code: Copyright © 2016 xshotD / xs Devs.
xsBot 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.
xsBot 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 xsBot. If not, see <http://www.gnu.org/licenses/>.
This product includes GeoLite2 data created by MaxMind, available from their website. GeoLite2 databases are distributed under the Creative Commons Attribution-ShareAlike 3.0 Unported License
This product uses data from Wordnik in accordance with the wordnik.com API ToS.