Documentation

PLUGINS.md

@@ -0,0 +1,122 @@
+Plugins/command list
+====================
+Core: 
+
+* quit
+* setnick
+* setstatus
+* eval
+* exec
+* option
+* options
+* list
+* access
+
+Simple fun:
+
+* slap
+* gift
+* poke
+* stab
+* hug
+* status
+* roll - roll an RPG dice: !roll d62+3, !rolld76+-3
+* flip
+* say - bot says something
+* act - bot acts something via /me command
+* glomp
+* transform - bot transforms %username% into a random thing
+
+Google:
+
+* google (g)
+* calc
+* translate (tr)
+* image
+
+Ping:
+
+* ping - with queue so users won't eat each others' ping
+
+Alias (aliases are per room):
+
+* alias
+* aliases
+* delalias
+
+Users:
+
+* users
+
+Logger:
+
+* logging
+* PM log
+
+Admin: 
+
+* kick
+* ban
+* devoice
+* voice
+* member
+* delmember
+
+Youtube: identify youtube links (handle youtu.be and parameter &v=)
+
+Knowledge (definitions will also work as `!<definition>`, i.e. `!cake`):
+
+* remember,
+* forget,
+* help,
+* what,
+* show
+
+Ghost:
+
+* ghost (members can kick their own clone)
+
+User limits:
+
+* long nick kick
+* caps kick
+* flood control
+* kick on huge message
+
+Timebomb:
+
+* timebomb
+* cutwire
+* defuse
+
+Quote:
+
+* quote
+* delquote
+* addquote
+
+Seen: 
+
+* seen - writes how long ago the bot has seen someone here
+
+Ignore:
+
+* ignore
+* unignore
+* ignored
+
+Autokick:
+
+* akick
+* delakick
+* akicked
+
+Addmod:
+
+* addmod
+* delmod
+* mods
+
+Cleanup:
+
+* cleanup - sends 20 empty messages to "clean" the room history

README.md

@@ -0,0 +1,40 @@
+Magnet2
+=======
+
+Python XMPP MUC entertainment, informational and administration bot
+
+Copyright (c) 2011-2015 Grom PE
+
+Additional documentation by Oreolek
+
+**License:** GPLv3
+
+Programming language: Python 2
+
+See `PLUGINS.md` for the command list.
+
+Setup
+-----
+- Grab xmpppy library and put in Magnet2 directory
+- Make a copy of the file `magnet_config.py.example` as `magnet_config.py`
+- Change the configuration file `magnet_config.py`
+- Run `magnet2.py`
+
+MUC configuration
+=================
+Currently there is no mechanism to add MUC on-the-fly, so every one is configured manually. The example is this:
+
+    'name@server.address': {
+       'options': [
+         'timebomb',
+         'simple_fun',
+         '...'
+       ],
+       'commands_pm_only': ['image'],
+       'commands_disabled': [],
+     },
+     
+where `options` is a list of allowed commands. This list has to be present in the config, everything else is optional. So if you want to add a command, you enable a plugin and then add this command to `options` list.
+
+Use `commands_pm_only` option for setting per-room PM only commands.
+Use `commands_disabled` option for the command disabling per-room.