diff --git a/README.md b/README.md index 1284b6693..eb58769f1 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,9 @@ core modules have been ported. Requirements ------------ -pinkie runs on a Ubuntu 12.04 LTS server and therefore doesn't get tested on other platforms. You will need the latest version of Python 3.2 (which can be installed with `sudo apt-get install python3-all python3-all-dev`). We thankfully no longer require the use of lxml or BeautifulSoup thanks to the JSON APIs of several sites. +pinkie runs on a Ubuntu 12.04 LTS server and therefore doesn't get tested on other platforms*. You will need the latest version of Python 3.2 (which can be installed with `sudo apt-get install python3-all python3-all-dev`). Due to a new feature of lists, it is recommended that Python 3.3 or later be used if you use the new bestpony.py module. It is not required, but highly recommended. We thankfully no longer require the use of lxml or BeautifulSoup thanks to the JSON APIs of several sites. + +* pinkie can run on Windows as long as Python 3.2 or later is installed. It's recommended to use the lastest version of Python to avoid the issues described above. Installation ------------ @@ -23,6 +25,31 @@ Installation Enjoy! +Already using PinkiePyBot and upgrading? +---------------------------------------- + +New changes to some configuration options may mean you need to edit your default.py file to include new options. + +**rule34.py users:** +```python +# works like the channels config option, but defines what channels NSFW +# material can be searched for. See rule34.py for more details +nsfw = ['#nsfw-example','#my-test-channel'] +``` + +**Module developers:** +```python +# set to True to output detailed info about the actual traffic to and from the IRC server +debug = False +``` + +**All users:** +```python +# ignore these users. At the moment, the ignore is exact, but admin.py +# has new commands to change config options at run time +user_ignore = ['anon','abuser'] +``` + Authors ------- * Sean B. Palmer, http://inamidst.com/sbp/ diff --git a/modules/README.md b/modules/README.md index 6841c20c9..3a99b848e 100644 --- a/modules/README.md +++ b/modules/README.md @@ -30,7 +30,7 @@ head.py ======= Another module that has been extended for FiM-specific sites. If it detects a FimFiction.net story link (a link that looks like `http://fimfiction.net/story//`), it skips the normal page title code and reads the info from the story page, gathering the story name, author, likes, dislikes, and, calculated from the likes and dislikes, the overall percentage rating. -Also, some code submitted by Polarfire (Polarfire on irc.canternet.org/#techponies) allows for similar information from Youtube links, whether they be the short youtu.be/ style or the regular youtube.com/watch?v= style (should be able to find the video ID in the other URL decorators). +Also, some code submitted by Polarfire (Polarfire on irc.canternet.org/#techponies) allows for similar information from Youtube links, whether they be the short youtu.be/(vid) style or the regular youtube.com/watch?v=(vid) style (should be able to find the video ID in the other URL decorators). Information gathered includes video title, view count, duration, and uploader. May be extended to include likes, dislikes, and percentage. Code submitted by Kazunekit (Kazune on irc.canternet.org/#fic) allows for greater use of imageboards with some code refactoring and additional titling features. Fixed a bug caused by e621 likely blocking scripts' User-agent strings; the higher-level web.py module was changed to handle HTTPErrors by switching to a different method of openning the URL by faking the User-agent in the header. Regrettable, but just swallowing errors and not having titles for e621 links wasn't a long term solution. @@ -39,12 +39,14 @@ party.py ======== This original module is designed to greet new nicks when they join the channel, and, if they are on the "VIP list", private message an additional, special greeting. (The VIP function is most for an inside joke and can be safely ignored.) -Current bugs: **CRITICAL** Pinkie will issue a greeting for any new _nick_, meaning that if a user changes their nick and Pinkie has not seen it, she will issue a new greeting. To prevent this, it would be most beneficial to get the complete hostmask of the user in question and only issue a new greeting if their hostmask is unique. Additional code for allowing new IP masks (i.e., look at the larger ISP hostname or IP block and not the unique IP) should be required. +~~Current bugs: **CRITICAL** Pinkie will issue a greeting for any new _nick_, meaning that if a user changes their nick and Pinkie has not seen it, she will issue a new greeting. To prevent this, it would be most beneficial to get the complete hostmask of the user in question and only issue a new greeting if their hostmask is unique. Additional code for allowing new IP masks (i.e., look at the larger ISP hostname or IP block and not the unique IP) should be required.~~ Code has been added to the Origin class in irc.py, however, no additional testing to confirm that the bug has been fixed has been performed. admin.py ======== -Code was added in the admin.py module to allow for a server-side ignore on the Canternet network using the /SILENCE command. This code is largely untested and may not function correctly. Additional testing is needed. Current bugs: Unknown. +Code was added in the admin.py module to allow for a server-side ignore on the Canternet network using the /SILENCE command. This code is largely untested and may not function correctly. Additional testing is needed. +Added new code to dynamically change or recall certain configuration options during run time. +Current bugs: Unknown. info.py =======