- Notifications
You must be signed in to change notification settings - Fork0
Automatically exported from code.google.com/p/neutron
License
NotificationsYou must be signed in to change notification settings
badlop/neutron
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Neutron - a Jabber bot in Python -------------------------------- Copyright 2002-2007 Mike Mintzhttp://www.mikemintz.com/http://ejabberd.jabber.ru/neutron Introduction ------------Neutron is a plugin-based Jabber bot written in Python that providesfunctionalities for individuals and chatrooms. To use it, you only needto create an account on a Jabber server, configure Neutron to log intothat account and start it. Neutron will allow users to subscribe to its presence, enter into chatrooms and answer to commands. Install -------1. Get the source code from the SVN repositorysvn checkouthttp://svn.hypothetic.org/neutron/trunk neutron2. Prepare permissions (optional)addgroup jabberadduser neutronadduser neutron jabberchown neutron:jabber neutron-0.5 -Rchmod 750 neutron-0.5 -Rcd neutron3. ConfigureEdit config.txt and put the username, server and password of the Jabberaccount where Neutron must login.4. Execute./neutron.py5. Execute as different user in daemon mode (optional)su neutron -c "./neutron.py &" Directory structure -------------------# Directorieschatlogs Chatroom logs in HTML formatdynamic Files automatically generatedlocalized Localized plugins: copy them to 'plugins/' to enable themmodules Python modules required to run Neutron and pluginsplugins Plugins that extend Neutron functionalitiesprivate Logs of private chatsstatic Files with static data# Filesneutron.py Neutron executableneutron.cfg Main configuration fileneutron.rc Init script with commands to execute on initializationdynamic/chatrooms.cfg List of chatrooms where Neutron will enterdynamic/log.txt Log of all XMPP traffic (does not work) Plugins -------# Botaccess Gives access to admin privilegesadmin Commands to administer Neutron chathelp Shows helplog Logs private chats, chatrooms and debug infopython Evaluates a Python expression, statement or shell command# Jabber relatedpresence Allows contacts to subscribe to its presencesg Asks a server its statisticsuserinfo Gives information on JIDs# Chatroomschatbot Joins a chatroom and speaks to Chatbot (useless)eliza Talks with chat participants (uses Eliza)rss Subscribes a chatroom to a RSS feedvote Polls# Utilitiesdeadline Add multiple deadlines (date and message) and display remaining timequery Create word definitions and stores in file temperature Converts temperatures to and from C and Ftime Gives UTC and Internet time# Reads databasequote Gives a random quote or fortune# Asks Internetbabel Translate between languages [babelfish]dict Shows the DICT definition of a worddns Returns the DNS lookup for a host or IP addressdomain Returns information on specified domaingoogle Performs a Google search. Set your Google key on modules/googlekey.txtstock Returns information on stock [yahoo]weather Shows weather from NOAA# Local plugins Czech:idos Searches IDOS for direct connection between two places in Czech Republickino Returns list of movies in cinemas for given city in Czech Rep.lamer Shows random message fromwww.lamer.cztv Returns TV programme for one of supported channels Other:update Updates Neutron from Internet (does not work) Russian:bashorg Gives random quotes from bash.org / bash.org.ru / linux.org.ru / python.orgtv Returns TV programme for one of supported channelsquiz Quiz in chatroom (requires quizdata.txt) Spanish:saluda It's a modification of quote plugin (requires saludos.txt and saludos2.txt) USA:fact-usa Shows info in Area code and ZIP code (requires areacodes.txt and zipcodes.txt) Start using it --------------Now that Neutron is logged on his account in a Jabber server, you can add itto your roster and start to chat with him. Some example commands: help !commands help !domain !domain jabber.org help !join RSS plugin ----------1. Add a RSS feed to Neutron:!rss_add identifier link!rss_add planetjabhttp://planet.jabber.org/rss10.xml2. Subscribe room to it:!rss_subscribe identifier room!rss_subscribe planetjab group@conference.jabber.no 3. Finally start the RSS fetching loop::!rss_start Feature Requests ----------------# help_plugin- !commands should show only commands that the user has privileges enought to use- Give helpful error on invalid username/password for initial login